API
API changes
See the lifecycle and baseline history of every operation in the current customer contract.
Current contract baseline
This OpenAPI 3.2.0 customer contract is tied to source digest 8c568bec762d5d5568af9f763ae9a39eb50c6d820f83e8fb1f0273b7dae773b7. It contains 96 operations. 3 are Stable and 93 are Preview.
Preview operations may change. Saving this contract does not turn a Preview operation into a Stable compatibility commitment.
| Operation | Status | History |
|---|---|---|
POST /api/authorization/check-access | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/authorization/effective-access | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/case-events | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/case-types | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/case-types | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/case-types/import/cmmn | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/case-types/import/cmmn/preview | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/case-types/{caseTypeId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/case-types/{caseTypeId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PATCH /api/case-types/{caseTypeId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PUT /api/case-types/{caseTypeId}/draft | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/case-types/{caseTypeId}/export/cmmn | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/case-types/{caseTypeId}/publish | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/case-types/{caseTypeId}/validate | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/case-types/{caseTypeId}/versions | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/chat | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/connections | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/connections | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/connections/options | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/connections/{id} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/connections/{id} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PATCH /api/connections/{id} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/connections/{id}/test | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/embeddings | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/model-providers/connections | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/model-providers/connections | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/model-providers/connections/{connectionId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/model-providers/connections/{connectionId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PATCH /api/model-providers/connections/{connectionId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/model-providers/connections/{connectionId}/deployments | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/model-providers/connections/{connectionId}/models | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/model-providers/connections/{connectionId}/models/discover | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/model-providers/connections/{connectionId}/models/import | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/model-providers/connections/{connectionId}/test | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/model-providers/deployments | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/model-providers/deployments/sync-local | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/model-providers/deployments/{deploymentId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/model-providers/deployments/{deploymentId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PATCH /api/model-providers/deployments/{deploymentId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PUT /api/model-providers/deployments/{deploymentId}/memory | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PUT /api/model-providers/deployments/{deploymentId}/preload | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/model-providers/deployments/{deploymentId}/refresh-revision | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/model-providers/types | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/models | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/vector-databases | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/vector-databases | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/vector-databases/address-availability | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/vector-databases/embedding-models | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/vector-databases/ingestion-jobs | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/vector-databases/ingestion-jobs/{jobId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/vector-databases/ingestion-jobs/{jobId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/vector-databases/ingestion-jobs/{jobId}/servers | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/vector-databases/methodologies | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/vector-databases/upload-policy | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/vector-databases/{name} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PATCH /api/vector-databases/{name} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/vector-databases/{name}/files | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/vector-databases/{name}/files | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/vector-databases/{name}/files/{fileId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PATCH /api/vector-databases/{name}/files/{fileId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/vector-databases/{name}/query | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/workflows | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/bpmn/conformance | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/bpmn/conformance/report | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/bpmn/profiles/common-executable | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/dmn/conformance | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/dmn/conformance/report | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/protection/catalog | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/workflows/transform/preview | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/workflows/{workflowId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PATCH /api/workflows/{workflowId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/dmn/logic | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PUT /api/workflows/{workflowId}/dmn/logic | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PUT /api/workflows/{workflowId}/draft | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/export/bpel | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/export/bpmn | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/export/dmn | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/import-source | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/workflows/{workflowId}/publish | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/runs | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/workflows/{workflowId}/runs | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/workflows/{workflowId}/runs/{runId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/runs/{runId} | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/workflows/{workflowId}/runs/{runId}/decision | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/runs/{runId}/events | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/runs/{runId}/events/stream | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/workflows/{workflowId}/runs/{runId}/human-tasks/{nodeId}/complete | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
DELETE /api/workflows/{workflowId}/star | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
PUT /api/workflows/{workflowId}/star | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
POST /api/workflows/{workflowId}/validate | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /api/workflows/{workflowId}/versions | Preview | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /health | Stable | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /health/live | Stable | Next Product release: Operation documented from the current registered Go route and handler contract. |
GET /health/ready | Stable | Next Product release: Operation documented from the current registered Go route and handler contract. |
Was this page helpful?
Your answer helps us improve the documentation.
Do not include personal information, customer information, passwords, or keys.