Every HTTP operation the Gluon server registers, with its method, route and summary. A listed route still answers only the callers the policy decision point allows.
Call an operation
- Pick the tenant, environment and namespace, and how you will authenticate.
- Read the request and response schemas at
/api/docson your server, or fetch/api/openapi.json. - For ontology operations, fetch
/api/v1/openapi.jsonwith your client's token. It lists the object types, views, actions and functions that your Capability exposes on the API channel. - When a call is refused, read the reason and follow the matching guide. Don't retry under a broader identity.
Routes such as /api/v1/objects/{qname} are templates. The qualified names they accept depend on the deployment and on who is calling.
All operations
| Method | Route | Operation |
|---|---|---|
| GET | /.well-known/oauth-authorization-server | Server Metadata |
| GET | /.well-known/oauth-protected-resource | Protected resource metadata |
| GET | /.well-known/oauth-protected-resource/api/mcp | Protected resource metadata |
| GET | /.well-known/oauth-protected-resource/api/v1 | Protected resource metadata |
| GET | /api/.well-known/oauth-authorization-server | Server Metadata |
| GET | /api/.well-known/oauth-protected-resource | Protected resource metadata |
| GET | /api/.well-known/oauth-protected-resource/api/mcp | Protected resource metadata |
| GET | /api/.well-known/oauth-protected-resource/api/v1 | Protected resource metadata |
| GET | /api/actions/approvals | Approvals |
| POST | /api/actions/callbacks/{rid} | Agentos Callback |
| POST | /api/actions/preview | Preview |
| POST | /api/actions/runs | Submit |
| GET | /api/actions/runs/{rid} | Get Run |
| POST | /api/actions/runs/{rid}/cancel | Cancel |
| POST | /api/actions/runs/{rid}/decide | Decide |
| GET | /api/admin/access | Access |
| GET | /api/admin/actions/runs | Action Runs |
| GET | /api/admin/actions/runs/{rid} | Action Run |
| POST | /api/admin/actions/runs/{rid}/compensate | Compensate Run |
| GET | /api/admin/api-key-scopes | Api Key Scopes |
| POST | /api/admin/bindings | Bind |
| DELETE | /api/admin/bindings | Unbind |
| GET | /api/admin/capabilities | Capabilities |
| GET | /api/admin/capabilities/{ref}/activity | Capability Activity |
| POST | /api/admin/capabilities/{ref}/retire | Retire |
| POST | /api/admin/capabilities/{ref}/review | Review |
| GET | /api/admin/channels | Channels |
| GET | /api/admin/connectors | Connectors |
| GET | /api/admin/drift | Drift |
| GET | /api/admin/drift/report.pdf | Drift Report |
| POST | /api/admin/groups | Create Group |
| DELETE | /api/admin/groups/{oid} | Delete Group |
| PUT | /api/admin/groups/{oid}/members/{uid} | Add Member |
| DELETE | /api/admin/groups/{oid}/members/{uid} | Remove Member |
| PUT | /api/admin/groups/{oid}/parent | Nest Group |
| GET | /api/admin/health | Health Page |
| GET | /api/admin/identity | Identity |
| POST | /api/admin/identity/ldap/test | Ldap Test |
| POST | /api/admin/identity/sso/enforce | Sso Enforce |
| POST | /api/admin/identity/sso/test | Sso Test |
| GET | /api/admin/live-activity | Live Activity |
| GET | /api/admin/markings | Markings |
| GET | /api/admin/org | Org |
| GET | /api/admin/platform/ai-connections | Ai Connections |
| POST | /api/admin/platform/ai-connections | Add Ai Connection |
| POST | /api/admin/platform/ai-connections/test | Ai Connection Draft Test |
| PATCH | /api/admin/platform/ai-connections/{name} | Edit Ai Connection |
| DELETE | /api/admin/platform/ai-connections/{name} | Remove Ai Connection |
| PUT | /api/admin/platform/ai-connections/{name}/key | Set Ai Connection Key |
| POST | /api/admin/platform/ai-connections/{name}/test | Test Ai Connection |
| POST | /api/admin/platform/ai-connections/{name}/{state} | Set Ai Connection State |
| GET | /api/admin/platform/model-accuracy | Model Accuracy |
| GET | /api/admin/platform/model-routes | Model Routes |
| PUT | /api/admin/platform/model-routes/{kind} | Set Model Route |
| DELETE | /api/admin/platform/model-routes/{kind} | Clear Model Route |
| POST | /api/admin/platform/model-routes/{kind}/test | Test Model Route |
| POST | /api/admin/platform/model-versions/approve | Approve Model Version |
| GET | /api/admin/platform/models | Models |
| POST | /api/admin/platform/models/route | Route |
| GET | /api/admin/platform/pii | Pii Maskers |
| POST | /api/admin/platform/pii/test | Pii Test |
| GET | /api/admin/platform/planning | Planning |
| PUT | /api/admin/platform/planning | Set Planning |
| GET | /api/admin/platform/source-connections | List |
| POST | /api/admin/platform/source-connections | Add |
| PATCH | /api/admin/platform/source-connections/{name} | Edit |
| DELETE | /api/admin/platform/source-connections/{name} | Remove |
| GET | /api/admin/platform/source-connections/{name}/crawl | Status |
| POST | /api/admin/platform/source-connections/{name}/crawl | Start |
| POST | /api/admin/platform/source-connections/{name}/crawl/{action} | Control |
| POST | /api/admin/platform/source-connections/{name}/files | Upload a file |
| PUT | /api/admin/platform/source-connections/{name}/files/{did} | Replace a file |
| DELETE | /api/admin/platform/source-connections/{name}/files/{did} | Remove a file |
| PUT | /api/admin/platform/source-connections/{name}/secret | Set secret |
| POST | /api/admin/platform/source-connections/{name}/sync | Sync |
| POST | /api/admin/platform/source-connections/{name}/test | Test |
| GET | /api/admin/platform/storage | Storage |
| POST | /api/admin/platform/storage/test | Storage Test |
| GET | /api/admin/platform/webhooks | Webhooks |
| POST | /api/admin/platform/webhooks | Add Webhook |
| DELETE | /api/admin/platform/webhooks/{wid} | Remove Webhook |
| POST | /api/admin/platform/webhooks/{wid}/test | Test Webhook |
| GET | /api/admin/roles | Roles |
| POST | /api/admin/service-accounts | Service Account |
| POST | /api/admin/setup/sample | Setup Sample |
| POST | /api/admin/setup/sample/data | Setup Sample Data |
| DELETE | /api/admin/setup/sample/data | Setup Sample Remove |
| POST | /api/admin/setup/sample/deploy | Setup Sample Deploy |
| GET | /api/admin/skills | List |
| POST | /api/admin/skills | Add |
| POST | /api/admin/skills/draft | Draft skill |
| PUT | /api/admin/skills/{name} | Save |
| DELETE | /api/admin/skills/{name} | Remove |
| POST | /api/admin/skills/{name}/eval | Eval |
| POST | /api/admin/skills/{name}/try | Try draft |
| GET | /api/admin/teams/leads | Team Leads |
| POST | /api/admin/teams/leads | Set Lead |
| DELETE | /api/admin/teams/leads | Unset Lead |
| GET | /api/admin/tools | Tools |
| PATCH | /api/admin/tools/{id} | Edit tool |
| POST | /api/admin/tools/{id}/try | Try tool |
| GET | /api/admin/usage | Usage Report |
| GET | /api/admin/usage/activity | Usage Activity |
| PUT | /api/admin/usage/cohort | Usage Cohort |
| GET | /api/admin/users | Users |
| GET | /api/admin/users/{uid} | User |
| POST | /api/admin/users/{uid}/api-keys | Issue Key |
| DELETE | /api/admin/users/{uid}/api-keys/{kid} | Revoke Key |
| POST | /api/admin/users/{uid}/api-keys/{kid}/rotate | Rotate Key |
| GET | /api/admin/users/{uid}/credentials | Credentials |
| PUT | /api/admin/users/{uid}/expiry | Expiry |
| POST | /api/admin/users/{uid}/markings | Grant |
| DELETE | /api/admin/users/{uid}/markings/{marking} | Ungrant |
| POST | /api/admin/users/{uid}/reactivate | Reactivate |
| POST | /api/admin/users/{uid}/revoke-all | Revoke All |
| DELETE | /api/admin/users/{uid}/sessions/{sid} | Revoke Session |
| POST | /api/admin/users/{uid}/suspend | Suspend |
| POST | /api/auth/break-glass | Break Glass |
| POST | /api/auth/break-glass/reset | Break Glass Reset |
| POST | /api/auth/break-glass/webauthn/options | Break Glass Webauthn Options |
| POST | /api/auth/break-glass/webauthn/register | Webauthn Register |
| POST | /api/auth/break-glass/webauthn/register/options | Webauthn Register Options |
| GET | /api/auth/callback | Callback |
| GET | /api/auth/dev | Dev Sign In |
| GET | /api/auth/dev/personas | Dev Personas |
| GET | /api/auth/login | Login |
| POST | /api/auth/logout | Logout |
| GET | /api/auth/me | Me |
| GET | /api/auth/native/callback | Native Callback |
| POST | /api/auth/native/exchange | Native Exchange |
| POST | /api/auth/native/refresh | Native Refresh |
| GET | /api/auth/native/start | Native Start |
| POST | /api/auth/refresh | Refresh |
| GET | /api/auth/setup | Setup Status |
| POST | /api/auth/setup/admin | Setup Admin |
| POST | /api/auth/setup/finish | Setup Finish |
| POST | /api/auth/setup/mfa | Setup Mfa |
| GET | /api/auth/sso-test/callback | Sso Test Callback |
| POST | /api/chat/answer | Chat Answer |
| POST | /api/chat/ask | Chat Ask |
| GET | /api/chat/collections | Collections |
| POST | /api/chat/collections | Create Collection |
| GET | /api/chat/collections/{id} | Collection |
| PATCH | /api/chat/collections/{id} | Edit Collection |
| DELETE | /api/chat/collections/{id} | Delete Collection |
| GET | /api/chat/collections/{id}/documents | Collection Documents |
| POST | /api/chat/collections/{id}/documents | Add Collection Document |
| DELETE | /api/chat/collections/{id}/documents/{did} | Remove Collection Document |
| POST | /api/chat/collections/{id}/propose | Propose Collection |
| GET | /api/chat/conversations | Conversations |
| GET | /api/chat/conversations/{cid} | Conversation |
| DELETE | /api/chat/conversations/{cid} | Delete Conversation |
| PATCH | /api/chat/conversations/{cid} | Rename Conversation |
| POST | /api/chat/conversations/{cid}/hold | Legal Hold |
| POST | /api/chat/conversations/{cid}/share | Share |
| DELETE | /api/chat/conversations/{cid}/share | Unshare |
| POST | /api/chat/conversations/{cid}/uploads | Upload |
| GET | /api/chat/conversations/{cid}/uploads/{uid} | Upload state |
| GET | /api/chat/data | Data |
| POST | /api/chat/data/explain | Data explain |
| POST | /api/chat/data/export | Data export |
| GET | /api/chat/data/history | Data history |
| POST | /api/chat/data/query | Data query |
| GET | /api/chat/data/sample | Data sample |
| GET | /api/chat/data/saved | Data saved |
| POST | /api/chat/data/saved | Data save |
| PATCH | /api/chat/data/saved/{id} | Data edit saved |
| DELETE | /api/chat/data/saved/{id} | Data delete saved |
| GET | /api/chat/data/saved/{id}/draft | Data draft |
| GET | /api/chat/feedback | Steward Feedback |
| GET | /api/chat/getting-started | Getting Started |
| POST | /api/chat/getting-started | Mark Getting Started |
| GET | /api/chat/lineage | Lineage |
| DELETE | /api/chat/messages/{mid} | Delete message |
| GET | /api/chat/messages/{mid}/debug | Message debug |
| POST | /api/chat/messages/{mid}/feedback | Feedback |
| POST | /api/chat/messages/{mid}/restore | Restore message |
| GET | /api/chat/messages/{mid}/trace | Message trace |
| GET | /api/chat/objects/{oid} | Object Card |
| POST | /api/chat/reveal | Reveal |
| GET | /api/chat/scopes | Chat Scopes |
| POST | /api/chat/sets/export | Set Export |
| POST | /api/chat/sets/query | Set Query |
| POST | /api/chat/sets/save | Set Save |
| GET | /api/chat/shared/{token} | Shared |
| POST | /api/chat/stream | Chat Stream |
| GET | /api/deploy/aliases | Alias List |
| POST | /api/deploy/deployments | Create |
| GET | /api/deploy/deployments | Listing |
| POST | /api/deploy/deployments/preview | Preview |
| GET | /api/deploy/deployments/{name} | One |
| POST | /api/deploy/deployments/{name}/advance | Advance |
| POST | /api/deploy/deployments/{name}/approve | Approve |
| POST | /api/deploy/deployments/{name}/override | Override |
| POST | /api/deploy/deployments/{name}/retire | Retire |
| POST | /api/deploy/deployments/{name}/rollback | Rollback |
| GET | /api/deploy/disable | Disabled |
| POST | /api/deploy/disable | Disable Ref |
| DELETE | /api/deploy/disable/{ref} | Clear |
| POST | /api/deploy/evaluations | Evaluate |
| GET | /api/deploy/platform | Platform |
| GET | /api/deploy/scorecards/{kind}/{sid} | Scorecard |
| GET | /api/deploy/status | Status |
| GET | /api/designer/codes | List Codes |
| GET | /api/designer/codes/{code} | Get Code |
| GET | /api/designer/drift/review | Drift Review Queue |
| POST | /api/designer/drift/review/trial | Drift Review Trial |
| POST | /api/designer/drift/review/{id}/label | Drift Review Label |
| POST | /api/designer/extraction-profile/preview | Preview Extraction Profile |
| PUT | /api/designer/layout | Put Layout |
| GET | /api/designer/map | Get Map |
| GET | /api/designer/package | Get Package |
| POST | /api/designer/rename | Post Rename |
| GET | /api/designer/resources | List Resources |
| GET | /api/designer/resources/{path} | Get Resource |
| PUT | /api/designer/resources/{path} | Put Resource |
| DELETE | /api/designer/resources/{path} | Delete Resource |
| GET | /api/designer/schema | Get Schema |
| GET | /api/designer/usage/{element} | Get Usage |
| POST | /api/designer/validate | Validate Unsaved |
| POST | /api/designer/view-as | View As |
| POST | /api/desktop/ask | Desktop Ask |
| POST | /api/desktop/cross-check | Cross Check |
| POST | /api/desktop/decide | Decide |
| PUT | /api/desktop/denylist | Put Denylist |
| GET | /api/desktop/enrolment | Enrolment |
| PUT | /api/desktop/enrolment | Enrol |
| DELETE | /api/desktop/enrolment | Unenrol |
| GET | /api/desktop/explain | Explain |
| GET | /api/desktop/extraction-profile | Extraction Profile |
| GET | /api/desktop/fleet | Fleet |
| POST | /api/desktop/fleet/switch | Switch Off |
| POST | /api/desktop/fleet/switch/clear | Switch On |
| POST | /api/desktop/heartbeat | Heartbeat |
| GET | /api/desktop/objects/{ref} | Desktop Object |
| GET | /api/desktop/pack | Pack |
| GET | /api/desktop/pack-key | Pack Key |
| POST | /api/desktop/recognise | Recognise |
| POST | /api/dev/documents | Dev Documents |
| POST | /api/dev/documents/file | Dev Document File |
| POST | /api/dev/objects | Dev Objects |
| GET | /api/documents/{did} | Document |
| GET | /api/documents/{did}/blocks | Document Blocks |
| GET | /api/documents/{did}/chunks | Document Chunks |
| GET | /api/documents/{did}/view | Document View |
| GET | /api/events | Stream |
| POST | /api/fix | Fix |
| GET | /api/governance/compare | Compare Versions |
| GET | /api/governance/delegates | List Delegates |
| POST | /api/governance/delegates | Add Delegate |
| GET | /api/governance/inbox | Get Inbox |
| POST | /api/governance/inbox/accept-bulk | Accept Bulk |
| POST | /api/governance/inbox/merge-candidates/{cid} | Decide Candidate |
| POST | /api/governance/inbox/merge-candidates/{cid}/undo | Undo Candidate |
| POST | /api/governance/inbox/{item}/accept | Accept |
| POST | /api/governance/inbox/{item}/reject | Reject |
| POST | /api/governance/intake | Intake |
| GET | /api/governance/intake/rejected | Rejected |
| GET | /api/governance/proposals | List Proposals |
| POST | /api/governance/proposals | Create Proposal |
| GET | /api/governance/proposals/{name} | Get Proposal |
| POST | /api/governance/proposals/{name}/approve | Approve |
| POST | /api/governance/proposals/{name}/close | Close Proposal |
| GET | /api/governance/proposals/{name}/comments | List Comments |
| POST | /api/governance/proposals/{name}/comments | Add Comment |
| POST | /api/governance/proposals/{name}/comments/{cid}/resolve | Resolve Comment |
| POST | /api/governance/proposals/{name}/merge | Merge |
| POST | /api/governance/proposals/{name}/resolve | Resolve Conflict |
| POST | /api/governance/publish | Publish |
| GET | /api/governance/versions | List Versions |
| GET | /api/governance/versions/{version} | Get Version |
| GET | /api/health | Health |
| GET | /api/health/indicators | Indicators |
| GET | /api/mcp | Mcp Stream |
| POST | /api/mcp | Mcp |
| GET | /api/memory | List |
| DELETE | /api/memory | Wipe where |
| GET | /api/memory/map | Map |
| GET | /api/memory/records | Knowledge |
| GET | /api/memory/records/count | Knowledge Count |
| GET | /api/memory/summary | Summary |
| GET | /api/memory/{id} | Item |
| PATCH | /api/memory/{id} | Edit |
| DELETE | /api/memory/{id} | Wipe one |
| GET | /api/mining/corpus | Corpus |
| POST | /api/mining/extract | Extract |
| POST | /api/mining/keys | Keys |
| GET | /api/mining/ontology | Ontology |
| POST | /api/mining/runs | Open Run |
| GET | /api/mining/runs | List Runs |
| POST | /api/mining/runs/claim | Claim run |
| POST | /api/mining/runs/request | Request run |
| PATCH | /api/mining/runs/{rid} | Patch Run |
| GET | /api/mining/runs/{rid} | Get Run |
| POST | /api/mining/runs/{rid}/candidates | Report |
| POST | /api/mining/runs/{rid}/send | Send |
| GET | /api/mining/structure | Structure |
| GET | /api/notifications | Listing |
| PUT | /api/notifications/mutes/{source} | Mute Source |
| DELETE | /api/notifications/mutes/{source} | Unmute Source |
| GET | /api/notifications/preferences | Preferences |
| PUT | /api/notifications/preferences/{kind} | Set Preference |
| POST | /api/notifications/read-all | Read All |
| POST | /api/notifications/{nid}/read | Read One |
| GET | /api/oauth/authorize | Authorize |
| GET | /api/oauth/clients | Clients |
| POST | /api/oauth/clients | Approve |
| DELETE | /api/oauth/clients/{client_id} | Revoke Client |
| POST | /api/oauth/revoke | Revoke |
| POST | /api/oauth/token | Token |
| POST | /api/outcomes | Record Outcome |
| POST | /api/packages/export | Export |
| POST | /api/packages/import | Import |
| GET | /api/packages/keys | List Keys |
| POST | /api/packages/keys | Create Key |
| POST | /api/packages/keys/{kid}/revoke | Revoke Key |
| POST | /api/packages/keys/{kid}/rotate | Rotate Key |
| POST | /api/packages/trust | Trust |
| POST | /api/retrieval/playground | Retrieval Playground |
| GET | /api/scim/v2/Groups | List Groups |
| POST | /api/scim/v2/Groups | Create Group |
| GET | /api/scim/v2/Groups/{group_id} | Get Group |
| PATCH | /api/scim/v2/Groups/{group_id} | Patch Group |
| DELETE | /api/scim/v2/Groups/{group_id} | Delete Group |
| GET | /api/scim/v2/Users | List Users |
| POST | /api/scim/v2/Users | Create User |
| GET | /api/scim/v2/Users/{user_id} | Get User |
| PATCH | /api/scim/v2/Users/{user_id} | Patch User |
| DELETE | /api/scim/v2/Users/{user_id} | Delete User |
| GET | /api/search | Search |
| GET | /api/security/audit | Audit Search |
| GET | /api/security/audit/export | Audit Export |
| GET | /api/security/audit/verify | Audit Verify |
| POST | /api/security/audit/{rid}/payload | Audit Payload |
| GET | /api/security/chats | Security Chats |
| DELETE | /api/security/chats/{cid} | Erase Chat |
| POST | /api/security/chats/{cid}/open | Open Security Chat |
| POST | /api/security/explain | Explain |
| GET | /api/security/freshness | Freshness |
| POST | /api/security/grants | Grant |
| GET | /api/security/grants | Grants |
| POST | /api/security/grants/{gid}/revoke | Revoke |
| GET | /api/security/policies | Policies |
| POST | /api/security/requests | Request Access |
| GET | /api/security/requests | Requests |
| POST | /api/security/requests/{rid}/decide | Decide |
| GET | /api/security/segments | Segments |
| POST | /api/security/sources/{name}/resync | Resync |
| GET | /api/security/subjects | Subjects |
| POST | /api/security/tests | Save Test |
| POST | /api/security/view-as | View As |
| GET | /api/served/package | Served Package |
| POST | /api/sources/{name}/acls | Acls |
| POST | /api/sources/{name}/deletes | Deletes |
| POST | /api/sources/{name}/documents | Source Document |
| GET | /api/sources/{name}/documents | Source Documents |
| POST | /api/sources/{name}/status | Report |
| POST | /api/v1/actions/{qname} | Api Action |
| POST | /api/v1/ask | Api Ask |
| POST | /api/v1/functions/{qname} | Api Function |
| GET | /api/v1/objects/{qname} | Api List |
| GET | /api/v1/objects/{qname}/{oid} | Api Get |
| GET | /api/v1/openapi.json | Api Openapi |
| GET | /api/v1/package | Api Package |
| GET | /api/v1/views/{qname} | Api View |
| POST | /api/validate | Validate |
| GET | /api/workspace | Workspace |
| PUT | /api/workspace | Choose |
