Skip to main content
POST
/
api
/
v1
/
call
Initiate a new call
curl --request POST \
  --url https://{subdomain}.mindhunters.ai/api/v1/call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agentId": "32d8fc98-be1e-4d32-a12e-146f397fb1cb2",
  "message": {
    "start": "Hello there!This is a test call.How can help you today?"
  },
  "prompt": {
    "overwrite": true,
    "content": "You are Micheal from the support team. You are calling about the issue with the order get order from the customer."
  },
  "participant": {
    "number": "+905435506677",
    "about": "The customer named John Doe.\\n He is a regular customer\\nHis order number is 12345."
  }
}'
{
  "success": true,
  "message": "Call created successfully",
  "data": {
    "id": "some-call-id",
    "agentId": "32d8fc98-be1e-4d32-a12e-146f397fb1cb2",
    "provider": "twilio",
    "status": "initiated"
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
​
agentId
string<uuid>
required

UUID of the Agent. Must exist in the database or the request fails with a 404 error.

Example:

"32d8fc98-be1e-4d32-a12e-146f397fb1cb2"

​
prompt
object
required

Prompt configuration for the call.

​
participant
object
required

Information about the call participant.

​
message
object

Object containing an optional greeting call starts.

Response

Success

​
success
boolean
Example:

true

​
message
string
Example:

"Call created successfully"

​
data
object