Skip to manual
gluon

API and integrations

HTTP operations

All 368 HTTP operations the server registers, with method, route and summary.

Model author or developer

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

  1. Pick the tenant, environment and namespace, and how you will authenticate.
  2. Read the request and response schemas at /api/docs on your server, or fetch /api/openapi.json.
  3. For ontology operations, fetch /api/v1/openapi.json with your client's token. It lists the object types, views, actions and functions that your Capability exposes on the API channel.
  4. 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

MethodRouteOperation
GET/.well-known/oauth-authorization-serverServer Metadata
GET/.well-known/oauth-protected-resourceProtected resource metadata
GET/.well-known/oauth-protected-resource/api/mcpProtected resource metadata
GET/.well-known/oauth-protected-resource/api/v1Protected resource metadata
GET/api/.well-known/oauth-authorization-serverServer Metadata
GET/api/.well-known/oauth-protected-resourceProtected resource metadata
GET/api/.well-known/oauth-protected-resource/api/mcpProtected resource metadata
GET/api/.well-known/oauth-protected-resource/api/v1Protected resource metadata
GET/api/actions/approvalsApprovals
POST/api/actions/callbacks/{rid}Agentos Callback
POST/api/actions/previewPreview
POST/api/actions/runsSubmit
GET/api/actions/runs/{rid}Get Run
POST/api/actions/runs/{rid}/cancelCancel
POST/api/actions/runs/{rid}/decideDecide
GET/api/admin/accessAccess
GET/api/admin/actions/runsAction Runs
GET/api/admin/actions/runs/{rid}Action Run
POST/api/admin/actions/runs/{rid}/compensateCompensate Run
GET/api/admin/api-key-scopesApi Key Scopes
POST/api/admin/bindingsBind
DELETE/api/admin/bindingsUnbind
GET/api/admin/capabilitiesCapabilities
GET/api/admin/capabilities/{ref}/activityCapability Activity
POST/api/admin/capabilities/{ref}/retireRetire
POST/api/admin/capabilities/{ref}/reviewReview
GET/api/admin/channelsChannels
GET/api/admin/connectorsConnectors
GET/api/admin/driftDrift
GET/api/admin/drift/report.pdfDrift Report
POST/api/admin/groupsCreate 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}/parentNest Group
GET/api/admin/healthHealth Page
GET/api/admin/identityIdentity
POST/api/admin/identity/ldap/testLdap Test
POST/api/admin/identity/sso/enforceSso Enforce
POST/api/admin/identity/sso/testSso Test
GET/api/admin/live-activityLive Activity
GET/api/admin/markingsMarkings
GET/api/admin/orgOrg
GET/api/admin/platform/ai-connectionsAi Connections
POST/api/admin/platform/ai-connectionsAdd Ai Connection
POST/api/admin/platform/ai-connections/testAi 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}/keySet Ai Connection Key
POST/api/admin/platform/ai-connections/{name}/testTest Ai Connection
POST/api/admin/platform/ai-connections/{name}/{state}Set Ai Connection State
GET/api/admin/platform/model-accuracyModel Accuracy
GET/api/admin/platform/model-routesModel 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}/testTest Model Route
POST/api/admin/platform/model-versions/approveApprove Model Version
GET/api/admin/platform/modelsModels
POST/api/admin/platform/models/routeRoute
GET/api/admin/platform/piiPii Maskers
POST/api/admin/platform/pii/testPii Test
GET/api/admin/platform/planningPlanning
PUT/api/admin/platform/planningSet Planning
GET/api/admin/platform/source-connectionsList
POST/api/admin/platform/source-connectionsAdd
PATCH/api/admin/platform/source-connections/{name}Edit
DELETE/api/admin/platform/source-connections/{name}Remove
GET/api/admin/platform/source-connections/{name}/crawlStatus
POST/api/admin/platform/source-connections/{name}/crawlStart
POST/api/admin/platform/source-connections/{name}/crawl/{action}Control
POST/api/admin/platform/source-connections/{name}/filesUpload 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}/secretSet secret
POST/api/admin/platform/source-connections/{name}/syncSync
POST/api/admin/platform/source-connections/{name}/testTest
GET/api/admin/platform/storageStorage
POST/api/admin/platform/storage/testStorage Test
GET/api/admin/platform/webhooksWebhooks
POST/api/admin/platform/webhooksAdd Webhook
DELETE/api/admin/platform/webhooks/{wid}Remove Webhook
POST/api/admin/platform/webhooks/{wid}/testTest Webhook
GET/api/admin/rolesRoles
POST/api/admin/service-accountsService Account
POST/api/admin/setup/sampleSetup Sample
POST/api/admin/setup/sample/dataSetup Sample Data
DELETE/api/admin/setup/sample/dataSetup Sample Remove
POST/api/admin/setup/sample/deploySetup Sample Deploy
GET/api/admin/skillsList
POST/api/admin/skillsAdd
POST/api/admin/skills/draftDraft skill
PUT/api/admin/skills/{name}Save
DELETE/api/admin/skills/{name}Remove
POST/api/admin/skills/{name}/evalEval
POST/api/admin/skills/{name}/tryTry draft
GET/api/admin/teams/leadsTeam Leads
POST/api/admin/teams/leadsSet Lead
DELETE/api/admin/teams/leadsUnset Lead
GET/api/admin/toolsTools
PATCH/api/admin/tools/{id}Edit tool
POST/api/admin/tools/{id}/tryTry tool
GET/api/admin/usageUsage Report
GET/api/admin/usage/activityUsage Activity
PUT/api/admin/usage/cohortUsage Cohort
GET/api/admin/usersUsers
GET/api/admin/users/{uid}User
POST/api/admin/users/{uid}/api-keysIssue Key
DELETE/api/admin/users/{uid}/api-keys/{kid}Revoke Key
POST/api/admin/users/{uid}/api-keys/{kid}/rotateRotate Key
GET/api/admin/users/{uid}/credentialsCredentials
PUT/api/admin/users/{uid}/expiryExpiry
POST/api/admin/users/{uid}/markingsGrant
DELETE/api/admin/users/{uid}/markings/{marking}Ungrant
POST/api/admin/users/{uid}/reactivateReactivate
POST/api/admin/users/{uid}/revoke-allRevoke All
DELETE/api/admin/users/{uid}/sessions/{sid}Revoke Session
POST/api/admin/users/{uid}/suspendSuspend
POST/api/auth/break-glassBreak Glass
POST/api/auth/break-glass/resetBreak Glass Reset
POST/api/auth/break-glass/webauthn/optionsBreak Glass Webauthn Options
POST/api/auth/break-glass/webauthn/registerWebauthn Register
POST/api/auth/break-glass/webauthn/register/optionsWebauthn Register Options
GET/api/auth/callbackCallback
GET/api/auth/devDev Sign In
GET/api/auth/dev/personasDev Personas
GET/api/auth/loginLogin
POST/api/auth/logoutLogout
GET/api/auth/meMe
GET/api/auth/native/callbackNative Callback
POST/api/auth/native/exchangeNative Exchange
POST/api/auth/native/refreshNative Refresh
GET/api/auth/native/startNative Start
POST/api/auth/refreshRefresh
GET/api/auth/setupSetup Status
POST/api/auth/setup/adminSetup Admin
POST/api/auth/setup/finishSetup Finish
POST/api/auth/setup/mfaSetup Mfa
GET/api/auth/sso-test/callbackSso Test Callback
POST/api/chat/answerChat Answer
POST/api/chat/askChat Ask
GET/api/chat/collectionsCollections
POST/api/chat/collectionsCreate 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}/documentsCollection Documents
POST/api/chat/collections/{id}/documentsAdd Collection Document
DELETE/api/chat/collections/{id}/documents/{did}Remove Collection Document
POST/api/chat/collections/{id}/proposePropose Collection
GET/api/chat/conversationsConversations
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}/holdLegal Hold
POST/api/chat/conversations/{cid}/shareShare
DELETE/api/chat/conversations/{cid}/shareUnshare
POST/api/chat/conversations/{cid}/uploadsUpload
GET/api/chat/conversations/{cid}/uploads/{uid}Upload state
GET/api/chat/dataData
POST/api/chat/data/explainData explain
POST/api/chat/data/exportData export
GET/api/chat/data/historyData history
POST/api/chat/data/queryData query
GET/api/chat/data/sampleData sample
GET/api/chat/data/savedData saved
POST/api/chat/data/savedData 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}/draftData draft
GET/api/chat/feedbackSteward Feedback
GET/api/chat/getting-startedGetting Started
POST/api/chat/getting-startedMark Getting Started
GET/api/chat/lineageLineage
DELETE/api/chat/messages/{mid}Delete message
GET/api/chat/messages/{mid}/debugMessage debug
POST/api/chat/messages/{mid}/feedbackFeedback
POST/api/chat/messages/{mid}/restoreRestore message
GET/api/chat/messages/{mid}/traceMessage trace
GET/api/chat/objects/{oid}Object Card
POST/api/chat/revealReveal
GET/api/chat/scopesChat Scopes
POST/api/chat/sets/exportSet Export
POST/api/chat/sets/querySet Query
POST/api/chat/sets/saveSet Save
GET/api/chat/shared/{token}Shared
POST/api/chat/streamChat Stream
GET/api/deploy/aliasesAlias List
POST/api/deploy/deploymentsCreate
GET/api/deploy/deploymentsListing
POST/api/deploy/deployments/previewPreview
GET/api/deploy/deployments/{name}One
POST/api/deploy/deployments/{name}/advanceAdvance
POST/api/deploy/deployments/{name}/approveApprove
POST/api/deploy/deployments/{name}/overrideOverride
POST/api/deploy/deployments/{name}/retireRetire
POST/api/deploy/deployments/{name}/rollbackRollback
GET/api/deploy/disableDisabled
POST/api/deploy/disableDisable Ref
DELETE/api/deploy/disable/{ref}Clear
POST/api/deploy/evaluationsEvaluate
GET/api/deploy/platformPlatform
GET/api/deploy/scorecards/{kind}/{sid}Scorecard
GET/api/deploy/statusStatus
GET/api/designer/codesList Codes
GET/api/designer/codes/{code}Get Code
GET/api/designer/drift/reviewDrift Review Queue
POST/api/designer/drift/review/trialDrift Review Trial
POST/api/designer/drift/review/{id}/labelDrift Review Label
POST/api/designer/extraction-profile/previewPreview Extraction Profile
PUT/api/designer/layoutPut Layout
GET/api/designer/mapGet Map
GET/api/designer/packageGet Package
POST/api/designer/renamePost Rename
GET/api/designer/resourcesList 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/schemaGet Schema
GET/api/designer/usage/{element}Get Usage
POST/api/designer/validateValidate Unsaved
POST/api/designer/view-asView As
POST/api/desktop/askDesktop Ask
POST/api/desktop/cross-checkCross Check
POST/api/desktop/decideDecide
PUT/api/desktop/denylistPut Denylist
GET/api/desktop/enrolmentEnrolment
PUT/api/desktop/enrolmentEnrol
DELETE/api/desktop/enrolmentUnenrol
GET/api/desktop/explainExplain
GET/api/desktop/extraction-profileExtraction Profile
GET/api/desktop/fleetFleet
POST/api/desktop/fleet/switchSwitch Off
POST/api/desktop/fleet/switch/clearSwitch On
POST/api/desktop/heartbeatHeartbeat
GET/api/desktop/objects/{ref}Desktop Object
GET/api/desktop/packPack
GET/api/desktop/pack-keyPack Key
POST/api/desktop/recogniseRecognise
POST/api/dev/documentsDev Documents
POST/api/dev/documents/fileDev Document File
POST/api/dev/objectsDev Objects
GET/api/documents/{did}Document
GET/api/documents/{did}/blocksDocument Blocks
GET/api/documents/{did}/chunksDocument Chunks
GET/api/documents/{did}/viewDocument View
GET/api/eventsStream
POST/api/fixFix
GET/api/governance/compareCompare Versions
GET/api/governance/delegatesList Delegates
POST/api/governance/delegatesAdd Delegate
GET/api/governance/inboxGet Inbox
POST/api/governance/inbox/accept-bulkAccept Bulk
POST/api/governance/inbox/merge-candidates/{cid}Decide Candidate
POST/api/governance/inbox/merge-candidates/{cid}/undoUndo Candidate
POST/api/governance/inbox/{item}/acceptAccept
POST/api/governance/inbox/{item}/rejectReject
POST/api/governance/intakeIntake
GET/api/governance/intake/rejectedRejected
GET/api/governance/proposalsList Proposals
POST/api/governance/proposalsCreate Proposal
GET/api/governance/proposals/{name}Get Proposal
POST/api/governance/proposals/{name}/approveApprove
POST/api/governance/proposals/{name}/closeClose Proposal
GET/api/governance/proposals/{name}/commentsList Comments
POST/api/governance/proposals/{name}/commentsAdd Comment
POST/api/governance/proposals/{name}/comments/{cid}/resolveResolve Comment
POST/api/governance/proposals/{name}/mergeMerge
POST/api/governance/proposals/{name}/resolveResolve Conflict
POST/api/governance/publishPublish
GET/api/governance/versionsList Versions
GET/api/governance/versions/{version}Get Version
GET/api/healthHealth
GET/api/health/indicatorsIndicators
GET/api/mcpMcp Stream
POST/api/mcpMcp
GET/api/memoryList
DELETE/api/memoryWipe where
GET/api/memory/mapMap
GET/api/memory/recordsKnowledge
GET/api/memory/records/countKnowledge Count
GET/api/memory/summarySummary
GET/api/memory/{id}Item
PATCH/api/memory/{id}Edit
DELETE/api/memory/{id}Wipe one
GET/api/mining/corpusCorpus
POST/api/mining/extractExtract
POST/api/mining/keysKeys
GET/api/mining/ontologyOntology
POST/api/mining/runsOpen Run
GET/api/mining/runsList Runs
POST/api/mining/runs/claimClaim run
POST/api/mining/runs/requestRequest run
PATCH/api/mining/runs/{rid}Patch Run
GET/api/mining/runs/{rid}Get Run
POST/api/mining/runs/{rid}/candidatesReport
POST/api/mining/runs/{rid}/sendSend
GET/api/mining/structureStructure
GET/api/notificationsListing
PUT/api/notifications/mutes/{source}Mute Source
DELETE/api/notifications/mutes/{source}Unmute Source
GET/api/notifications/preferencesPreferences
PUT/api/notifications/preferences/{kind}Set Preference
POST/api/notifications/read-allRead All
POST/api/notifications/{nid}/readRead One
GET/api/oauth/authorizeAuthorize
GET/api/oauth/clientsClients
POST/api/oauth/clientsApprove
DELETE/api/oauth/clients/{client_id}Revoke Client
POST/api/oauth/revokeRevoke
POST/api/oauth/tokenToken
POST/api/outcomesRecord Outcome
POST/api/packages/exportExport
POST/api/packages/importImport
GET/api/packages/keysList Keys
POST/api/packages/keysCreate Key
POST/api/packages/keys/{kid}/revokeRevoke Key
POST/api/packages/keys/{kid}/rotateRotate Key
POST/api/packages/trustTrust
POST/api/retrieval/playgroundRetrieval Playground
GET/api/scim/v2/GroupsList Groups
POST/api/scim/v2/GroupsCreate 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/UsersList Users
POST/api/scim/v2/UsersCreate 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/searchSearch
GET/api/security/auditAudit Search
GET/api/security/audit/exportAudit Export
GET/api/security/audit/verifyAudit Verify
POST/api/security/audit/{rid}/payloadAudit Payload
GET/api/security/chatsSecurity Chats
DELETE/api/security/chats/{cid}Erase Chat
POST/api/security/chats/{cid}/openOpen Security Chat
POST/api/security/explainExplain
GET/api/security/freshnessFreshness
POST/api/security/grantsGrant
GET/api/security/grantsGrants
POST/api/security/grants/{gid}/revokeRevoke
GET/api/security/policiesPolicies
POST/api/security/requestsRequest Access
GET/api/security/requestsRequests
POST/api/security/requests/{rid}/decideDecide
GET/api/security/segmentsSegments
POST/api/security/sources/{name}/resyncResync
GET/api/security/subjectsSubjects
POST/api/security/testsSave Test
POST/api/security/view-asView As
GET/api/served/packageServed Package
POST/api/sources/{name}/aclsAcls
POST/api/sources/{name}/deletesDeletes
POST/api/sources/{name}/documentsSource Document
GET/api/sources/{name}/documentsSource Documents
POST/api/sources/{name}/statusReport
POST/api/v1/actions/{qname}Api Action
POST/api/v1/askApi 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.jsonApi Openapi
GET/api/v1/packageApi Package
GET/api/v1/views/{qname}Api View
POST/api/validateValidate
GET/api/workspaceWorkspace
PUT/api/workspaceChoose
The RenewContract action's request schema, then a call that renews one contract.
The RenewContract action's request schema, then a call that renews one contract.