KrosAI

Overview

Calls

Simulate inbound call

Initiate outbound call

Terminate call

Get Call Status

Get Transcript

List calls

Get call detail

Soft-delete a call record

List call lifecycle events

Get call recording metadata

Control call recording

Endpoints

List endpoints

Create endpoint

Get endpoint

Update endpoint

Delete endpoint

Partial update endpoint

Test endpoint connectivity

Phone Numbers

List phone numbers

Claim or register a phone number

Browse available phone number inventory

Search available phone number inventory with filters

Get phone number

Partial update phone number

Release or delete phone number

Attach or detach endpoint

Detach endpoint from phone number

Phone number diagnostic check

API Keys

List API keys

Create API key

Update API key

Revoke API key

Rotate API key

API key usage

Per-key usage summary

Create SDK session token

Webhooks

List webhooks

Create webhook

Update webhook

Delete webhook

Send a test event to a webhook

Retry a failed webhook delivery

Webhook delivery history

Health

Platform health snapshot

Health Check

Root

Provider Integrations

List provider integrations

Create or upsert a provider integration

Get a provider integration

Update a provider integration

Delete a provider integration

Test provider integration credentials

New Section

GETTING STARTED

Introduction

Quickstart

Authentication

NUMBERS

Buy Numbers

Countries

INTEGRATION

Vapi

Retell

Elevenlabs

Vogent

Livekit

VOICE

Outbound Calls

Call logs

Recordings

WEBHOOKS

Events

REFERENCE

Rate limits

Error Codes

Documentation

API Reference

Default

KrosAI Documentation

Production

Local development

<p class="slate-p " >The KrosAI Bridge API enables seamless management of AI-driven telephone calls throughout their entire lifecycle, including call routing, recording, transcription, billing, and real-time event synchronization. Users can leverage this API to integrate and control intelligent voice interactions within their applications efficiently.</p><div class="slate-div"><p class="slate-p " ></p></div><div style="text-align:left"><figure ><div style="display:inline-block"><img src="https://d24lr4zqs1tgqh.cloudfront.net/e800674b-2748-4ac4-aa2e-58d2579f4f7a-6a452c43dff10e97ac7d32ec.png" alt="" style="width:901px;height:371px;aspect-ratio:901 / 371" /></div></figure></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Authentication</h2><p class="slate-p " >Two credential forms are accepted:</p><p class="slate-p " ><strong class="slate-bold">kros_ API key</strong>​ (service-to-service):</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language- keep-markup drop-tokens"><div class="slate-code_line">Authorization: Bearer kros_&lt;random&gt;
</div></code></pre></div><p class="slate-p " >The header ​<code class="slate-code">X-API-Key</code>​ is ​<strong class="slate-bold">not</strong>​ accepted.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Base URL</h2><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:542px;">Title</div><div style="width:initial;">Description</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:542px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Environment</p></td><td class="slate-td"><p class="slate-p " >Base URL</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Production</p></td><td class="slate-td"><p class="slate-p " ><code class="slate-code">https://api.krosai.com</code></p></td></tr></tbody></table></div></div><p class="slate-p " >All public endpoints are prefixed ​<code class="slate-code">/api/v1/</code>​.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Rate Limiting</h2><p class="slate-p " ><strong class="slate-bold">600 requests per minute</strong>​ per IP (≈ 10 req/s sustained).  Health, OpenAPI, and docs
routes are exempt.  Responses include a ​<code class="slate-code">Retry-After</code>​ header when the limit is exceeded
(HTTP 429).</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Idempotency</h2><p class="slate-p " >POST / PUT / PATCH endpoints honour the ​<code class="slate-code">Idempotency-Key</code>​ request header.  Duplicate
requests with the same key within the replay window are served from cache without
re-executing the handler.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Response Headers</h2><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div >Title</div><div >Description</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Header</p></td><td class="slate-td"><p class="slate-p " >Description</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><code class="slate-code">x-routed-via: bridge</code></p></td><td class="slate-td"><p class="slate-p " >Confirms the request reached Bridge</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><code class="slate-code">x-request-id</code></p></td><td class="slate-td"><p class="slate-p " >Echoed from caller or fresh UUID v4 — use for distributed tracing</p></td></tr></tbody></table></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Organisation Scoping</h2><p class="slate-p " >All data endpoints require an ​<code class="slate-code">organization_id</code>​ query parameter (UUID).  The Bridge
service key bypasses Supabase RLS, so the explicit org filter is the sole access
control boundary — never omit it.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><div class="slate-div"><h2 class="slate-h2 " >AI Provider Support</h2></div><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div >Title</div><div >Description</div><div >Title</div><div >Description</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Provider</p></td><td class="slate-td"><p class="slate-p " >Outbound</p></td><td class="slate-td"><p class="slate-p " >Inbound</p></td><td class="slate-td"><p class="slate-p " >Notes</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >ElevenLabs</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >SIP + Batch Calling API</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Vapi</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >API-based dispatch</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Retell</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >API-based dispatch</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Vogent</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >SIP URI routing</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >Custom SIP</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >✅</p></td><td class="slate-td"><p class="slate-p " >Any SIP URI</p></td></tr></tbody></table></div></div><p class="slate-p " ></p>

The KrosAI Bridge API enables seamless management of AI-driven telephone calls throughout their entire lifecycle, including call routing, recording, transcription, billing, and real-time event synchronization. Users can leverage this API to integrate and control intelligent voice interactions within their applications efficiently.

Title

Description

 per IP (≈ 10 req/s sustained).  Health, OpenAPI, and docs
routes are exempt.  Responses include a 

 header when the limit is exceeded
(HTTP 429).

 request header.  Duplicate
requests with the same key within the replay window are served from cache without
re-executing the handler.

 query parameter (UUID).  The Bridge
service key bypasses Supabase RLS, so the explicit org filter is the sole access
control boundary — never omit it.

v1.0.2

Sections

GETTING STARTED

On this page

Sections

GETTING STARTED

On this page

Ask an AI

Code with AI