Skip to main content
POST
Try Agent

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Path Parameters

agent_id
string
required
Required string length: 24

Body

application/json
phone_number
string<phone>
required
from_number
string<phone> | null

Optional account-owned phone number to use as the caller ID for the test call.

campaign_id
string | null

If provided, test call will include campaign settings. Agent will process pre-call and post-call tasks, AMD detection, and dispositioning.

snapshot_id
string | null

If provided, test call will use this specific agent snapshot instead of the current agent configuration.

Response

Successful Response