Polyant Engine API Index
On this page
Generated file — do not edit by hand. One row per HTTP route, with everything that decides whether you can call it: verb, path, required permission, auth mechanism, and any EE/throttle/wildcard notes. For the same routes in machine-readable form, see OpenAPI JSON. It declares parameters, security and permissions, but no request bodies and no response schemas yet.
Engine version: 1.2.0-ee Routes: 354
a2a
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /a2a/{slug}/.well-known/agent-card.json | - | public | - |
| POST | /a2a/{slug}/jsonrpc | - | public | throttle 20/60000ms |
activity-stream
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/activity-stream/conversation | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/activity-stream/live | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
ai-logs
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/ai-logs | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
analytics
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/analytics | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/analytics/agent-checks | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
attachments
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/attachments/{key} | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | wildcard path param |
audit-logs
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/audit-logs | audit_log:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/audit-logs/stats | audit_log:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
auth
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| POST | /api/auth/credentials/verify | - | internal secret (x-internal-auth) (public metadata, handler-validated) | throttle 5/60000ms |
channels
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| POST | /channels/http/{slug}/messages | - | instance bearer key or no authentication (conditional) (public metadata, handler-validated) | throttle 300/60000ms |
conversations
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/conversations | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/conversations/export.csv | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/conversations/{conversationId} | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/conversations/{conversationId} | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/conversations/{conversationId} | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/conversations/{conversationId}/hooks | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/conversations/{conversationId}/messages | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/conversations/{conversationId}/messages/{messageId}/debug | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/conversations/{conversationId}/state | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
docs
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/docs | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
docs-init.js
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/docs-init.js | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
governance
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/governance/analytics | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/governance/metadata | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/governance/overview | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/governance/tools | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
health
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /health | - | public | - |
| GET | /health/scheduler | - | public | - |
hook-functions
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/hook-functions | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
impersonation
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| DELETE | /api/impersonation | role: platform_admin | session cookie or session bearer token | - |
| GET | /api/impersonation | role: platform_admin | session cookie or session bearer token | - |
| POST | /api/impersonation | role: platform_admin | session cookie or session bearer token | - |
instances
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/instances | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances | agent:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/channels/email/drivers | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/channels/probes | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/import | agent:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/models | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug} | agent:delete | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug} | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/instances/{slug} | agent:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/agent-tool-targets | agent.tool:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/analytics | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/budget | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/budget | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/channels/email/rotate-webhook-secret | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels/email/webhook-url | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels/hubspot/webhook-url | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels/slack/webhook-url | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels/voice/defaults | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/channels/voice/import | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels/voice/settings | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/channels/voice/settings | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/channels/voice/settings/validate | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels/voice/status | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels/voice/tools | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels/voice/tts-catalog | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/channels/whatsapp/rotate-webhook-secret | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/channels/whatsapp/webhook-url | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/channels/{type} | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/channels/{type} | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/channels/{type}/test | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/chat/stream | - | instance bearer key or no authentication (conditional) (public metadata, handler-validated) | - |
| GET | /api/instances/{slug}/check-dismissals | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/check-dismissals/{checkId} | agent:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/check-dismissals/{checkId} | agent:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/checks | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/compliance/model-card | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/instances/{slug}/compliance/model-card | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/compliance/reports | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/compliance/reports | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/compliance/reports/{id} | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/compliance/snapshots | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/compliance/snapshots | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/compliance/snapshots/{version} | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/dev-session | agent.dev:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/dev-session/token | agent.dev:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/dev-session/token | agent.dev:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/event-sources | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/event-sources | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/event-sources/{id} | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/event-sources/{id} | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/event-sources/{id}/definitions | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/event-sources/{id}/definitions | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/event-sources/{id}/definitions/{defId} | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/event-sources/{id}/definitions/{defId} | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/event-sources/{id}/rotate-token | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/event-sources/{id}/webhook-url | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/export | agent.export:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/governance/analytics | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/governance/events | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/governance/policies | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/instances/{slug}/governance/policies | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/governance/policies/{assignmentId} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/health-signals | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/hooks | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/hooks | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/hooks/{id} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/instances/{slug}/hooks/{id} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/icon | agent:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/icon | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/icon | agent:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/import | agent:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/knowledge | agent.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/knowledge | agent.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 5/60000ms |
| GET | /api/instances/{slug}/knowledge/export | agent.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/knowledge/file | agent.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 10/60000ms |
| POST | /api/instances/{slug}/knowledge/import | agent.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 5/60000ms |
| DELETE | /api/instances/{slug}/knowledge/{docId} | agent.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/knowledge/{docId} | agent.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/mcp-servers | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/mcp-servers/test | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/mcp-servers/{serverSlug} | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/mcp-servers/{serverSlug} | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/optouts | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/optouts | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/optouts/{channelType}/{channelId} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/playground/chat/stream | - | instance bearer key or no authentication (conditional) (public metadata, handler-validated) | - |
| POST | /api/instances/{slug}/playground/stream | agent.playground:use | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/prompts | agent.prompt:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/instances/{slug}/prompts | agent.prompt:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/provider-connections | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/provider-connections | agent.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/provider-connections/{connectionId} | agent.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/instances/{slug}/provider-connections/{connectionId} | agent.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/provider-roles | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/provider-roles/{role} | agent:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/providers | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/retention | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/retention | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/retention | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/retention/run | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/retention/runs | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/room | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/room | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/room | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/room/activity | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/room/backlog | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/scheduled-tasks | agent.task:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/scheduled-tasks | agent.task:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/scheduled-tasks/runs | agent.task:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/scheduled-tasks/{id} | agent.task:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/scheduled-tasks/{id} | agent.task:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/instances/{slug}/scheduled-tasks/{id} | agent.task:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/scheduled-tasks/{id}/run | agent.task:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/secrets | agent.secret:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/secrets | agent.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/secrets/{key} | agent.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/shared-knowledge | agent.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/shared-knowledge/{docId} | agent.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/shared-knowledge/{docId} | agent.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/skills | agent.skill:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/instances/{slug}/skills | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/skills/{skillSlug}/auto-load | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/skills/{skillSlug}/env | agent.skill:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/instances/{slug}/skills/{skillSlug}/env | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/instances/{slug}/skills/{skillSlug}/env/{key} | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/skills/{skillSlug}/rollback | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/instances/{slug}/skills/{skillSlug}/upgrade | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/tools | agent.tool:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/instances/{slug}/tools | agent.tool:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/instances/{slug}/tools/required-secrets | agent.tool:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
invitations
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| POST | /api/invitations/accept | authenticated | session cookie or session bearer token | throttle 10/60000ms |
| GET | /api/invitations/preview | - | public | throttle 10/60000ms |
| POST | /api/invitations/signup | - | public | throttle 5/60000ms |
mcp
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /mcp/oauth/callback | - | public | - |
me
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/me | authenticated | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/me/access | authenticated | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/me/onboarding | authenticated | session cookie or session bearer token | - |
| POST | /api/me/password | authenticated | session cookie or session bearer token | - |
| GET | /api/me/tokens | authenticated | session cookie or session bearer token | throttle 30/60000ms |
| POST | /api/me/tokens | authenticated | session cookie or session bearer token | throttle 30/60000ms |
| GET | /api/me/tokens/permissions | authenticated | session cookie or session bearer token | throttle 30/60000ms |
| DELETE | /api/me/tokens/{tokenId} | authenticated | session cookie or session bearer token | throttle 30/60000ms |
| DELETE | /api/me/two-factor | authenticated | session cookie or session bearer token | throttle 10/60000ms |
| GET | /api/me/two-factor | authenticated | session cookie or session bearer token | throttle 10/60000ms |
| POST | /api/me/two-factor/enrolment | authenticated | session cookie or session bearer token | throttle 10/60000ms |
| POST | /api/me/two-factor/enrolment/confirm | authenticated | session cookie or session bearer token | throttle 10/60000ms |
| POST | /api/me/two-factor/recovery-codes | authenticated | session cookie or session bearer token | throttle 10/60000ms |
memories
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| DELETE | /memories | memory:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /memories | memory:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /memories | memory:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /memories/{id} | memory:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
messages
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/messages | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
oauth
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /oauth/{provider}/callback | - | public | - |
openapi.json
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/openapi.json | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
organizations
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/organizations | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
| POST | /api/organizations | org:write | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: multi_org; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug} | org:write | session cookie or session bearer token | EE feature: multi_org; throttle 30/60000ms |
| PATCH | /api/organizations/{orgSlug} | org:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: multi_org; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/analytics | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/analytics/workspaces | org.analytics:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/api-keys | org:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: granular_api_keys; throttle 30/60000ms |
| POST | /api/organizations/{orgSlug}/api-keys | org:write | session cookie or session bearer token | EE feature: granular_api_keys; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/api-keys/permissions | org:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: granular_api_keys; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/api-keys/{keyId} | org:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: granular_api_keys; throttle 30/60000ms |
| PATCH | /api/organizations/{orgSlug}/api-keys/{keyId} | org:write | session cookie or session bearer token | EE feature: granular_api_keys; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/authz-audit-logs | org.audit:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: advanced_audit; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/governance/analytics | org.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/governance/policies | org.governance:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/organizations/{orgSlug}/governance/policies | org.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/organizations/{orgSlug}/governance/policies/{id} | org.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/organizations/{orgSlug}/governance/policies/{id} | org.governance:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/invitations | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: user_invitations; throttle 30/60000ms |
| POST | /api/organizations/{orgSlug}/invitations | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: user_invitations; throttle 5/60000ms |
| DELETE | /api/organizations/{orgSlug}/invitations/{invitationId} | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: user_invitations; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/knowledge | org.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/knowledge/embedder | org.secret:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/knowledge/embedder | org.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/knowledge/export | org.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/organizations/{orgSlug}/knowledge/file | org.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 10/60000ms |
| POST | /api/organizations/{orgSlug}/knowledge/import | org.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 5/60000ms |
| DELETE | /api/organizations/{orgSlug}/knowledge/{docId} | org.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/organizations/{orgSlug}/knowledge/{docId}/workspaces/{workspaceSlug} | workspace.knowledge:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/knowledge/{docId}/workspaces/{workspaceSlug} | workspace.knowledge:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/management-audit-logs | org.audit:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/members | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/members/{userId} | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
| PUT | /api/organizations/{orgSlug}/members/{userId} | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/plugins | org.plugin:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/plugins/catalog | org.plugin:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/plugins/health | org.plugin:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/organizations/{orgSlug}/plugins/{pluginId} | org.plugin:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/plugins/{pluginId} | org.plugin:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/organizations/{orgSlug}/plugins/{pluginId}/install | org.plugin:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/organizations/{orgSlug}/plugins/{pluginId}/preflight | org.plugin:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/plugins/{pluginId}/version | org.plugin:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/provider-connections | org.secret:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/organizations/{orgSlug}/provider-connections | org.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/organizations/{orgSlug}/provider-connections/{connectionId} | org.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/organizations/{orgSlug}/provider-connections/{connectionId} | org.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/providers | org.secret:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/providers/managed-only | org.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/providers/roles | org.secret:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/providers/roles/{role} | org.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/roles | org:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: custom_roles; throttle 30/60000ms |
| POST | /api/organizations/{orgSlug}/roles | org:write | session cookie or session bearer token | EE feature: custom_roles; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/roles/permissions | org:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: custom_roles; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/roles/{roleId} | org:write | session cookie or session bearer token | EE feature: custom_roles; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/roles/{roleId} | org:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: custom_roles; throttle 30/60000ms |
| PATCH | /api/organizations/{orgSlug}/roles/{roleId} | org:write | session cookie or session bearer token | EE feature: custom_roles; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/secrets | org.secret:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/secrets | org.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/organizations/{orgSlug}/secrets/{key} | org.secret:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/skills | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/organizations/{orgSlug}/skills | skill.catalog:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/skills/catalog/export | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/organizations/{orgSlug}/skills/catalog/import | skill.catalog:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/organizations/{orgSlug}/skills/{name} | skill.catalog:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/skills/{name} | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/skills/{name} | skill.catalog:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/skills/{name}/export | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/skills/{name}/versions | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/skills/{name}/versions/{version} | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/two-factor | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
| PUT | /api/organizations/{orgSlug}/two-factor | org:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/workspace-bindings | workspace.member:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/workspaces | workspace:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| POST | /api/organizations/{orgSlug}/workspaces | workspace:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/workspaces/{workspaceId} | workspace:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| PATCH | /api/organizations/{orgSlug}/workspaces/{workspaceId} | workspace:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/workspaces/{workspaceId}/members/{userId} | workspace.member:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| PUT | /api/organizations/{orgSlug}/workspaces/{workspaceId}/members/{userId} | workspace.member:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/dev-mode | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/dev-mode | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/dev-mode | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/knowledge | org.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/knowledge/export | org.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/knowledge/file | workspace.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 10/60000ms |
| POST | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/knowledge/import | workspace.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 5/60000ms |
| DELETE | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/knowledge/{docId} | workspace.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/plugins | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/plugins/{name} | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/plugins/{name} | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/provider-connections | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/provider-connections | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/provider-connections/{connectionId} | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/provider-connections/{connectionId} | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/providers | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/providers | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/providers/models | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/skills | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/skills/{name} | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/organizations/{orgSlug}/workspaces/{workspaceSlug}/skills/{name} | workspace.assignment:manage | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
password-reset
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| POST | /api/password-reset/confirm | - | public | throttle 5/60000ms |
| POST | /api/password-reset/request | - | public | throttle 5/60000ms |
pipeline-traces
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/pipeline-traces | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
platform
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/platform/analytics | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/audit-logs | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
| DELETE | /api/platform/mail | role: platform_admin | session cookie or session bearer token | - |
| GET | /api/platform/mail | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/mail | role: platform_admin | session cookie or session bearer token | - |
| GET | /api/platform/organizations/dev-mode | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/organizations/sso-domains | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/platform/organizations/{targetOrgSlug}/ambient-aws | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/organizations/{targetOrgSlug}/ambient-aws | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/organizations/{targetOrgSlug}/ambient-aws | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/platform/organizations/{targetOrgSlug}/dev-mode | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/organizations/{targetOrgSlug}/dev-mode | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/organizations/{targetOrgSlug}/providers | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/organizations/{targetOrgSlug}/providers | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/organizations/{targetOrgSlug}/providers/models | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/platform/organizations/{targetOrgSlug}/providers/{provider} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/organizations/{targetOrgSlug}/sso-domains | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/organizations/{targetOrgSlug}/sso-domains | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/plugins | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/plugins/baked | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/platform/plugins/catalog/refresh | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/plugins/health | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/plugins/marketplaces | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/platform/plugins/marketplaces | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/platform/plugins/marketplaces/{id} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/platform/plugins/marketplaces/{id} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/plugins/organizations/{targetOrgSlug} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/platform/plugins/{name}/organizations/{targetOrgSlug} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/plugins/{name}/organizations/{targetOrgSlug} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/platform/plugins/{pluginId}/organizations/{targetOrgSlug}/denial | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/plugins/{pluginId}/organizations/{targetOrgSlug}/denial | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/plugins/{pluginId}/versions/{version}/block | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/platform/plugins/{pluginId}/versions/{version}/organizations/{targetOrgSlug}/terminate | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/settings | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/platform/settings | role: platform_admin | session cookie or session bearer token | - |
| GET | /api/platform/skills | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/platform/skills | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/skills/{name} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/skills/{name} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| DELETE | /api/platform/skills/{name}/organizations/{targetOrgSlug} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PUT | /api/platform/skills/{name}/organizations/{targetOrgSlug} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/platform/two-factor | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
| PUT | /api/platform/two-factor | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | throttle 30/60000ms |
service-context
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/service-context | - | management (X-Polyant-Key) | - |
tools
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/tools | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
users
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/users | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/users | role: platform_admin | session cookie or session bearer token | - |
| DELETE | /api/users/{id} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| GET | /api/users/{id} | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| PATCH | /api/users/{id} | role: platform_admin | session cookie or session bearer token | - |
| DELETE | /api/users/{id}/api-tokens | role: platform_admin | session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
| POST | /api/users/{id}/reset-password | role: platform_admin | session cookie or session bearer token | - |
v1
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| POST | /v1/chat/completions | - | instance bearer key or no authentication (conditional) (public metadata, handler-validated) | throttle 20/60000ms |
| GET | /v1/models | agent:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) or instance bearer key | - |
webhooks
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| POST | /webhooks/email/{instanceSlug}/{webhookSecret} | - | public | throttle 60/60000ms |
| POST | /webhooks/hubspot | - | public | throttle 120/60000ms |
| POST | /webhooks/hubspot/{instanceSlug} | - | public | throttle 120/60000ms |
| POST | /webhooks/slack/{instanceSlug} | - | public | throttle 120/60000ms |
| POST | /webhooks/telegram/{instanceSlug} | - | public | throttle 120/60000ms |
| GET | /webhooks/twilio/{instanceSlug}/voice | - | public | throttle 60/60000ms |
| POST | /webhooks/twilio/{instanceSlug}/voice | - | public | throttle 60/60000ms |
| POST | /webhooks/twilio/{instanceSlug}/whatsapp | - | public | throttle 60/60000ms |
| POST | /webhooks/twilio/{instanceSlug}/whatsapp/{webhookSecret} | - | public | throttle 60/60000ms |
| POST | /webhooks/{webhookToken} | - | public | throttle 60/60000ms |
workspaces
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| PUT | /api/workspaces/active | org:read | management (X-Polyant-Key) or session cookie or session bearer token or personal token (pat_ on X-Polyant-Key) | - |
Last updated on