Polyant Engine API Index
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 programmatic search across the same routes (full JSON Schema, descriptions), see OpenAPI JSON instead — this file is deliberately condensed to stay small enough to read in one pass.
Engine version: 0.1.0 Routes: 172
activity-stream
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/activity-stream/live | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
analytics
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/analytics | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
attachments
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/attachments/{key} | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token | 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 | - |
| GET | /api/audit-logs/stats | audit_log:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
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 | - |
| DELETE | /api/conversations/{conversationId} | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/conversations/{conversationId} | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/conversations/{conversationId} | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/conversations/{conversationId}/hooks | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/conversations/{conversationId}/messages | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/conversations/{conversationId}/messages/{messageId}/debug | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/conversations/{conversationId}/state | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
governance
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/governance/analytics | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/governance/metadata | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/governance/overview | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/governance/tools | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
health
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /health | - | public | - |
hook-functions
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/hook-functions | agent.tool:read | management (X-Polyant-Key) or 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 | - |
| POST | /api/instances | agent:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/import | agent:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/models | agent:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug} | agent:delete | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug} | agent:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/instances/{slug} | agent:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/analytics | analytics:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/channels | agent.channel:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/channels/{type} | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PUT | /api/instances/{slug}/channels/{type} | agent.channel:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/chat/stream | - | instance bearer key or no authentication (conditional) (public metadata, handler-validated) | - |
| GET | /api/instances/{slug}/compliance/model-card | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/instances/{slug}/compliance/model-card | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/compliance/reports | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/compliance/reports | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/compliance/reports/{id} | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/compliance/snapshots | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/compliance/snapshots | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/compliance/snapshots/{version} | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/event-sources | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/event-sources | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/event-sources/{id} | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PUT | /api/instances/{slug}/event-sources/{id} | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/event-sources/{id}/definitions | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/event-sources/{id}/definitions | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/event-sources/{id}/definitions/{defId} | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PUT | /api/instances/{slug}/event-sources/{id}/definitions/{defId} | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/event-sources/{id}/rotate-token | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/export | agent.export:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/governance/analytics | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/governance/events | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/governance/policies | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/instances/{slug}/governance/policies | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/governance/policies/{assignmentId} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/hooks | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/hooks | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/hooks/{id} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/instances/{slug}/hooks/{id} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/icon | agent:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/icon | agent:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PUT | /api/instances/{slug}/icon | agent:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/import | agent:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/knowledge | agent.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/knowledge | agent.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token | throttle 5/60000ms |
| GET | /api/instances/{slug}/knowledge/export | agent.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/knowledge/import | agent.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token | throttle 5/60000ms |
| DELETE | /api/instances/{slug}/knowledge/{docId} | agent.knowledge:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/knowledge/{docId} | agent.knowledge:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/optouts | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/optouts | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/optouts/{channelType}/{channelId} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/prompts | agent.prompt:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/instances/{slug}/prompts | agent.prompt:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/retention | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/retention | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PUT | /api/instances/{slug}/retention | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/retention/run | conversation:delete | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/retention/runs | conversation:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/room | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/room | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PUT | /api/instances/{slug}/room | agent.room:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/room/activity | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/room/backlog | agent.room:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/scheduled-tasks | agent.task:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/scheduled-tasks | agent.task:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/scheduled-tasks/runs | agent.task:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/scheduled-tasks/{id} | agent.task:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/scheduled-tasks/{id} | agent.task:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/instances/{slug}/scheduled-tasks/{id} | agent.task:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/scheduled-tasks/{id}/run | agent.task:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/secrets | agent.secret:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PUT | /api/instances/{slug}/secrets | agent.secret:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/secrets/{key} | agent.secret:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/skills | agent.skill:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/instances/{slug}/skills | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/skills/{skillSlug}/auto-load | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/skills/{skillSlug}/env | agent.skill:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PUT | /api/instances/{slug}/skills/{skillSlug}/env | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/instances/{slug}/skills/{skillSlug}/env/{key} | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/skills/{skillSlug}/rollback | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/instances/{slug}/skills/{skillSlug}/upgrade | agent.skill:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/tools | agent.tool:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/instances/{slug}/tools | agent.tool:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/instances/{slug}/tools/required-secrets | agent.tool:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
invitations
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| POST | /api/invitations/accept | org:read | management (X-Polyant-Key) or 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 |
me
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/me | org:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/me/access | authenticated | session cookie or session bearer token | - |
| POST | /api/me/password | authenticated | session cookie or session bearer token | - |
memories
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| DELETE | /memories | memory:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /memories | memory:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /memories | memory:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /memories/{id} | memory:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
oauth
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /oauth/{provider}/callback | - | public | - |
organizations
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/organizations | org:read | management (X-Polyant-Key) or session cookie or session bearer token | throttle 30/60000ms |
| POST | /api/organizations | org:write | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: multi_org; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug} | org:write | management (X-Polyant-Key) or 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 | EE feature: multi_org; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/api-keys | org:write | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: granular_api_keys; throttle 30/60000ms |
| POST | /api/organizations/{orgSlug}/api-keys | org:write | management (X-Polyant-Key) or 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 | 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 | EE feature: granular_api_keys; throttle 30/60000ms |
| PATCH | /api/organizations/{orgSlug}/api-keys/{keyId} | org:write | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: granular_api_keys; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/authz-audit-logs | audit_log:read | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: advanced_audit; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/governance/policies | agent.governance:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/organizations/{orgSlug}/governance/policies | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/organizations/{orgSlug}/governance/policies/{id} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PATCH | /api/organizations/{orgSlug}/governance/policies/{id} | agent.governance:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/organizations/{orgSlug}/invitations | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | 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 | 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 | EE feature: user_invitations; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/members | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/members/{userId} | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | throttle 30/60000ms |
| PUT | /api/organizations/{orgSlug}/members/{userId} | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/roles | org:write | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: custom_roles; throttle 30/60000ms |
| POST | /api/organizations/{orgSlug}/roles | org:write | management (X-Polyant-Key) or 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 | EE feature: custom_roles; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/roles/{roleId} | org:write | management (X-Polyant-Key) or 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 | EE feature: custom_roles; throttle 30/60000ms |
| PATCH | /api/organizations/{orgSlug}/roles/{roleId} | org:write | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: custom_roles; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/workspace-bindings | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| GET | /api/organizations/{orgSlug}/workspaces | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| POST | /api/organizations/{orgSlug}/workspaces | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/workspaces/{workspaceId} | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| PATCH | /api/organizations/{orgSlug}/workspaces/{workspaceId} | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| DELETE | /api/organizations/{orgSlug}/workspaces/{workspaceId}/members/{userId} | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
| PUT | /api/organizations/{orgSlug}/workspaces/{workspaceId}/members/{userId} | org.member:manage | management (X-Polyant-Key) or session cookie or session bearer token | EE feature: workspace_scoped_rbac; throttle 30/60000ms |
skills
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/skills | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/skills | skill.catalog:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/skills/catalog/export | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| POST | /api/skills/catalog/import | skill.catalog:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| DELETE | /api/skills/{name} | skill.catalog:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/skills/{name} | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| PUT | /api/skills/{name} | skill.catalog:write | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/skills/{name}/export | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/skills/{name}/versions | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
| GET | /api/skills/{name}/versions/{version} | skill.catalog:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
tools
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/tools | agent.tool:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
users
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| GET | /api/users | role: superadmin | session cookie or session bearer token | - |
| POST | /api/users | role: superadmin | session cookie or session bearer token | - |
| DELETE | /api/users/{id} | role: superadmin | session cookie or session bearer token | - |
| GET | /api/users/{id} | role: superadmin | session cookie or session bearer token | - |
| PATCH | /api/users/{id} | role: superadmin | session cookie or session bearer token | - |
| POST | /api/users/{id}/reset-password | role: superadmin | 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 instance bearer key | - |
webhooks
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| POST | /webhooks/twilio/{instanceSlug}/whatsapp | - | public | throttle 60/60000ms |
| POST | /webhooks/{webhookToken} | - | public | throttle 60/60000ms |
workspaces
| Verb | Path | Permission | Auth | Notes |
|---|---|---|---|---|
| PUT | /api/workspaces/active | agent:read | management (X-Polyant-Key) or session cookie or session bearer token | - |
Last updated on