New Conversation

Initialize a new session or join an existing one.

After successful initialization, the client should connect to the WebSocket using the returned conversation ID.

POST /api/conversations

New Conversation

cURL

curl --request POST \
  --url https://app.all-hands.dev/api/conversations \
  --header 'Content-Type: application/json' \
  --header 'X-Session-API-Key: <api-key>' \
  --data '
{
  "repository": "<string>",
  "selected_branch": "<string>",
  "initial_user_msg": "<string>",
  "image_urls": [
    "<string>"
  ],
  "replay_json": "<string>",
  "suggested_task": {
    "repo": "<string>",
    "issue_number": 123,
    "title": "<string>"
  },
  "create_microagent": {
    "repo": "<string>",
    "title": "<string>"
  },
  "conversation_instructions": "<string>",
  "mcp_config": {
    "sse_servers": [
      {
        "url": "<string>",
        "api_key": "<string>"
      }
    ],
    "stdio_servers": [
      {
        "name": "<string>",
        "command": "<string>",
        "args": [
          "<string>"
        ],
        "env": {}
      }
    ],
    "shttp_servers": [
      {
        "url": "<string>",
        "api_key": "<string>"
      }
    ]
  },
  "conversation_id": "<string>"
}
'

200

{
  "status": "<string>",
  "conversation_id": "<string>",
  "message": "<string>"
}

Authorizations

X-Session-API-Key · string · header · required

Body

application/json

repository · string | null

git_provider · enum<string> | null

Available options: github, gitlab, bitbucket, enterprise_sso

selected_branch · string | null

initial_user_msg · string | null

image_urls · string[] | null

replay_json · string | null

suggested_task · SuggestedTask · object

Show child attributes

create_microagent · CreateMicroagent · object

Show child attributes

conversation_instructions · string | null

mcp_config · MCPConfig · object

Configuration for MCP (Message Control Protocol) settings.

Attributes: sse_servers: List of MCP SSE server configs stdio_servers: List of MCP stdio server configs. These servers will be added to the MCP Router running inside runtime container. shttp_servers: List of MCP HTTP server configs.

Show child attributes

conversation_id · string

Response

200

application/json

Successful Response

status · string · required

conversation_id · string · required

message · string | null

conversation_status · enum<string> | null

Available options: STARTING, RUNNING, STOPPED