Skip to main content
POST
/
v1
/
talk
/
create-phone-call
Create an outbound phone call
curl --request POST \
  --url https://assistant-01.in.rapida.ai/v1/talk/create-phone-call \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "assistant": {
    "assistantId": "2227823180112723968",
    "version": "latest"
  },
  "toNumber": "+14155550123"
}
'
{
  "code": 200,
  "success": true,
  "data": {
    "id": "2230142097179373568"
  }
}

Documentation Index

Fetch the complete documentation index at: https://doc.rapida.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Project API key from Rapida credentials.

Headers

​
x-client-source
enum<string>
default:sdk

Client source identifier. SDK clients send this automatically.

Available options:
sdk
​
x-auth-id
string

Optional user identifier to propagate with the request.

Body

application/json
​
assistant
object
required
​
toNumber
string
required

Destination phone number in E.164 format.

Example:

"+14155550123"

​
metadata
object

Arbitrary metadata stored with the conversation for tracking and analytics.

Example:
{ "customerId": "cust_123" }
​
args
object

Runtime arguments made available to the assistant.

Example:
{ "customerName": "Jane" }
​
options
object

Runtime options for call behavior and configuration.

Example:
{ "priority": "standard" }
​
fromNumber
string

Caller ID phone number in E.164 format. If omitted, Rapida uses the configured default.

Example:

"+14155550100"

Response

Outbound phone call request accepted.

​
code
integer<int32>
Example:

200

​
success
boolean
Example:

true

​
data
object
​
error
object