Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Path Parameters

agent_id
string
required

The voice agent's id: the id from List or get agents. It is also the last part of that page's address in the app.

Query Parameters

type
enum<string>
default:voice

voice or chat

Available options:
voice,
chat
include
string | null

Comma list of parts; the default is tools for voice and settings for chat

tool_id
string | null

The tool's id: the id from List or read tools and widgets (type tool). Voice: the tool's id from reading include=tools. Needed for tool_invocations

call_id
string | null

The call's id: the id from List or get calls, or the call_id returned by Start a call. Voice: the test call's id, returned when it was started. Needed for test_call

limit
integer
default:50
Required range: 1 <= x <= 200
calendar_id
string | null

Voice: a connected calendar's id. Needed for meeting_types

conversation_id
string | null

Chat: the conversation's id from reading include=conversations. Needed for transcript

start_date
string | null

Chat: first day, YYYY-MM-DD

end_date
string | null

Chat: last day, YYYY-MM-DD

Response

Successful Response

The response is of type Response Agent Context Api V1 Public Agents Agent Id Context Get · object.