Skip to main content
POST
/
api
/
v1
/
agents
/
{agent_id}
/
call
Agent Call Outbound
curl --request POST \
  --url https://api.kollie.ai/api/v1/agents/{agent_id}/call \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "to_phone": "<string>",
  "prompt_params": {},
  "meta": {}
}
'
{
  "message": "Data created correctly",
  "meta": {},
  "data": {
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": "web",
    "status": "init",
    "type": "inbound",
    "phone_number": "<string>",
    "conversation_id": "<string>",
    "transcript": "<string>",
    "duration": 123,
    "cost": 0,
    "notes": "<string>",
    "recording_url": "<string>",
    "events": [
      {}
    ],
    "prompt_params": {},
    "call_extract": {},
    "external_last_status": "<string>",
    "meta": {},
    "system_prompt": "<string>",
    "comments": "<string>",
    "quality": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "tags": [
      {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

agent_id
string<uuid>
required

Body

application/json
to_phone
string
required

Recipient's phone number. (E.164 format)

prompt_params
Prompt Params · object

Key-value parameters to be applied in the prompt. Example: {'name': 'John'}.

meta
Meta · object

Response

Successful Response

message
string | null
default:Data created correctly
meta
Meta · object
data
ICallRead · object