Bot Orchestration

Deploy V2 Script

Changed on

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

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/bot-orchestration/deploy-v2-script
  • Auth
    HTTP basic

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

unknown required

Changes

  • 92703f48a69eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 2ad95b6a84b2Revision changes
    • breaking

      the response's body type changed from object to no type for status