Calls

Overview

The Calls API handles two distinct call modes:

Web calls — real-time audio over WebSocket, initiated from a browser or server
Phone calls — outbound calls to a real phone number via a purchased Indigenius number

After a call ends you can retrieve the full transcript and AI-generated post-call analysis. Required scopes: calls:read (read), calls:write (initiate)

`GET /v1/calls`

Lists all calls for your organization.

curl https://api.indigenius.ai/v1/calls \
  -H "X-API-Key: $INDIGENIUS_API_KEY"

const response = await fetch('https://api.indigenius.ai/v1/calls', {
  headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
});
console.log(await response.json());

import requests, os

response = requests.get(
    "https://api.indigenius.ai/v1/calls",
    headers={"X-API-Key": os.environ["INDIGENIUS_API_KEY"]},
    timeout=30,
)
print(response.json())

200 OK

{
  "success": true,
  "message": "Calls fetched",
  "data": [
    {
      "id": "665e4a34c65bb95f2f2d72e1",
      "type": "web",
      "status": 1,
      "assistantId": "665e4a34c65bb95f2f2d72e2",
      "createdAt": "2026-06-05T14:00:00.000Z"
    }
  ],
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common errors: 403 missing calls:read scope

`POST /v1/calls/initiate`

Creates a web or widget call session. Returns a WebSocket URL that your client connects to for real-time audio — this endpoint only sets up the call record and connection details, it does not place a phone call. For an outbound call to a real phone number, use POST /v1/calls/phone/initiate instead. Request body

Field	Type	Required	Description
`assistantId`	string	yes	Agent to handle the call.
`type`	string (`web` \| `widget`)	yes	Call channel. Passing `phone` here returns a `400` telling you to use `POST /v1/calls/phone/initiate` instead.
`callMode`	string (`inbound` \| `outbound`)	no	Call direction, for your own record-keeping.
`phone`	string	no	Stored on the call record. Not used to look up location for `web`/`widget` calls — location is instead derived from the caller’s IP address.
`conversation_uuid`	string	no	Your own external session/conversation id, stored as-is on the call record.

curl -X POST https://api.indigenius.ai/v1/calls/initiate \
  -H "X-API-Key: $INDIGENIUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"assistantId": "665e4a34c65bb95f2f2d72e2", "type": "web"}'

const response = await fetch('https://api.indigenius.ai/v1/calls/initiate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': process.env.INDIGENIUS_API_KEY,
  },
  body: JSON.stringify({
    assistantId: '665e4a34c65bb95f2f2d72e2',
    type: 'web',
  }),
});
console.log(await response.json());

import requests, os

response = requests.post(
    "https://api.indigenius.ai/v1/calls/initiate",
    headers={
        "X-API-Key": os.environ["INDIGENIUS_API_KEY"],
        "Content-Type": "application/json",
    },
    json={"assistantId": "665e4a34c65bb95f2f2d72e2", "type": "web"},
    timeout=30,
)
print(response.json())

201 Created

{
  "success": true,
  "message": "Call initiated with location data",
  "data": {
    "callId": "665e4a34c65bb95f2f2d72e1",
    "gateway": {
      "transport": "websocket",
      "path": "/new-web-call/connection",
      "url": "wss://api.indigenius.ai/new-web-call/connection?assistant_id=665e4a34c65bb95f2f2d72e2&call_id=665e4a34c65bb95f2f2d72e1"
    }
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Connect your audio client to gateway.url to begin the real-time session. Save callId to retrieve the transcript and analysis after the call ends. Common errors: 400 invalid payload · 403 missing calls:write scope

`POST /v1/calls/phone/initiate`

Initiates an outbound phone call to a real number via your purchased Indigenius phone number, using whichever agent is currently allocated to that number (see POST /v1/phone/allocate-assistant).

phoneNumber must be in the same calling region as the purchased number placing the call — cross-region outbound calls are rejected with a 400. Use a purchased number from the destination’s region instead.

Request body

Field	Type	Required	Description
`phone_purchase_id`	string	yes	The purchased number to call out from.
`phoneNumber`	string (E.164)	yes	Destination number.
`provider`	string	no	Underlying telephony carrier to use. One of `indigenius_telephony_1`, `indigenius_telephony_2`, `indigenius_telephony_3`. Defaults to `indigenius_telephony_1`.

curl -X POST https://api.indigenius.ai/v1/calls/phone/initiate \
  -H "X-API-Key: $INDIGENIUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_purchase_id": "665e4a34c65bb95f2f2d72e1",
    "phoneNumber": "+14155552671",
    "provider": "indigenius_telephony_1"
  }'

const response = await fetch(
  'https://api.indigenius.ai/v1/calls/phone/initiate',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.INDIGENIUS_API_KEY,
    },
    body: JSON.stringify({
      phone_purchase_id: '665e4a34c65bb95f2f2d72e1',
      phoneNumber: '+14155552671',
      provider: 'indigenius_telephony_1',
    }),
  },
);
console.log(await response.json());

import requests, os

response = requests.post(
    "https://api.indigenius.ai/v1/calls/phone/initiate",
    headers={
        "X-API-Key": os.environ["INDIGENIUS_API_KEY"],
        "Content-Type": "application/json",
    },
    json={
        "phone_purchase_id": "665e4a34c65bb95f2f2d72e1",
        "phoneNumber": "+14155552671",
        "provider": "indigenius_telephony_1",
    },
    timeout=30,
)
print(response.json())

Common errors: 400 invalid payload, or phoneNumber not in the same calling region as the purchased number · 403 missing calls:write scope · 404 phone purchase not found

`GET /v1/calls/{id}`

Returns details for a specific call.

curl https://api.indigenius.ai/v1/calls/665e4a34c65bb95f2f2d72e1 \
  -H "X-API-Key: $INDIGENIUS_API_KEY"

const callId = '665e4a34c65bb95f2f2d72e1';
const response = await fetch(`https://api.indigenius.ai/v1/calls/${callId}`, {
  headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
});
console.log(await response.json());

import requests, os

call_id = "665e4a34c65bb95f2f2d72e1"
response = requests.get(
    f"https://api.indigenius.ai/v1/calls/{call_id}",
    headers={"X-API-Key": os.environ["INDIGENIUS_API_KEY"]},
    timeout=30,
)
print(response.json())

200 OK

{
  "success": true,
  "message": "Call details fetched",
  "data": {
    "id": "665e4a34c65bb95f2f2d72e1",
    "type": "web",
    "status": 1,
    "assistantId": "665e4a34c65bb95f2f2d72e2",
    "duration": 142,
    "createdAt": "2026-06-05T14:00:00.000Z",
    "Assistant": {
      "id": "665e4a34c65bb95f2f2d72e2",
      "name": "Sales Agent"
    },
    "CallTranscript": [],
    "CallLog": [],
    "CallRecording": []
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common errors: 403 missing calls:read scope · 404 call not found

`GET /v1/calls/{id}/transcripts`

Returns the full conversation transcript for a call.

curl https://api.indigenius.ai/v1/calls/665e4a34c65bb95f2f2d72e1/transcripts \
  -H "X-API-Key: $INDIGENIUS_API_KEY"

const callId = '665e4a34c65bb95f2f2d72e1';
const response = await fetch(
  `https://api.indigenius.ai/v1/calls/${callId}/transcripts`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests, os

call_id = "665e4a34c65bb95f2f2d72e1"
response = requests.get(
    f"https://api.indigenius.ai/v1/calls/{call_id}/transcripts",
    headers={"X-API-Key": os.environ["INDIGENIUS_API_KEY"]},
    timeout=30,
)
print(response.json())

200 OK

{
  "success": true,
  "message": "Call transcripts fetched",
  "data": [
    {
      "role": "assistant",
      "content": "Hello, how can I help you today?"
    },
    {
      "role": "user",
      "content": "I'd like to track my order."
    }
  ],
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

`GET /v1/calls/{id}/analysis`

Returns AI-generated post-call analysis including summary, sentiment, and tags.

curl https://api.indigenius.ai/v1/calls/665e4a34c65bb95f2f2d72e1/analysis \
  -H "X-API-Key: $INDIGENIUS_API_KEY"

const callId = '665e4a34c65bb95f2f2d72e1';
const response = await fetch(
  `https://api.indigenius.ai/v1/calls/${callId}/analysis`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests, os

call_id = "665e4a34c65bb95f2f2d72e1"
response = requests.get(
    f"https://api.indigenius.ai/v1/calls/{call_id}/analysis",
    headers={"X-API-Key": os.environ["INDIGENIUS_API_KEY"]},
    timeout=30,
)
print(response.json())

200 OK

{
  "success": true,
  "message": "Call analysis fetched",
  "data": {
    "summary": "User called to track an order. Assistant confirmed delivery date.",
    "sentiment": "positive",
    "tags": [
      "order-tracking",
      "resolved"
    ]
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common errors for all read endpoints: 403 missing calls:read scope · 404 call not found

`GET /v1/calls/{id}/recording`

Returns the recording metadata and download URL for a call.

curl https://api.indigenius.ai/v1/calls/665e4a34c65bb95f2f2d72e1/recording \
  -H "X-API-Key: $INDIGENIUS_API_KEY"

const callId = '665e4a34c65bb95f2f2d72e1';
const response = await fetch(
  `https://api.indigenius.ai/v1/calls/${callId}/recording`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests, os

call_id = "665e4a34c65bb95f2f2d72e1"
response = requests.get(
    f"https://api.indigenius.ai/v1/calls/{call_id}/recording",
    headers={"X-API-Key": os.environ["INDIGENIUS_API_KEY"]},
    timeout=30,
)
print(response.json())

200 OK

{
  "success": true,
  "message": "Call recording fetched",
  "data": {
    "id": "665e4a34c65bb95f2f2d72e6",
    "callId": "665e4a34c65bb95f2f2d72e1",
    "recording": "https://api.indigenius.ai/uploads/audio_recordings/665e4a34c65bb95f2f2d72e6.wav"
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common errors: 403 missing calls:read scope · 404 call not found

Getting Started

Core APIs

Platform APIs

Overview

`GET /v1/calls`

`POST /v1/calls/initiate`

`POST /v1/calls/phone/initiate`

`GET /v1/calls/{id}`

`GET /v1/calls/{id}/transcripts`

`GET /v1/calls/{id}/analysis`

`GET /v1/calls/{id}/recording`

​Overview

​GET /v1/calls

​POST /v1/calls/initiate

​POST /v1/calls/phone/initiate

​GET /v1/calls/{id}

​GET /v1/calls/{id}/transcripts

​GET /v1/calls/{id}/analysis

​GET /v1/calls/{id}/recording

Overview

`GET /v1/calls`

`POST /v1/calls/initiate`

`POST /v1/calls/phone/initiate`

`GET /v1/calls/{id}`

`GET /v1/calls/{id}/transcripts`

`GET /v1/calls/{id}/analysis`

`GET /v1/calls/{id}/recording`