For the complete documentation index, see llms.txt. This page is also available as Markdown.

Endpoints

Endpoints define where inbound calls are routed. They can point to AI voice providers (ElevenLabs, Vapi, Retell) or custom webhook URLs.

Base URL: https://api.krosai.com/v1/endpoints

Endpoint Types

Type
Description
Use Case

agent

AI voice provider

ElevenLabs, Vapi, Retell, LiveKit

webhook

HTTP webhook

Custom server handling

List Endpoints

Retrieve all endpoints for your organization.

GET /endpoints

Query Parameters

Parameter
Type
Description

type

string

Filter by type: agent, webhook

status

string

Filter by status: active, inactive

limit

integer

Number of results (default: 50)

offset

integer

Pagination offset

Request

curl -X GET "https://api.krosai.com/v1/endpoints" \
  -H "x-api-key: kros_live_your_key"

Response

Get Endpoint

Retrieve details for a specific endpoint.

GET /endpoints/{id}

Request

Response

Create Endpoint

Create a new endpoint for call routing.

POST /endpoints

Request Body

Field
Type
Required
Description

name

string

Yes

Descriptive name

type

string

Yes

agent or webhook

url

string

Yes

SIP URI or webhook URL

provider_config

object

For agents

Provider-specific configuration

Agent Endpoint (ElevenLabs)

Agent Endpoint (Vapi)

Agent Endpoint (Retell)

Webhook Endpoint

Response

For webhook endpoints, a signing secret is automatically generated. Use this to verify webhook payloads.

Update Endpoint

Update an existing endpoint.

PATCH /endpoints/{id}

Request Body

Field
Type
Description

name

string

New name

url

string

New SIP URI or webhook URL

status

string

active or inactive

provider_config

object

Updated provider configuration

Request

Response

Delete Endpoint

Delete an endpoint. Phone numbers attached to this endpoint will need to be reconfigured.

DELETE /endpoints/{id}

Request

Response

Provider Configuration

ElevenLabs

The agent_id is found in your ElevenLabs Conversational AI dashboard.

Vapi
Retell
LiveKit

Webhook Payload

When using webhook endpoints, KrosAI sends HTTP POST requests with call information:

Verifying Webhook Signatures

Code Examples

Last updated