create-phone-call

create-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"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    assistant: {assistantId: '2227823180112723968', version: 'latest'},
    toNumber: '+14155550123'
  })
};

fetch('https://assistant-01.in.rapida.ai/v1/talk/create-phone-call', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://assistant-01.in.rapida.ai/v1/talk/create-phone-call"

payload = {
    "assistant": {
        "assistantId": "2227823180112723968",
        "version": "latest"
    },
    "toNumber": "+14155550123"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://assistant-01.in.rapida.ai/v1/talk/create-phone-call"

	payload := strings.NewReader("{\n  \"assistant\": {\n    \"assistantId\": \"2227823180112723968\",\n    \"version\": \"latest\"\n  },\n  \"toNumber\": \"+14155550123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": 200,
  "success": true,
  "data": {
    "id": "2230142097179373568"
  }
}

POST

talk

create-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"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    assistant: {assistantId: '2227823180112723968', version: 'latest'},
    toNumber: '+14155550123'
  })
};

fetch('https://assistant-01.in.rapida.ai/v1/talk/create-phone-call', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://assistant-01.in.rapida.ai/v1/talk/create-phone-call"

payload = {
    "assistant": {
        "assistantId": "2227823180112723968",
        "version": "latest"
    },
    "toNumber": "+14155550123"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://assistant-01.in.rapida.ai/v1/talk/create-phone-call"

	payload := strings.NewReader("{\n  \"assistant\": {\n    \"assistantId\": \"2227823180112723968\",\n    \"version\": \"latest\"\n  },\n  \"toNumber\": \"+14155550123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "code": 200,
  "success": true,
  "data": {
    "id": "2230142097179373568"
  }
}

Authorizations

x-api-key

string

header

required

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

Hide child attributes

assistant.assistantId

string

required

Assistant ID to use for the call.

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

assistant.version

string

Assistant version. Use latest to run the latest published version.

Example:

"latest"

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 overrides for this call. Supported option groups include experience.* for session behavior, listen.* for speech-to-text and voice input, speak.* and speaker.* for text-to-speech and spoken output, model.* for model provider options, and agentkit.* for AgentKit connection settings.

Example:

{
  "experience.greeting": "Hi {{customerName}}, this is Rapida calling about your appointment.",
  "experience.greeting_interruptible": false,
  "listen.language": "en",
  "listen.model": "nova-3",
  "speak.voice.id": "VOICE_ID_PLACEHOLDER",
  "speak.language": "en",
  "model.name": "gpt-4o-mini"
}

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

Hide child attributes

data.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.userId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.name

string

data.projectId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.organizationId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.source

string

data.createdBy

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.updatedBy

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.user

object

Hide child attributes

data.user.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.user.name

string

data.user.email

string<email>

data.user.role

string

data.user.status

string

data.user.createdDate

string<date-time>

data.assistantProviderModelId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantConversationMessage

object[]

Hide child attributes

data.assistantConversationMessage.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantConversationMessage.assistantConversationId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.assistantConversationMessage.role

string

data.assistantConversationMessage.content

string

data.assistantConversationMessage.createdDate

string<date-time>

data.assistantConversationMessage.updatedDate

string<date-time>

data.identifier

string

data.status

string

data.createdDate

string<date-time>

data.updatedDate

string<date-time>

data.contexts

object[]

Hide child attributes

data.contexts.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.contexts.assistantConversationId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.contexts.key

string

data.contexts.value

string

data.contexts.createdDate

string<date-time>

data.contexts.updatedDate

string<date-time>

data.metrics

object[]

Hide child attributes

data.metrics.name

string

data.metrics.value

string

data.metrics.description

string

data.arguments

object[]

Hide child attributes

data.arguments.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.arguments.name

string

data.arguments.value

string

data.metadata

object[]

Hide child attributes

data.metadata.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.metadata.key

string

data.metadata.value

string

data.options

object[]

Hide child attributes

data.options.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.options.key

string

data.options.value

string

data.direction

string

data.recordings

object[]

Hide child attributes

data.recordings.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.recordings.assistantRecordingUrl

string<uri>

data.recordings.userRecordingUrl

string<uri>

data.recordings.conversationRecordingUrl

string<uri>

data.telephonyEvents

object[]

Hide child attributes

data.telephonyEvents.id

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.telephonyEvents.assistantConversationId

string

Pattern: ^[0-9]+$

Example:

"2227823180112723968"

data.telephonyEvents.provider

string

data.telephonyEvents.eventType

string

data.telephonyEvents.payload

object

data.telephonyEvents.createdDate

string<date-time>

data.telephonyEvents.updatedDate

string<date-time>

error

object

Platform error response details. errorCode is a stable platform error code. See PlatformErrorCode for documented code/message mappings.

Hide child attributes

error.errorCode

string

Stable platform error code.

Pattern: ^[0-9]+$

Example:

"1002003"

error.errorMessage

string

Stable client-safe error message.

Example:

"missing toNumber parameter"

error.humanMessage

string

Client-safe human-readable message.

Example:

"Please provide the required toNumber parameter."

get-all-whatsapp-deployment

create-bulk-phone-call

Assistant

Assistant deployments

Calls

Authorizations

Headers

Body

Response