Skip to content

API Reference

DMOps.ai exposes a REST API built with FastAPI. The interactive reference below is generated from the OpenAPI spec. Use it to explore and try all endpoints.

Authentication

All endpoints require the X-API-Key header. See Authentication for how to get your key. Enter it via the Authenticate button in the reference below.


OpenAPI spec

The raw spec is available at /docs/openapi.json and at your live tenant: https://<tenant>.app.dmops.ai/openapi.json


Full endpoint reference (text version)

Use the interactive viewer above for the best experience. The table below is a quick text reference.

MethodPathDescription
GET/api/pingLiveness check
GET/api/statsReadiness / health check
GET/api/tasksList tasks
POST/api/tasksCreate a task
GET/api/tasks/{id}Get a task
PATCH/api/tasks/{id}Update a task
DELETE/api/tasks/{id}Delete a task
POST/api/tasks/{id}/transitionChange task status
GET/api/tasks/{id}/traceExecution trace
GET/api/agentsList org members
POST/api/agentsCreate agent definition
GET/api/agents/{id}Get org member
PATCH/api/agents/{id}Update agent definition
GET/api/inboxList inbox items
POST/api/inbox/{id}/approveApprove inbox item
POST/api/inbox/{id}/rejectReject inbox item
POST/api/inbox/{id}/replyReply to blocked item
GET/api/skillsList skills
POST/api/skillsCreate skill
GET/api/integrationsList integrations
POST/api/integrationsAdd integration
POST/api/integrations/{id}/testTest integration
GET/api/spendingCost breakdown
GET/api/execution-logsExecution logs
GET/api/auditAudit log