v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-0815390371.2 KB

Bot Orchestration

Deploy V2 Script

Deploy a V2 script bot with optional script configuration. This endpoint creates and starts a Hummingbot instance running the specified script.

Args: deployment: V2ScriptDeployment configuration containing instance name, credentials, optional script name and configuration docker_manager: Docker service dependency db_manager: Database manager dependency

Returns: Dictionary with deployment response including instance details

Raises: HTTPException: 500 if deployment fails

post/bot-orchestration/deploy-v2-script

Request body

instance_namestring required

Unique name for the bot instance

credentials_profilestring required

Name of the credentials profile to use

imagestring

Docker image for the Hummingbot instance

scriptstring nullable

Script name to run (without .py extension)

script_configstring nullable

Script configuration file name (without .yml extension)

headlessboolean

Run in headless mode (no UI)

Response

Successful Response

{"stackTrail":"paths:/bot-orchestration/deploy-v2-script:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}