ApiSystem

Health check

GET
/health

Returns the current health status of the API and its dependencies. No authentication required.

Response Body

application/json

curl -X GET "https://example.com/health"
{
  "status": "ok",
  "timestamp": "2026-03-27T12:00:00.000Z",
  "version": "1.0.0",
  "checks": {
    "database": {
      "status": "ok",
      "latency_ms": 12
    }
  }
}
Empty

Update organization retention PATCH

Set how long your organization's calls are kept. Content covers the transcript, summary, analysis result and recording; metadata covers the caller's phone number, the campaign link and the call events. Content cannot be kept longer than metadata. Shortening a period destroys data: the nightly cleanup erases everything older than the new period, and that cannot be undone. Both fields are required, because they are validated against each other. Unlimited retention is a contractual exception and is not available through this endpoint. See [Privacy & compliance](/docs/features/privacy-compliance#retention).

Dynamic assistant configuration webhook Webhook

Called **BEFORE** an inbound call is answered, allowing you to: - Dynamically configure the assistant based on caller information - Personalize the greeting message - Override STT/LLM/TTS configuration - Set call-specific analysis plans - Reject calls based on business logic (e.g., outside business hours) - Pass custom metadata that will be echoed in all subsequent webhook events ⚠️ **Important:** Your endpoint must respond within **5 seconds** or the call will proceed with default agent configuration. ### Response Modes **1. Default mode** - Use saved agent config: ```json {} ``` **2. Transient agent** - Full config override: ```json { "assistant": { "first_message": "Hello John!", "tts_config": {"voice_id": "..."}, "metadata": {"crm_id": "12345"} } } ``` **3. Hybrid agent** - Reference saved agent + overrides: ```json { "assistant_id": "uuid-of-saved-agent", "assistant_override": { "tts_config": {"voice_id": "female-voice"}, "first_message": "Hello John!", "metadata": {"crm_id": "12345"} } } ``` The hybrid mode uses **shallow merge**: each top-level key in `assistant_override` completely replaces that config block from the saved agent. ### Custom Metadata Any fields you add to the assistant config (like `metadata`) will be echoed back in all subsequent webhook events (`status-update`, `tool-calls`, `end-of-call-report`). This is useful for passing CRM IDs, campaign info, or any context you need.