Sign in

v13

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-015232292.9 KB
Workflows

Deploy Workflow

Deploy the workflow's current draft state. Creates a new deployment version, makes it live for API execution, and activates any schedules and triggers. Optionally accepts a name and description for the new version. Requires admin permission on the workflow's workspace. Returns 404 when the workflow does not exist or you do not have access to it.

post/api/v1/workflows/{id}/deploy

Path parameters

idstring required
Example:3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36

The unique workflow identifier.

Request body

namestring

Optional label for the new deployment version.

descriptionstring nullable

Optional summary of what changed in this version.

Example request

{
  "name": "Release 4",
  "description": "Fixes the agent prompt"
}

Response

Workflow deployed successfully.

Example response

{
  "data": {
    "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
    "isDeployed": true,
    "deployedAt": "2026-06-12T10:30:00Z",
    "version": 4
  },
  "limits": {
    "workflowExecutionRateLimit": {
      "sync": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      },
      "async": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      }
    },
    "usage": {
      "currentPeriodCost": 1.25,
      "limit": 50,
      "plan": "pro"
    }
  }
}