Skip to main content
POST
Ai Call

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
assistantType
enum<string>
required
Available options:
BILLER,
CALL_REMINDER,
CALL_FOLLOW_UP,
CALL_LAB_TECHNICIAN
reasonForCall
string
required
patientId
string
required
eventId
string | null
provider
enum<string>
default:livekit
Available options:
retell,
livekit

Response

Successful Response

id
string
required
chatId
string
required
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND
status
enum<string>
required
Available options:
CREATED,
ONGOING,
TRANSFERRED,
DISCONNECTED,
FAILED,
FINISHED,
VOICEMAIL
sender
UserTiny · object | null
receiver
UserTiny · object | null
completedDate
string<date-time> | null
retellCallId
string | null
disconnectionReason
string | null
pathToAudio
string | null
summary
string | null
context
Context · object | null
createdDate
string<date-time> | null
toolCalls
ToolCall · object[]
tags
TagSummary · object[]
invoiceId
string | null
type
enum<string>
default:MANUAL
Available options:
MANUAL,
AI
locationId
string | null