Get Workflow Chat Deployment

Read the hosted chat a workflow is published as. Answers 404 when the workflow publishes no chat. Not to be confused with /workflows/{workflowId}/deployment (singular), which is the workflow's own API deployment — its live version and whether the draft has drifted. That path governs whether the workflow is executable at all; this one governs the hosted chat it is served on. The chat is a singleton of its workflow, so it has no id of its own in any path and no separate create verb: PUT is create-or-replace and is the only write. The stored password is never returned — hasPassword reports only whether one is set. This carries the visitor gate — authType, hasPassword, and the allowedEmails allow-list — so it requires workspace admin, unlike the workspace-wide list. A workspace API key is rejected with 403; use a personal API key.

GET/api/v2/workflows/{workflowId}/deployments/chat

Authorization

apiKey
X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

workflowId*string

Unique workflow identifier.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/deployments/chat" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "id": "chat_01J8ZK3QW4M6X2R9T7B5C0V2",
    "workflowId": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
    "workspaceId": "9f4c2a10-3b7e-4d58-8f6a-2c1d0e5b7a94",
    "identifier": "support",
    "url": "https://sim.ai/chat/support",
    "title": "Support chat",
    "description": "Ask about billing, onboarding, or outages.",
    "isActive": true,
    "authType": "public",
    "hasPassword": false,
    "allowedEmails": [],
    "customizations": {
      "primaryColor": "#6F3DFA",
      "welcomeMessage": "Hi there! How can I help?"
    },
    "outputConfigs": [
      {
        "blockId": "block_01J8ZK3QW4M6X2R9T7B5C0V4",
        "path": "content"
      }
    ],
    "includeThinking": false,
    "includeToolCalls": false,
    "createdAt": "2026-06-12T10:30:00.000Z",
    "updatedAt": "2026-06-12T10:30:00.000Z"
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}