| Field | Type | Required | Description |
|---|---|---|---|
id |
str | ✔️ | Unique identifier of the workflow |
name |
str | ✔️ | Name of the workflow |
display_name |
str | ✔️ | Display name of the workflow |
type |
models.WorkflowType | ✔️ | N/A |
description |
OptionalNullable[str] | ➖ | Description of the workflow |
customer_id |
str | ✔️ | Customer ID of the workflow |
workspace_id |
str | ✔️ | Workspace ID of the workflow |
shared_namespace |
OptionalNullable[str] | ➖ | Reserved namespace for shared workflows (e.g., 'shared:my-shared-workflow') |
available_in_chat_assistant |
Optional[bool] | ➖ | Whether the workflow is available in chat assistant |
is_technical |
Optional[bool] | ➖ | Whether the workflow is technical (e.g. SDK-managed) |
on_behalf_of |
Optional[bool] | ➖ | Whether the workflow must run associated to a user's identity |
archived |
Optional[bool] | ➖ | Whether the workflow is archived |
active |
bool | ✔️ | Whether the workflow is active |