Skip to main content

Management API

Use these endpoints to manage agents, capabilities, and resources. All requests require the tenant-id header.

Agents

MethodEndpointDescription
GET/api/v1/agentsList agents (use ?include=stats for capability stats)
GET/api/v1/agents/:idGet agent by ID
GET/api/v1/agents/slug/:slugGet agent by slug
POST/api/v1/agentsCreate agent
PUT/api/v1/agents/:idUpdate agent
DELETE/api/v1/agents/:idDelete agent

Capabilities

MethodEndpointDescription
GET/api/v1/agents/:agentId/capabilitiesList capabilities for agent
POST/api/v1/agents/:agentId/capabilitiesCreate capability
GET/api/v1/capabilities/:idGet capability by ID
PUT/api/v1/capabilities/:idUpdate capability
DELETE/api/v1/capabilities/:idDelete capability
POST/api/v1/capabilities/validateValidate DSL
POST/api/v1/capabilities/:id/compileCompile capability
GET/api/v1/capabilities/:id/compiledGet compiled model

Integrations

MethodEndpointDescription
GET/api/v1/integrationsList integrations
GET/api/v1/integrations/activeList active integrations
GET/api/v1/integrations/:idGet integration
POST/api/v1/integrationsCreate integration
PUT/api/v1/integrations/:idUpdate integration
DELETE/api/v1/integrations/:idDelete integration
POST/api/v1/integrations/:id/testTest connection

Actions

MethodEndpointDescription
GET/api/v1/integrations/:integrationId/actionsList actions for integration
POST/api/v1/integrations/:integrationId/actionsCreate action
GET/api/v1/actions/:idGet action
PUT/api/v1/actions/:idUpdate action
DELETE/api/v1/actions/:idDelete action
POST/api/v1/actions/:id/testTest action (not implemented)

Datapoints

MethodEndpointDescription
GET/api/v1/datapointsList datapoints
GET/api/v1/datapoints/by-slugs?slugs=a,bFetch by slug list
GET/api/v1/datapoints/:idGet datapoint
POST/api/v1/datapointsCreate datapoint
PUT/api/v1/datapoints/:idUpdate datapoint
DELETE/api/v1/datapoints/:idDelete datapoint

Knowledge

MethodEndpointDescription
GET/api/v1/knowledge/collectionsList collections
GET/api/v1/knowledge/collections/:idGet collection
POST/api/v1/knowledge/collectionsCreate collection
PUT/api/v1/knowledge/collections/:idUpdate collection
DELETE/api/v1/knowledge/collections/:idDelete collection
GET/api/v1/knowledge/collections/:collectionId/documentsList documents
POST/api/v1/knowledge/collections/:collectionId/documentsUpload document (multipart)
GET/api/v1/knowledge/collections/:collectionId/documents/:idGet document
GET/api/v1/knowledge/collections/:collectionId/documents/:id/downloadDownload document
DELETE/api/v1/knowledge/collections/:collectionId/documents/:idDelete document
POST/api/v1/knowledge/searchSearch knowledge

Document uploads use multipart form data with fields name, slug, description, and metadata plus the file payload.

Conversations (Global)

MethodEndpointDescription
GET/api/v1/conversationsList conversations (current user)
GET/api/v1/conversations/:idGet conversation
GET/api/v1/conversations/:id/historyGet history