Skip to main content
POST
/
call
Initiate a phone call
curl --request POST \
  --url https://api.osvi.ai/call \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_uuid": "agent_IsxxxxSf_60EhxxxxMGbz-Rxxg",
  "phone_number": "9876543210",
  "country_code": "IN",
  "system_prompt": "You are calling to confirm the appointment scheduled for tomorrow at 10 AM.",
  "webhook_url": "https://yourdomain.com/osvi-webhook",
  "person_name": "John Doe",
  "additional_data": {
    "appointment_date": "2025-01-15",
    "product_name": "Premium Plan"
  }
}
'
{
  "success": true,
  "data": {
    "call_id": "call_abc123xyz"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.osvi.ai/llms.txt

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

Authorizations

​
API-Token
string
header
required

16-character API token associated with your OSVI account. Find it in your dashboard under Settings → API.

Body

application/json
​
agent_uuid
string
required

Unique identifier of the OSVI agent that will handle the call.

Example:

"agent_IsxxxxSf_60EhxxxxMGbz-Rxxg"

​
phone_number
string
required

Destination phone number (digits only, without country code).

Example:

"9876543210"

​
country_code
string
required

ISO 3166-1 alpha-2 country code of the destination number.

Example:

"IN"

​
system_prompt
string

Optional runtime override for the agent's system prompt for this call only.

Example:

"You are calling to confirm the appointment scheduled for tomorrow at 10 AM."

​
webhook_url
string

URL that OSVI will POST to when the call completes. The payload matches the webhook schema documented in the Webhooks section.

Example:

"https://yourdomain.com/osvi-webhook"

​
person_name
string

Name of the person being called. Made available to the agent during the call.

Example:

"John Doe"

​
additional_data
object

Arbitrary key-value data passed to the agent at runtime. Use this to provide context the agent can reference during the conversation.

Example:
{
  "appointment_date": "2025-01-15",
  "product_name": "Premium Plan"
}

Response

Call initiated successfully

​
success
boolean
Example:

true

​
data
object