Skip to main content
POST
/
api
/
conversations
New Conversation
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>",
  "git_provider": "github",
  "selected_branch": "<string>",
  "initial_user_msg": "<string>",
  "image_urls": [
    "<string>"
  ],
  "replay_json": "<string>",
  "suggested_task": {
    "git_provider": "github",
    "task_type": "MERGE_CONFLICTS",
    "repo": "<string>",
    "issue_number": 123,
    "title": "<string>"
  },
  "create_microagent": {
    "repo": "<string>",
    "git_provider": "github",
    "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>"
}
'
{
  "status": "<string>",
  "conversation_id": "<string>",
  "message": "<string>",
  "conversation_status": "STARTING"
}

Documentation Index

Fetch the complete documentation index at: https://allhandsai-feat-plugin-via-agent-context-example.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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
​
create_microagent
CreateMicroagent · object
​
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.

​
conversation_id
string

Response

Successful Response

​
status
string
required
​
conversation_id
string
required
​
message
string | null
​
conversation_status
enum<string> | null
Available options:
STARTING,
RUNNING,
STOPPED