Skip to main content
POST
/
comms
/
call
/
ai
Ai Call
curl --request POST \
  --url https://api.decodahealth.com/comms/call/ai \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "assistantType": "BILLER",
  "reasonForCall": "<string>",
  "patientId": "<string>",
  "eventId": "<string>",
  "provider": "livekit"
}
'
{
  "id": "<string>",
  "chatId": "<string>",
  "direction": "INBOUND",
  "status": "CREATED",
  "sender": {
    "id": "<string>",
    "type": "PROVIDER",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>"
  },
  "receiver": {
    "id": "<string>",
    "type": "PROVIDER",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>"
  },
  "completedDate": "2023-11-07T05:31:56Z",
  "retellCallId": "<string>",
  "disconnectionReason": "<string>",
  "pathToAudio": "<string>",
  "summary": "<string>",
  "context": {},
  "createdDate": "2023-11-07T05:31:56Z",
  "toolCalls": [],
  "tags": [],
  "invoiceId": "<string>",
  "type": "MANUAL",
  "locationId": "<string>"
}

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
receiver
UserTiny · object
completedDate
string<date-time> | null
retellCallId
string | null
disconnectionReason
string | null
pathToAudio
string | null
summary
string | null
context
Context · object
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