Deploy Workflow

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

Authorization

apiKey
X-API-Key<token>

Your Sim API key (personal or workspace). Generate one from the Sim dashboard under Settings > API Keys.

In: header

Path Parameters

id*string

The unique workflow identifier.

Request Body

application/json

Optional metadata for the new deployment version. The request body may be omitted entirely.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST \  "https://www.sim.ai/api/v1/workflows/{id}/deploy" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{"name": "Release 4", "description": "Fixes the agent prompt"}'
{
  "data": {
    "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
    "isDeployed": true,
    "deployedAt": "2026-06-12T10:30:00Z",
    "version": 4,
    "warnings": []
  }
}
{
  "error": "string",
  "details": [
    {}
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}