Skip to main content
POST
/
conversations
Create conversation (initiate call)
curl --request POST \
  --url https://api.getarbol.com/v1/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "agentId": "<string>",
  "contactId": "<string>",
  "systemPromptOverride": "<string>",
  "greetingOverride": "<string>",
  "language": "<string>",
  "variables": {},
  "metadata": {}
}
'
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "requestId": "<string>"
}

Authorizations

Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Body

application/json
phone
string
required

E.164 format

agentId
string
contactId
string
systemPromptOverride
string
greetingOverride
string
language
string
variables
object
metadata
object

Response

Created conversation