Skip to main content
POST
/
api
/
conversations
/
{conversation_id}
/
start
Start Conversation
curl --request POST \
  --url https://app.all-hands.dev/api/conversations/{conversation_id}/start \
  --header 'Content-Type: application/json' \
  --header 'X-Session-API-Key: <api-key>' \
  --data '{
  "providers_set": [
    "github"
  ]
}'
{
  "status": "<string>",
  "conversation_id": "<string>",
  "message": "<string>",
  "conversation_status": "STARTING"
}

Authorizations

X-Session-API-Key
string
header
required

Path Parameters

conversation_id
string
required

Body

application/json
providers_set
enum<string>[] | null

Response

Successful Response

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