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"
}
Initialize a new session or join an existing one.
After successful initialization, the client should connect to the WebSocket using the returned conversation ID.
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"
}
Successful Response
The response is of type object
.
Was this page helpful?