Import Workflow

POST/api/v1/workflows/import

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

Request Body

application/json

The target workspace and the workflow payload to import.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST \  "https://www.sim.ai/api/v1/workflows/import" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{"workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64", "workflow": {"version": "1.0", "state": {"blocks": {}, "edges": []}}}'
{
  "data": {
    "id": "7d2e9f14-3a6b-4c8d-b1e5-9f0a2c7d4e83",
    "name": "Customer Support Agent (1)",
    "description": "Routes incoming support tickets",
    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
    "folderId": null,
    "createdAt": "2026-06-20T14:15:22Z",
    "updatedAt": "2026-06-20T14:15:22Z"
  }
}
{
  "error": "string",
  "details": [
    {}
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "Request body exceeds the maximum allowed size"
}
{
  "error": "Folder is locked"
}
{
  "error": "string"
}