Skip to main content
POST
/
v2
/
call
/
initiate
curl --request POST \ --url https://api.voice-agents.miraiminds.co/v2/call/initiate \ --header 'Content-Type: application/json' \ --header 'workspace: <workspace>' \ --header 'x-private-key: <api-key>' \ --header 'x-public-key: <api-key>' \ --data ' { "phoneNumber": "+919876543210", "assistant": "assistant_123" } '
{
  "callId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.miraiminds.co/llms.txt

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

Authorizations

​
x-public-key
string
header
required
​
x-private-key
string
header
required

Headers

​
x-public-key
string
required
​
x-private-key
string
required
​
workspace
string
required

Body

application/json
​
phoneNumber
string
required

Phone number (E.164 recommended)

Example:

"+919876543210"

​
assistant
string
required

Assistant ID

​
payload
object

Payload structure depends on the assistant variant. Use AbandonedCartPayload for abandoned_cart assistants, CustomPayload for custom assistants.

​
callbackUrl
string<uri>

HTTPS webhook URL

​
priority
boolean

Call priority level

Example:

true

​
metadata
object

Response

Call queued

​
status
enum<string>

Current call status

Available options:
initiate,
in-progress,
ended,
completed,
timeout,
failed,
validation-failed,
busy,
no-answer,
skip,
rescheduled,
aborted
​
callId
string