Skip to main content
POST
/
bot-orchestration
/
deploy-v2-script
Deploy V2 Script
curl --request POST \
  --url http://localhost:8000/bot-orchestration/deploy-v2-script \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instance_name": "<string>",
  "credentials_profile": "<string>",
  "image": "hummingbot/hummingbot:latest",
  "script": "<string>",
  "script_config": "<string>",
  "headless": false
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Configuration for deploying a bot with a script

instance_name
string
required

Unique name for the bot instance

credentials_profile
string
required

Name of the credentials profile to use

image
string
default:hummingbot/hummingbot:latest

Docker image for the Hummingbot instance

script
string | null

Script name to run (without .py extension)

script_config
string | null

Script configuration file name (without .yml extension)

headless
boolean
default:false

Run in headless mode (no UI)

Response

Successful Response