Skip to main content
POST
cURL
Web calls consume credits.
Keep the connection token private. See idempotency before retrying.

Authorizations

Authorization
string
header
required

API key in the format: Bearer YOUR_KARTA_API_KEY.

Headers

X-Request-ID
string

Optional request-tracing identifier.

Body

application/json
agent_id
string
required

Agent code from the agent list.

branch_id
string | null

Specific agent branch; omit to use configured routing.

interaction_mode
enum<string> | null

Defaults to voice unless source is widget and the widget supplies a mode.

Available options:
voice,
chat,
vision,
null
source
enum<string> | null
Available options:
widget,
dashboard,
api,
other,
null
llm_dynamic_variables
object | null

Agent prompt variables for this call.

transit_data
object | null

Application metadata associated with this call.

Response

Successful response.

call_id
string
call_status
string

Current call status.

call_type
string | null
agent_id
string | null
llm_dynamic_variables
object | null

Agent prompt variables for this call.

transit_data
object | null

Application metadata associated with this call.

interaction_mode
enum<string> | null
Available options:
voice,
chat,
vision,
null
source
enum<string> | null
Available options:
widget,
dashboard,
api,
other,
null
token
string | null

Connection credential. Keep private and do not log.

url
string | null

Connection service URL.