Workflow

Get Workflow Status

Changed on

Get status of workflow job by job ID

get/api/v2/workflows

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Query parameters

string
OR
string uuid

Response

Workflow status response

created_timestampstring
flow_idstring required
globalsobject
human_requestobject nullable

Set when status is suspended: the human-input request the run paused on (prompt, options, allowed_decisions, request_id). Resume by running the same session/task again with the chosen decision.

inputsobject
object'response'
outputsobject
session_idstring nullable

The session the run executed under. Echoes the request session_id when provided, otherwise the server-generated one. Pass it back on the next call to continue the same chat history / memory thread.

status'queued' | 'in_progress' | 'completed' | 'failed' | 'cancelled' | 'timed_out' | 'suspended' required

Job execution status.

warningsstring[]

Non-fatal notices about this run, such as saved component code being replaced by server code.

Changes

  • 4349fbe90c64Revision changes
    • info

      added the optional property to the response with the status

  • 22962dc5e81bRevision changes
    • breaking

      the // response's property type changed from no type to string for status

    • warning

      added the new cancelled enum value to the // response property for the response status

    • warning

      added the new completed enum value to the // response property for the response status

    • warning

      added the new failed enum value to the // response property for the response status

    • warning

      added the new in_progress enum value to the // response property for the response status

    • warning

      added the new queued enum value to the // response property for the response status

    • warning

      added the new suspended enum value to the // response property for the response status

    • warning

      added the new suspended enum value to the response property for the response status

    • warning

      added the new timed_out enum value to the // response property for the response status

    • info

      the endpoint scheme security OAuth2PasswordBearerCookie was added to the API

    • 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