MImistral
workflows.executions

Get Workflow Execution

Changed on

Get Workflow Execution

get/v1/workflows/executions/{execution_id}

Request

Path parameters

execution_idstring required

Query parameters

include_search_keysboolean

Include the execution's search keys (metadata) in the response.

Response

Successful Response

workflow_namestring required

The name of the workflow

workflow_idstring uuid nullable

The ID of the workflow

deployment_namestring nullable

The name of the deployment that ran this execution

execution_idstring required

The ID of the workflow execution

parent_execution_idstring nullable

The parent execution ID of the workflow execution

root_execution_idstring required

The root execution ID of the workflow execution

run_idstring nullable

The unique run identifier (database UUID)

user_idstring nullable

The ID of the user who triggered the execution

status'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' | 'TERMINATED' | 'CONTINUED_AS_NEW' | 'TIMED_OUT' | 'RETRYING_AFTER_ERROR' required
start_timestring date-time required

The start time of the workflow execution

end_timestring date-time nullable required

The end time of the workflow execution, if available

total_duration_msinteger nullable

The total duration of the trace in milliseconds

resultunknown required
search_keysobject nullable

The execution's search keys (metadata), if requested via include_search_keys.

Changes

  • fa73befe1c61Revision changes
    • info

      added the new optional query request parameter include_search_keys

    • info

      added the optional property to the response with the status

  • 5a5c361558bbRevision changes
    • info

      api tag workflows.executions added

    • info

      api tag beta.workflows.executions removed

    • 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