Docs
Open dashboard
Developers

API quickstart

Place your first call over the API in three requests.

  1. Create a key

    Create a workspace API key under Configuration → General → API Keys. See API keys.

  2. Find the agent

    List agents and copy the ID of an outbound agent.

    cURL
    curl "$BASE_URL/v1/agents" \
  -H "Authorization: Bearer $API_KEY"

    Reference: List agents.

  3. Place the call

    cURL
    curl -X POST "$BASE_URL/v1/calls" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "agent_id": "<agent id>", "to": "+61412345678" }'

    The request body, including variables, is in Create outbound call.

  4. Read the result

    Fetch the call with Get call once it ends, or receive it on your call-data webhook.

Base URL

$BASE_URL is the address you use for the dashboard. The API lives under /v1 on the same host.