MImistral
workflows.runs

List Runs

Changed on

List Runs

get/v1/workflows/runs

Request

Query parameters

workflow_identifierstring nullable

Filter by workflow name or id

root_execution_idstring nullable

Filter by root execution id; returns the whole execution tree (the root and all its descendant sub-workflows).

searchstring nullable

Search by workflow name, display name, or ID

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

Filter by deployment name

sort_by'start_time' | 'end_time' nullable

Field to sort by

order'asc' | 'desc'

Sort direction

start_time_afterstring date-time nullable

Include runs with start_time >= value

start_time_beforestring date-time nullable

Include runs with start_time <= value

end_time_afterstring date-time nullable

Include runs with end_time >= value. Running executions (no end_time) are excluded; use the status filter to include them.

end_time_beforestring date-time nullable

Include runs with end_time <= value. Running executions (no end_time) are excluded; use the status filter to include them.

user_idstring nullable

Filter by user id. Use 'current' to filter by the authenticated user

workflow_tagsstring[] nullable

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

include_internalboolean

Include runs of internal/technical workflows (e.g. parallel-execution)

page_sizeinteger

Number of items per page

next_page_tokenstring nullable

Token for the next page of results

search_keystring[] nullable

Filter executions by search key as repeated entries (max 3, AND'd together). 'key:value' matches a similar value, 'key==:value' matches the exact value, a bare 'key' matches executions that have the key set at all, and 'key==' matches executions whose value for the key is null.

Response

Successful Response

next_page_tokenstring nullable

Token to use for fetching the next page of results. Null if this is the last page.

Changes

  • 933c4ebdcd72Revision changes
    • info

      added the new optional query request parameter search_key

    • info

      added the new optional query request parameter workflow_tags

  • 5a5c361558bbRevision changes
    • info

      api tag workflows.runs added

    • info

      api tag beta.workflows.runs removed

    • info

      added the new optional query request parameter deployment_name

    • info

      added the new optional query request parameter end_time_after

    • info

      added the new optional query request parameter end_time_before

    • info

      added the new optional query request parameter include_internal

    • info

      added the new optional query request parameter order

    • info

      added the new optional query request parameter root_execution_id

    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter start_time_after

    • info

      added the new optional query request parameter start_time_before

    • info

      added the new optional query request parameter user_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status