Tasks

List task runs

Changed on

List all runs for a task with cursor-based pagination.

<Note>This endpoint is in beta, read more here.</Note>

get/v2/tasks/{task_id}/runs

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/tasks/{task_id}/runs
  • Auth
    HTTP bearer

Path parameters

task_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique task identifier (base64)

Query parameters

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED'

Status of a task run.

  • PENDING - The run has been created but not yet started.
  • RUNNING - The run is currently in progress.
  • COMPLETED - The run finished successfully.
  • FAILED - The run encountered an error and stopped.
  • CANCELLED - The run was cancelled before completion.

Filter by run status: PENDING, RUNNING, COMPLETED, FAILED, CANCELLED

limitinteger

Maximum items to return. Defaults to 50 if omitted; maximum is 100.

cursorstring

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

Response

Returns a list of task run objects

Changes

  • 4f94eb2fd1abRevision changes
    • breaking

      removed the enum value cancelled from the query request parameter status

    • breaking

      removed the enum value completed from the query request parameter status

    • breaking

      removed the enum value failed from the query request parameter status

    • breaking

      removed the enum value pending from the query request parameter status

    • breaking

      removed the enum value running from the query request parameter 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 PENDING enum value to the // response property for the response status

    • warning

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

    • info

      api operation id tasks_list_runs removed and replaced with list_task_runs

    • info

      added the new enum value CANCELLED to the query request parameter status

    • info

      added the new enum value COMPLETED to the query request parameter status

    • info

      added the new enum value FAILED to the query request parameter status

    • info

      added the new enum value PENDING to the query request parameter status

    • info

      added the new enum value RUNNING to the query request parameter status

    • info

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

    • info

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

    • info

      removed the cancelled enum value from the // response property for the response status

    • info

      removed the completed enum value from the // response property for the response status

    • info

      removed the failed enum value from the // response property for the response status

    • info

      removed the pending enum value from the // response property for the response status

    • info

      removed the running enum value from the // response property for the response status