MImistral
workflows

Get Workflows

Changed on

Get Workflows

get/v1/workflows

Request

Query parameters

'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' | 'TERMINATED' | 'CONTINUED_AS_NEW' | 'TIMED_OUT' | 'RETRYING_AFTER_ERROR'
OR
WorkflowExecutionStatus[]
include_sharedboolean

Whether to include shared workflows

available_in_chat_assistantboolean nullable

Whether to only return workflows available in chat assistant

deployment_namestring[] nullable

Filter by deployment name(s)

deployment_status'active' | 'inactive' nullable

Filter by deployment activity. active=only active, inactive=only inactive, None=no filter

archivedboolean nullable

Filter by archived state. False=exclude archived, True=only archived, None=include all

tagsstring[] nullable

Filter to workflows tagged with all listed tags (AND).

sort_by'display_name' nullable

Field to sort by

order'asc' | 'desc'

Sort direction

cursorstring nullable

The cursor for pagination

limitinteger

The maximum number of workflows to return

active_onlyboolean

Deprecated: use deployment_status instead

searchstring nullable

Fuzzy search query for workflow name, display name, description, or ID

Response

Successful Response

next_cursorstring nullable required

Changes