Skip to main content
POST
/
assistant
/
calls
Trigger an assistant call
curl --request POST \
  --url https://api.altahq.com/v1/assistant/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistantId": "<string>",
  "name": "<string>",
  "phoneNumber": "<string>",
  "email": "<string>",
  "timezone": "<string>",
  "data": {}
}
'
{
  "error": "ValidationError",
  "message": "Invalid request body"
}
See Error for the error response format.

Authorizations

Authorization
string
header
required

API token authentication. Generate a token from the Alta dashboard and pass it as a Bearer token in the Authorization header.

Body

application/json
assistantId
string
required

The ID of the assistant to use for the call.

name
string
required

The name of the person being called.

phoneNumber
string
required

The phone number to call (E.164 format recommended).

email
string

The email address of the person being called.

timezone
string

The timezone of the person being called (e.g. America/New_York).

data
object

Custom data to pass to the assistant during the call.

callTransfer
object

Call transfer configuration.

Response

Call triggered successfully