API
API reference
Choose a Product API category, then open the operation needed for your task.
Customer API reference
Choose a category
The categories below come from the Product customer OpenAPI contract in the same order as Swagger. Choose the domain for your task, then open one operation for its fields, examples, access rules, and errors.
Read the API overview if you are starting a new integration.
Access and identity
2 operationsSign in, manage sessions and invitations, check permissions, and work with identity providers.
Browse Access and identityWorkflows and runs
32 operationsBuild, publish, and run workflows, complete human tasks, and monitor workflow events.
Browse Workflows and runsCases and case types
13 operationsDefine case types and manage cases, plan items, files, and lifecycle work.
Browse Cases and case typesModels and inference
22 operationsDiscover and configure models, run chat and embeddings, and work with model providers.
Browse Models and inferenceKnowledge and documents
17 operationsManage knowledge stores, documents, ingestion, extraction, and semantic search.
Browse Knowledge and documentsConnections and storage
7 operationsConfigure the connections and storage destinations used by workflows and integrations.
Browse Connections and storageHealth and observability
3 operationsCheck service health, review audit activity, inspect logs, and investigate operational events.
Browse Health and observabilityWas this page helpful?
Your answer helps us improve the documentation.
Do not include personal information, customer information, passwords, or keys.