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/agent-resources | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/agent-resources | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| DELETE | /api/v1/public/agent-resources/{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 |
| PATCH | /api/v1/public/agent-resources/{id} | 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/agent-resources/{id}/actions | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: AgentResourceToolAction | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/agents | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/agents | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| DELETE | /api/v1/public/agents/{agent_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 |
| PATCH | /api/v1/public/agents/{agent_id} | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: AgentPatchBody | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/agents/{agent_id}/actions | 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/agents/{agent_id}/context | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| GET | /api/v1/public/analytics | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| GET | /api/v1/public/calls | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/calls | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: api__v1__public__facade__content__CallBody | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/calls/{call_id}/recording | customer | X-API-Key | No | 200, 401, 402, 403, 404, 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 | None | 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 |
| PATCH | /api/v1/public/campaigns/{campaign_id} | 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/campaigns/{campaign_id}/actions | customer | X-API-Key | No | 200, 401, 402, 403, 404, 409, 410, 422, 500, 503 | schema: api__v1__public__campaign_ops__CampaignAction | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/connections | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/connections | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| DELETE | /api/v1/public/connections/{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 |
| PATCH | /api/v1/public/connections/{id} | 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/connections/{id}/actions | 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/conversations | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/conversations/{lead_id}/actions | customer | X-API-Key | No | 200, 400, 401, 402, 403, 404, 410, 422, 500, 503 | schema: ConversationAction | 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/custom-voices | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/custom-voices | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| DELETE | /api/v1/public/custom-voices/{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 |
| PATCH | /api/v1/public/custom-voices/{id} | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: UpdateVoiceSettingsIn | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/dnc | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| PATCH | /api/v1/public/dnc | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: DncPatchBody | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/files | customer | 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/jobs | customer | X-API-Key | Yes | 200, 401, 402, 403, 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 |
| PATCH | /api/v1/public/knowledge-bases/{kb_id} | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: KBPatchBody | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/lead-collections | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/lead-collections | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| DELETE | /api/v1/public/lead-collections/{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 |
| PATCH | /api/v1/public/lead-collections/{id} | 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/lead-collections/{id}/actions | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: LeadCollectionSegmentAction | 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 | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: LeadsCreateBody | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/leads/bulk | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: BulkAction | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/leads/enrich | customer | X-API-Key | Yes | 200, 401, 402, 403, 410, 422, 500, 502, 503 | schema: api__v1__public__facade__leads__EnrichBody | 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 |
| PATCH | /api/v1/public/leads/{lead_id} | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: LeadPatchBody | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/leads/{lead_id}/actions | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: LeadAction | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/messages | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: MessageBody | 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 | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: NumberImportBody | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/phone-numbers/{id}/actions | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: NumberAction | May change workspace data or trigger an external side effect |
| PATCH | /api/v1/public/phone-numbers/{number_id} | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: NumberPatchBody | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/purchases | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/purchases | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: PurchaseRequest | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/searches | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: SearchBody | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/searches/{search_id} | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | None | None stated; read operation |
| GET | /api/v1/public/sms-registrations | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/sms-registrations | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | None | May change workspace data or trigger an external side effect |
| DELETE | /api/v1/public/sms-registrations/{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 |
| PATCH | /api/v1/public/sms-registrations/{id} | 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/sms-registrations/{id}/actions | 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/voices | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 502, 503 | None | None stated; read operation |
| GET | /api/v1/public/work-items | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/work-items | customer | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: WorkItemMeetingCreate | May change workspace data or trigger an external side effect |
| DELETE | /api/v1/public/work-items/{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 |
| PATCH | /api/v1/public/work-items/{id} | 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/work-items/{id}/actions | customer | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: WorkItemApprovalAction | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/workspace-settings | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| PATCH | /api/v1/public/workspace-settings | customer | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: SettingsUpdate | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/workspace-settings/actions | customer | 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/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 |
| PATCH | /api/v1/public/partner/clients/{client_id} | agency | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: ClientPatchBody | May change workspace data or trigger an external side effect |
| POST | /api/v1/public/partner/clients/{client_id}/actions | agency | X-API-Key | No | 200, 401, 402, 403, 404, 410, 422, 500, 503 | schema: ClientAction | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/partner/packages | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| POST | /api/v1/public/partner/packages | agency | X-API-Key | No | 201, 401, 402, 403, 410, 422, 500, 503 | schema: PackageBody | May change workspace data or trigger an external side effect |
| PUT | /api/v1/public/partner/pricing | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: PricingChange | May change workspace data or trigger an external side effect |
| GET | /api/v1/public/partner/settings | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | None | None stated; read operation |
| PUT | /api/v1/public/partner/settings | agency | X-API-Key | No | 200, 401, 402, 403, 410, 422, 500, 503 | schema: SettingsPutBody | 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 |