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 " >Connect your Retell AI agents to KrosAI phone numbers for emerging market coverage.</p><h2 class="slate-h2 " >Overview</h2><p class="slate-p " >Retell AI provides voice agents with natural conversation capabilities. KrosAI enables routing calls from African and Middle Eastern phone numbers to Retell agents.</p><h2 class="slate-h2 " >Prerequisites</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">KrosAI account with verified KYC</div></li><li class="slate-li " ><div style="position:relative">Retell account with an agent created</div></li><li class="slate-li " ><div style="position:relative">At least one KrosAI phone number</div></li></ul><h2 class="slate-h2 " >Setup Steps</h2><p class="slate-p " >&apos; </p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " > Get Your Retell Agent ID</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Log into your <a href="https://dashboard.retellai.com/" target="_blank">Retell Dashboard</a></div></li><li class="slate-li " ><div style="position:relative">Navigate to <strong class="slate-bold">Agents</strong></div></li><li class="slate-li " ><div style="position:relative">Select your agent</div></li><li class="slate-li " ><div style="position:relative">Copy the <strong class="slate-bold">Agent ID</strong></div></li></ul><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Connect Retell in KrosAI</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Go to <strong class="slate-bold">Settings → Integrations</strong> in your KrosAI Dashboard</div></li><li class="slate-li " ><div style="position:relative">Click <strong class="slate-bold">Connect</strong> next to Retell</div></li><li class="slate-li " ><div style="position:relative">Enter your Retell API Key</div></li><li class="slate-li " ><div style="position:relative">Click <strong class="slate-bold">Save &amp; </strong></div></li></ul><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Create a Retell Endpoint</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Bash</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-bash keep-markup drop-tokens"><div class="slate-code_line">curl -X POST &quot;https://api.krosai.com/v1/endpoints&quot; \
  -H &quot;x-api-key: kros_live_your_key&quot; \
  -H &quot;Content-Type: application/json&quot; \
  -d &apos;{
    &quot;name&quot;: &quot;Retell Booking Agent&quot;,
    &quot;type&quot;: &quot;agent&quot;,
    &quot;url&quot;: &quot;sip:agent@retell.ai&quot;,
    &quot;provider_config&quot;: {
      &quot;provider&quot;: &quot;retell&quot;,
      &quot;agent_id&quot;: &quot;your-retell-agent-id&quot;
    }
  }&apos;
</div></code></pre></div><p class="slate-p " ></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Attach to Phone Number</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Bash</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-bash keep-markup drop-tokens"><div class="slate-code_line">curl -X PATCH &quot;https://api.krosai.com/v1/phone-numbers/pn_abc123&quot; \
  -H &quot;x-api-key: kros_live_your_key&quot; \
  -H &quot;Content-Type: application/json&quot; \
  -d &apos;{
    &quot;endpoint_id&quot;: &quot;ep_retell_xyz&quot;
  }&apos;
</div></code></pre></div><h3 class="slate-h3 " ></h3></div></div></div><h1 class="slate-h1 " >Configuration Options</h1><h3 class="slate-h3 " >Provider Config Fields</h3><p class="slate-p " >&apos; </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:312px;">Fiels</div><div style="width:315px;">Required</div><div style="width:initial;">Description</div></div><table class="slate-table" style="min-width:100%;"><colgroup ><col style="width:312px"><col style="width:315px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><code class="slate-code">agent_id</code></p></td><td class="slate-td"><p class="slate-p " >Yes</p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Your Retell agent ID</p></td></tr><tr class="slate-tr " ><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><code class="slate-code">retell_phone_number</code></p></td><td class="slate-td"><p class="slate-p " >No</p></td><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Retell phone number for outbound (optional)</p></td></tr></tbody></table></div></div><h2 class="slate-h2 " >Outbound Calls</h2><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">CURL</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-bash keep-markup drop-tokens"><div class="slate-code_line">curl -X POST &quot;https://api.krosai.com/v1/outbound-calls&quot; \
</div><div class="slate-code_line">  -H &quot;x-api-key: kros_live_your_key&quot; \
</div><div class="slate-code_line">  -H &quot;Content-Type: application/json&quot; \
</div><div class="slate-code_line">  -d &apos;{
</div><div class="slate-code_line">    &quot;from_number&quot;: &quot;+2348012345678&quot;,
</div><div class="slate-code_line">    &quot;to_number&quot;: &quot;+14155551234&quot;,
</div><div class="slate-code_line">    &quot;endpoint_id&quot;: &quot;ep_retell_xyz&quot;,
</div><div class="slate-code_line">    &quot;metadata&quot;: {
</div><div class="slate-code_line">      &quot;appointment_id&quot;: &quot;apt_123&quot;
</div><div class="slate-code_line">    }
</div><div class="slate-code_line">  }&apos;
</div></code></pre></div><h2 class="slate-h2 " >Dynamic Variables</h2><p class="slate-p " >Pass dynamic data to your Retell agent:</p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">CURL</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-bash keep-markup drop-tokens"><div class="slate-code_line">curl -X POST &quot;https://api.krosai.com/v1/outbound-calls&quot; \
</div><div class="slate-code_line">  -H &quot;x-api-key: kros_live_your_key&quot; \
</div><div class="slate-code_line">  -H &quot;Content-Type: application/json&quot; \
</div><div class="slate-code_line">  -d &apos;{
</div><div class="slate-code_line">    &quot;from_number&quot;: &quot;+2348012345678&quot;,
</div><div class="slate-code_line">    &quot;to_number&quot;: &quot;+14155551234&quot;,
</div><div class="slate-code_line">    &quot;endpoint_id&quot;: &quot;ep_retell_xyz&quot;,
</div><div class="slate-code_line">    &quot;metadata&quot;: {
</div><div class="slate-code_line">      &quot;retell_dynamic_variables&quot;: {
</div><div class="slate-code_line">        &quot;customer_name&quot;: &quot;John Smith&quot;,
</div><div class="slate-code_line">        &quot;appointment_time&quot;: &quot;2:00 PM&quot;,
</div><div class="slate-code_line">        &quot;location&quot;: &quot;Lagos Office&quot;
</div><div class="slate-code_line">      }
</div><div class="slate-code_line">    }
</div><div class="slate-code_line">  }&apos;
  
</div></code></pre></div><h2 class="slate-h2 " >Webhooks</h2><p class="slate-p slate-indent-0" style="0px">Receive call events including Retell-specific data:</p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">JSON</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-json keep-markup drop-tokens"><div class="slate-code_line">{
</div><div class="slate-code_line">  &quot;event&quot;: &quot;call.completed&quot;,
</div><div class="slate-code_line">  &quot;call_id&quot;: &quot;call_abc123&quot;,
</div><div class="slate-code_line">  &quot;direction&quot;: &quot;outbound&quot;,
</div><div class="slate-code_line">  &quot;from_number&quot;: &quot;+2348012345678&quot;,
</div><div class="slate-code_line">  &quot;to_number&quot;: &quot;+14155551234&quot;,
</div><div class="slate-code_line">  &quot;duration&quot;: 245,
</div><div class="slate-code_line">  &quot;provider&quot;: &quot;retell&quot;,
</div><div class="slate-code_line">  &quot;agent_id&quot;: &quot;agent_123&quot;,
</div><div class="slate-code_line">  &quot;transcript&quot;: &quot;[Agent]: Hello! I&apos;m calling to confirm your appointment...&quot;,
</div><div class="slate-code_line">  &quot;call_analysis&quot;: {
</div><div class="slate-code_line">    &quot;sentiment&quot;: &quot;positive&quot;,
</div><div class="slate-code_line">    &quot;outcome&quot;: &quot;confirmed&quot;
</div><div class="slate-code_line">  }
</div><div class="slate-code_line">}
</div></code></pre></div><p class="slate-p " >&apos; </p><div class="accordions-widget multi" style="width:100%"><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>Call Not Connecting</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><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Verify your Retell API key is valid</div></li><li class="slate-li " ><div style="position:relative">Check the agent ID exists in Retell</div></li><li class="slate-li " ><div style="position:relative">Ensure your Retell account has sufficient credits</div></li><li class="slate-li " ><div style="position:relative">Review call events in the KrosAI Dashboard</div></li></ul><p class="slate-p " ></p></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>Audio Quality Issues</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><h3 class="slate-h3 " ></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Check network connectivity</div></li><li class="slate-li " ><div style="position:relative">Review Retell&apos;s voice settings</div></li><li class="slate-li " ><div style="position:relative">Verify audio codec compatibility (Opus recommended)</div></li></ul><p class="slate-p " ></p></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>Agent Not Following Script</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><h3 class="slate-h3 " ></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Test the agent directly in Retell</div></li><li class="slate-li " ><div style="position:relative">Check your prompt configuration</div></li><li class="slate-li " ><div style="position:relative">Verify custom LLM settings</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p></div></details></div><p class="slate-p " ></p>

Connect your Retell AI agents to KrosAI phone numbers for emerging market coverage.

Retell AI provides voice agents with natural conversation capabilities. KrosAI enables routing calls from African and Middle Eastern phone numbers to Retell agents.

Sections

INTEGRATION

On this page