Workflow
June 16, 2026 ยท View on GitHub
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | str | :heavy_check_mark: | Unique identifier of the workflow |
name | str | :heavy_check_mark: | Name of the workflow |
display_name | str | :heavy_check_mark: | Display name of the workflow |
type | models.WorkflowType | :heavy_check_mark: | N/A |
description | OptionalNullable[str] | :heavy_minus_sign: | Description of the workflow |
customer_id | str | :heavy_check_mark: | Customer ID of the workflow |
workspace_id | str | :heavy_check_mark: | Workspace ID of the workflow |
shared_namespace | OptionalNullable[str] | :heavy_minus_sign: | Reserved namespace for shared workflows (e.g., 'shared:my-shared-workflow') |
available_in_chat_assistant | Optional[bool] | :heavy_minus_sign: | Whether the workflow is available in chat assistant |
is_technical | Optional[bool] | :heavy_minus_sign: | Whether the workflow is technical (e.g. SDK-managed) |
archived | Optional[bool] | :heavy_minus_sign: | Whether the workflow is archived |
tags | List[str] | :heavy_minus_sign: | Tags for filtering and discovery |