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

🔗Endpoints

☎Call logs

📹Recordings

WEBHOOKS

▦Overview

🌀Events

REFERENCE

⏳Rate limits

⚠️Error Codes

Documentation

API Reference

Default

KrosAI Documentation

Production

Local development

<p class="slate-p " ></p><h2 class="slate-h2 " > HTTP Status Codes</h2><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:initial;">Code</div><div style="width:478px;">Meaning</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:initial"><col style="width:478px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">200</p></td><td class="slate-td"><p class="slate-p " >Success</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">201</p></td><td class="slate-td"><p class="slate-p " >Created</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >400</p></td><td class="slate-td"><p class="slate-p " >Bad Request</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >401</p></td><td class="slate-td"><p class="slate-p " >Unauthorized</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >403</p></td><td class="slate-td"><p class="slate-p " >Forbidden</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >404</p></td><td class="slate-td"><p class="slate-p " >Not Found</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >429</p></td><td class="slate-td"><p class="slate-p " >Rate Limited</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " ><span class="slate-color" style="color:#000000">500</span></p></td><td class="slate-td"><p class="slate-p " >Server Error</p></td></tr></tbody></table></div></div><p class="slate-p " ></p><div class="accordions-widget multi" style="width:100%"><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>Authentication</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;"><div >Code</div><div >solution</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 " >INVALID_API_KEY</p></td><td class="slate-td"><p class="slate-p " >Check API Key</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >MISSING_API_KEY</p></td><td class="slate-td"><p class="slate-p " >Add x-api-key header</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >INSUFFICIENT_SCOPE</p></td><td class="slate-td"><p class="slate-p " >Create key with proper scopes</p></td></tr></tbody></table></div></div><p class="slate-p " ></p></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>Phone Numbers</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;"><div >Code</div><div >Solution</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 " >KYC_REQUIRED</p></td><td class="slate-td"><p class="slate-p " >Complete verification</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >INSUFFICENT_BALANCE</p></td><td class="slate-td"><p class="slate-p " >Add credits</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >NUMBER_NOT_AVAILABLE</p></td><td class="slate-td"><p class="slate-p " >Choose different number</p></td></tr></tbody></table></div></div><p class="slate-p " ></p></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>Calls</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " ></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><div class="published-table-header" style="width:100%;min-width:100%;"><div >Code</div><div >Solution</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 " >INVALID_PHONE_NUMBERS</p></td><td class="slate-td"><p class="slate-p " >Use E.164 format</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >N0_ENDPOINT</p></td><td class="slate-td"><p class="slate-p " >Attach endpoint to number</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p " >ENDPOINT_UNREACHABLE</p></td><td class="slate-td"><p class="slate-p " >Check endpoint config</p></td></tr></tbody></table></div></div><p class="slate-p " ></p></div></details></div><p class="slate-p " ></p>

Code

Meaning

v1.0.2

Sections

⚠️Error Codes

HTTP Status Codes

Authentication

Phone Numbers

Calls

On this page

200	Success
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
429	Rate Limited
500	Server Error

INVALID_API_KEY	Check API Key
MISSING_API_KEY	Add x-api-key header
INSUFFICIENT_SCOPE	Create key with proper scopes

KYC_REQUIRED	Complete verification
INSUFFICENT_BALANCE	Add credits
NUMBER_NOT_AVAILABLE	Choose different number

INVALID_PHONE_NUMBERS	Use E.164 format
N0_ENDPOINT	Attach endpoint to number
ENDPOINT_UNREACHABLE	Check endpoint config

Sections

⚠️Error Codes

HTTP Status Codes

Authentication

Phone Numbers

Calls

On this page

Ask an AI

Code with AI