Skip to main content
Endpoints is the API reference for an agent’s unique call URL. Send a POST with JSON to start a call from your website, form, or CRM.
Open from AI → AI Agents → agent Actions → Endpoints.

✨ What you can do

  • Copy the agent’s unique POST URL
  • Send outbound or inbound calls with the same URL
  • Pass contact fields (name, email, and more) with the call
  • Copy request examples in PHP, JavaScript, cURL, or Python

📑 What you see on the page

The page has two tabs: Outbound and Inbound. Switching tabs updates the hint, sample body, and response. The URL stays the same.
This URL belongs only to this agent. Do not share it publicly. Always copy it from this page.

📋 Fields you can send

Same body shape on both tabs. Extra contact fields are passed through so the agent can use them on the call.

📤 Outbound

Use Outbound when you want the agent to dial someone. Endpoint Details Outbound tab with POST URL, body fields, PHP example, and 201 response
  1. Open Endpoints and stay on the Outbound tab.
  2. Copy the URL, or copy a request example in your language.
  3. Send a POST with JSON.
Example body
You can leave call_mode out. If it is missing, outbound is used. Success (201)
The person’s phone should ring. There is no dialSip on outbound.

📥 Inbound

Use Inbound when the person already called you (or will be connected by your phone system). Endpoint Details Inbound tab with call_mode inbound and dialSip in the 201 response
  1. Open Endpoints and switch to the Inbound tab.
  2. Copy the URL or the inbound example. The URL is the same — only the body changes.
Example body
call_mode must be inbound. Success (201)
This request does not ring a phone. That is expected.
  • call_id — id of the registered call
  • dialSip — address your phone system uses to connect the live caller to the agent

💻 Request examples

Language tabs on the page: Copy copies the selected language. Replace the sample number and names before you run it. All examples send JSON with Content-Type: application/json.

📨 Response codes


✅ Before you send a request

  • The agent must be Active
  • A phone number must be assigned to the agent
  • Your account must have call balance
  • Use a real phone_number in + (E.164) format
If something fails, the response includes status: error and a short message. Match it to the 403 / 404 / 422 samples on the page.