KrosAI

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

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

Health

Health Check

New Section

INTEGRATION

REFERENCE

COMMUNITY

Discord

GETTING STARTED

Introduction

Quickstart

Authentication

NUMBERS

Buy Numbers

Countries

Vapi

Retell

Elevenlabs

Vogent

Livekit

VOICE

Outbound Calls

Call logs

Recordings

WEBHOOKS

Events

Rate limits

Error Codes

Documentation

API Reference

Default

KrosAI Documentation

Production

Local development

<p class="slate-p " >Simulate inbound calls to test and validate call handling within your organization’s telephony setup. This functionality enables authenticated users to generate realistic call scenarios, with organization context automatically applied for customer callers or explicitly specified for internal users, facilitating robust integration and workflow testing.</p><p class="slate-p " ></p>

Simulate inbound calls to test and validate call handling within your organization’s telephony setup. This functionality enables authenticated users to generate realistic call scenarios, with organization context automatically applied for customer callers or explicitly specified for internal users, facilitating robust integration and workflow testing.

Unique identifier for the call session; if omitted, a UUID is auto-generated for tracking purposes

call_uuid

Destination phone number in E.164 format representing the called DID

to_number

Caller ID phone number in E.164 format used to simulate the inbound caller

from_number

UUID of the specific endpoint involved in the simulated inbound call

endpoint_id

UUID of the organization initiating the call; inferred from the authenticated user's token for customer callers

organization_id

Bearer token used to authenticate the API request; required unless api_key is provided

Authorization

API key used as an alternative authentication method to Bearer tokens, primarily for FreeSWITCH mod_curl integration

api_key

Current status of the simulated call request, such as success or failure indicators

status

Unique identifier for the call bridge connecting participants during the simulation

bridge_uuid

SIP call identifier associated with the inbound call session for traceability

sip_call_id

Detailed message or description elaborating on the simulation response or error information

message

Detailed information or metadata related to the call simulation response

detail

<h3 class="slate-h3 " >Join our Discord Community</h3><p class="slate-p " >Connect directly with the KrosAI team and fellow developers. Our Discord server is the primary place to:</p><p class="slate-p " ><strong class="slate-bold">🛠 Get Support:</strong> Ask technical questions and get help troubleshooting issues.</p><p class="slate-p " ><strong class="slate-bold">💡 Share Feedback:</strong> Suggest new features, report bugs, and shape the KrosAI roadmap.</p><p class="slate-p " ><strong class="slate-bold">📢 Stay Updated:</strong> Get early access to release notes, announcements, and API updates.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Note: Please review our community guidelines in the #welcome channel once you join.</p></div></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " >👉 <a href="https://discord.com/invite/tmdE4WGaDw" target="_blank"><strong class="slate-bold">Click here to join the KrosAI Discord Server</strong></a></p></div></div><p class="slate-p " ></p>

Connect directly with the KrosAI team and fellow developers. Our Discord server is the primary place to:

 Ask technical questions and get help troubleshooting issues.

 Suggest new features, report bugs, and shape the KrosAI roadmap.

 Get early access to release notes, announcements, and API updates.

Note: Please review our community guidelines in the #welcome channel once you join.

v1.0.2

Sections

Discord

Join our Discord Community

On this page