> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendora.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Public API coverage matrix

> Generated inventory of every Sendora v1 public API operation and its documentation contract.

This generated matrix covers **159 public operations**. The OpenAPI reference remains the source of truth for schemas and examples; this page is the review checklist for workflow, ownership, authentication, side effects, and error coverage.

> This file is generated. Run `scripts/sync-public-api-docs.sh` after the live OpenAPI contract changes.

| Method | Path | Audience | Auth | Async | Responses | Request | Side effects |
| - | - | - | - | - | - | - | - |
| GET | `/api/v1/public/analytics/campaigns` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/analytics/campaigns/{campaign_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/analytics/overview` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/campaign-folders` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/campaigns` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/campaigns` | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `CampaignCreate` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/campaigns/{campaign_id}` | customer | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/campaigns/{campaign_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PATCH | `/api/v1/public/campaigns/{campaign_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `CampaignWorkflowUpdate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/campaigns/{campaign_id}/clone` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/campaigns/{campaign_id}/launch` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/campaigns/{campaign_id}/leads` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/campaigns/{campaign_id}/leads` | customer | X-API-Key | Yes | 202, 401, 402, 403, 404, 409, 410, 422, 500, 503 | schema: `_EnrollBody` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/campaigns/{campaign_id}/leads/{lead_id}` | customer | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/campaigns/{campaign_id}/pause` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/campaigns/{campaign_id}/preflight` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/campaigns/{campaign_id}/resume` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/campaigns/{campaign_id}/stop` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| PATCH | `/api/v1/public/campaigns/{campaign_id}/workflow` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `CampaignWorkflowUpdate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/connected-accounts` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/conversations` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/conversations/{lead_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/conversations/{lead_id}/messages` | customer | X-API-Key | No | 200, 400, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `SendMessageBody` | May change workspace data or trigger an external side effect |
| PATCH | `/api/v1/public/conversations/{lead_id}/traffic-light` | customer | X-API-Key | No | 204, 400, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `TrafficLightBody` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/copilot/messages/stream` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: `StreamMessageRequest` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/copilot/runs/{run_id}/approve` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `CopilotActionDecision` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/copilot/runs/{run_id}/reject` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `CopilotActionDecision` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/copilot/sessions/{thread_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/dnc` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/dnc` | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `DncEntryCreate` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/dnc/{entry_id}` | customer | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/jobs` | customer | X-API-Key | Yes | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/jobs/{job_id}` | customer | X-API-Key | Yes | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/knowledge-bases` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/knowledge-bases` | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `api__v1__knowledge_base__schemas__KBCreate` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/knowledge-bases/{kb_id}` | customer | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/knowledge-bases/{kb_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PATCH | `/api/v1/public/knowledge-bases/{kb_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `api__v1__knowledge_base__schemas__KBUpdate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/knowledge-bases/{kb_id}/sources` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/knowledge-bases/{kb_id}/sources/text` | customer | X-API-Key | No | 201, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `TextSourceCreate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/knowledge-bases/{kb_id}/sources/url` | customer | X-API-Key | No | 201, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `URLSourceCreate` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/knowledge-bases/{kb_id}/sources/{source_id}` | customer | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/knowledge-bases/{kb_id}/sources/{source_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PATCH | `/api/v1/public/knowledge-bases/{kb_id}/sources/{source_id}` | customer | X-API-Key | Yes | 202, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `SourceEditRequest` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/knowledge-bases/{kb_id}/sources/{source_id}/accept-provider-update` | customer | X-API-Key | Yes | 202, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `SourceEditRequest` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/knowledge-bases/{kb_id}/sources/{source_id}/restore-snapshot` | customer | X-API-Key | Yes | 202, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `SourceEditRequest` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/lead-lists` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/lead-lists` | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `LeadListCreate` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/lead-lists/{list_id}` | customer | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/lead-lists/{list_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PATCH | `/api/v1/public/lead-lists/{list_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `LeadListUpdate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/lead-lists/{list_id}/enrich` | customer | X-API-Key | Yes | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | schema: `PublicBulkEnrichBody` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/lead-lists/{list_id}/google-maps/preview` | customer | X-API-Key | Yes | 201, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `api__v1__leads__routes__google_maps_preview__PreviewCreate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/lead-lists/{list_id}/google-maps/preview/{preview_id}` | customer | X-API-Key | Yes | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/lead-lists/{list_id}/google-maps/preview/{preview_id}/commit` | customer | X-API-Key | Yes | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `api__v1__leads__routes__google_maps_preview__CommitBody` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/lead-lists/{list_id}/leads` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/lead-lists/{list_id}/leads` | customer | X-API-Key | No | 201, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `LeadCreate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/lead-lists/{list_id}/prospect-search/employee-preview` | customer | X-API-Key | No | 201, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `EmployeeFinderPreviewCreate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/lead-lists/{list_id}/prospect-search/parse-criteria` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `ParseIcpBody` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/lead-lists/{list_id}/prospect-search/preview` | customer | X-API-Key | Yes | 201, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `api__v1__leads__routes__prospect_search_preview__PreviewCreate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/lead-lists/{list_id}/prospect-search/preview/{preview_id}` | customer | X-API-Key | Yes | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/lead-lists/{list_id}/prospect-search/preview/{preview_id}/commit` | customer | X-API-Key | Yes | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `api__v1__leads__routes__prospect_search_preview__CommitBody` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/lead-lists/{list_id}/source-runs` | customer | X-API-Key | No | 201, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `SourceRunCreate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/lead-lists/{list_id}/source-runs/{source_run_id}/start` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/leads` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/leads/imports` | customer | X-API-Key | Yes | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `CreateImportRequest` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/leads/{lead_id}` | customer | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/leads/{lead_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PATCH | `/api/v1/public/leads/{lead_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `LeadUpdate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/leads/{lead_id}/activities` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/leads/{lead_id}/enrich` | customer | X-API-Key | Yes | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | schema: `PublicEnrichBody` | May change workspace data or trigger an external side effect |
| PATCH | `/api/v1/public/leads/{lead_id}/pipeline-stage` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `Body_public_update_pipeline_stage_api_v1_public_leads__lead_id__pipeline_stage_patch` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/leads/{lead_id}/tags` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/leads/{lead_id}/tags` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `api__v1__public__leads__TagsBody` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/leads/{lead_id}/tags/{tag}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/leads/{lead_id}/web-research` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/phone-numbers` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/phone-numbers/import/confirm` | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `PublicPhoneProviderImportIn` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/phone-numbers/import/outbound-profile` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: `PhoneProviderProfileCreateIn` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/phone-numbers/import/search` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: `PublicPhoneProviderSearchIn` | May change workspace data or trigger an external side effect |
| PUT | `/api/v1/public/phone-numbers/{number_id}/inbound-agent` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `PublicInboundAgentAssignmentIn` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/phone-numbers/{number_id}/outbound-profile` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `PhoneProviderSavedProfileCreateIn` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/phone-numbers/{number_id}/outbound-setup` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PUT | `/api/v1/public/phone-numbers/{number_id}/outbound-setup` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `PhoneProviderOutboundSetupIn` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/tools` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/tools` | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `ToolCreate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/tools/catalog` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 502, 503 | None | None stated; read operation |
| DELETE | `/api/v1/public/tools/{tool_id}` | customer | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 502, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/tools/{tool_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | None | None stated; read operation |
| PATCH | `/api/v1/public/tools/{tool_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | schema: `ToolUpdate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/tools/{tool_id}/assignments` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | schema: `AssignBody` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/tools/{tool_id}/assignments/{agent_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/tools/{tool_id}/test` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/voice-agents` | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `AgentCreate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice/calls` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/voice/calls` | customer | X-API-Key | Yes | 202, 401, 402, 403, 410, 422, 500, 503 | schema: `InitiateCallBody` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice/calls/{call_id}` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/voices` | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 502, 503 | None | None stated; read operation |
| GET | `/api/v1/public/voices/{voice_id}/preview` | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 429, 500, 502, 503 | None | None stated; read operation |
| GET | `/api/v1/public/webhook-endpoints` | customer | X-API-Key | No | 200, 400, 401, 402, 403, 404, 410, 422, 429, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/webhook-endpoints` | customer | X-API-Key | No | 201, 400, 401, 402, 403, 404, 410, 422, 429, 500, 503 | schema: `api__v1__public__webhooks__WebhookEndpointCreate` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/webhook-endpoints/{endpoint_id}` | customer | X-API-Key | No | 204, 400, 401, 402, 403, 404, 410, 422, 429, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/webhook-endpoints/{endpoint_id}` | customer | X-API-Key | No | 200, 400, 401, 402, 403, 404, 410, 422, 429, 500, 503 | None | None stated; read operation |
| PATCH | `/api/v1/public/webhook-endpoints/{endpoint_id}` | customer | X-API-Key | No | 200, 400, 401, 402, 403, 404, 410, 422, 429, 500, 503 | schema: `WebhookEndpointUpdate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/webhook-endpoints/{endpoint_id}/deliveries` | customer | X-API-Key | No | 200, 400, 401, 402, 403, 404, 410, 422, 429, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/webhook-endpoints/{endpoint_id}/rotate-secret` | customer | X-API-Key | No | 200, 400, 401, 402, 403, 404, 410, 422, 429, 500, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/webhook-endpoints/{endpoint_id}/test` | customer | X-API-Key | No | 200, 400, 401, 402, 403, 404, 410, 422, 429, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/partner/billing/plans` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/partner/billing/plans` | agency | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `api__v1__partner__schemas__AgencyPlanCreate` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/partner/billing/plans/{plan_id}` | agency | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| PATCH | `/api/v1/public/partner/billing/plans/{plan_id}` | agency | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `api__v1__partner__schemas__AgencyPlanUpdate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/partner/clients` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/partner/clients` | agency | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: `SubAccountCreate` | May change workspace data or trigger an external side effect |
| PUT | `/api/v1/public/partner/clients/{client_id}/branding` | agency | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `BrandingUpdate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/partner/clients/{client_id}/features` | agency | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PUT | `/api/v1/public/partner/clients/{client_id}/features` | agency | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `FeatureFlagsUpdate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/partner/experience/draft` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| PUT | `/api/v1/public/partner/experience/draft` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: `ExperienceDraft` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/partner/experience/publish` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/partner/experience/versions` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/partner/experience/versions/{version_id}/rollback` | agency | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/partner/launch-config` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/partner/overview` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/partner/signup-config` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| PUT | `/api/v1/public/partner/signup-config` | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: `SignupOnboardingConfigUpdate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/widget/{widget_public_id}/calls` | anonymous-widget | None (public widget runtime) | No | 201, 402, 403, 404, 422, 429, 500, 503 | schema: `PreCallFormPayload` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/widget/{widget_public_id}/config` | anonymous-widget | None (public widget runtime) | No | 200, 402, 403, 404, 422, 429, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/voice-agents/drafts` | advanced-voice | X-API-Key | No | 201, 401, 402, 403, 404, 409, 410, 422, 500, 503 | schema: `AgentCreate` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/voice-agents/{agent_id}` | advanced-voice | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents/{agent_id}` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PATCH | `/api/v1/public/voice-agents/{agent_id}` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `AgentUpdate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/voice-agents/{agent_id}/avatar` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 429, 500, 502, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents/{agent_id}/channels/{channel}` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/voice-agents/{agent_id}/channels/{channel}` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | schema: `SaveChannelAssignmentsIn` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents/{agent_id}/configuration` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| GET | `/api/v1/public/voice-agents/{agent_id}/inbound/config` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PUT | `/api/v1/public/voice-agents/{agent_id}/inbound/config` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `InboundConfigUpdate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents/{agent_id}/knowledge-bases` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/voice-agents/{agent_id}/knowledge-bases` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | schema: `AgentKBAssign` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/voice-agents/{agent_id}/knowledge-bases/{kb_id}` | advanced-voice | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/voice-agents/{agent_id}/phone-test-call` | advanced-voice | X-API-Key | No | 201, 401, 402, 403, 404, 409, 410, 422, 500, 503 | schema: `PhoneTestCallRequest` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/voice-agents/{agent_id}/publish` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | schema: `PublishVoiceAgentRequest` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/voice-agents/{agent_id}/test-call` | advanced-voice | X-API-Key | Yes | 201, 401, 402, 403, 404, 409, 410, 422, 429, 500, 502, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents/{agent_id}/tools` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/voice-agents/{agent_id}/tools` | advanced-voice | X-API-Key | No | 201, 401, 402, 403, 404, 409, 410, 422, 500, 503 | schema: `ToolCreate` | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents/{agent_id}/tools/catalog` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | None | None stated; read operation |
| DELETE | `/api/v1/public/voice-agents/{agent_id}/tools/{tool_id}` | advanced-voice | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 502, 503 | None | May change workspace data or trigger an external side effect |
| PATCH | `/api/v1/public/voice-agents/{agent_id}/tools/{tool_id}` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | schema: `ToolUpdate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/voice-agents/{agent_id}/tools/{tool_id}/test` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 502, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents/{agent_id}/voices` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 502, 503 | None | None stated; read operation |
| GET | `/api/v1/public/voice-agents/{agent_id}/widgets` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| POST | `/api/v1/public/voice-agents/{agent_id}/widgets` | advanced-voice | X-API-Key | No | 201, 401, 402, 403, 404, 409, 410, 422, 500, 503 | schema: `WidgetCreate` | May change workspace data or trigger an external side effect |
| DELETE | `/api/v1/public/voice-agents/{agent_id}/widgets/{widget_id}` | advanced-voice | X-API-Key | No | 204, 401, 402, 403, 404, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents/{agent_id}/widgets/{widget_id}` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| PATCH | `/api/v1/public/voice-agents/{agent_id}/widgets/{widget_id}` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: `WidgetUpdate` | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/voice-agents/{agent_id}/widgets/{widget_id}/avatar` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 429, 500, 502, 503 | None | May change workspace data or trigger an external side effect |
| GET | `/api/v1/public/voice-agents/{agent_id}/widgets/{widget_id}/embed` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| DELETE | `/api/v1/public/voice-agents/{agent_id}/widgets/{widget_id}/launcher-media` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 429, 500, 502, 503 | None | May change workspace data or trigger an external side effect |
| POST | `/api/v1/public/voice-agents/{agent_id}/widgets/{widget_id}/launcher-media` | advanced-voice | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 429, 500, 502, 503 | None | May change workspace data or trigger an external side effect |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.