Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A saved agent: what a number answers with, and what POST /calls can
place calls with via agent_id.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/agents" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "system_prompt": "string" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6", "name": "string", "system_prompt": "string", "first_message": "string", "ai_disclosure": true, "ai_disclosure_line": "string", "voice_config": {}, "tools": [ "string" ], "max_duration_seconds": 0, "voice_enabled": true, "sms_enabled": true, "status": "live", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Check Domain
Does this domain already receive mail? Drives apex-vs-prefix onboarding.
Create Call
Place an outbound AI voice call. The call is placed asynchronously — this returns as soon as the call is queued, not when it completes. Poll GET /v1/calls/{call_id} or configure a webhook to get the final status and transcript. Requires recipient_consent=true on the request body; Hail does not verify lawful basis to contact the recipient, the caller warrants it.