List Runs

One page of a graph’s instances, newest first. Keyset paged: a graph gains runs at the head while somebody is reading, which is where an offset repeats or skips rows.

task narrows to one task’s instances. tasks comes back unnarrowed either way — they are the filter’s options, and one that dropped every option but the chosen one locks behind you.

GET/api/v1/graphs/{graph_id}/runs

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Path parameters

graph_idstringrequired

Query parameters

limitinteger

min 1 · max 100 · default: 20

afterstring | any

The `next_cursor` of the page before this one

taskstring | any

Only the instances forked for this task

Responses

200Successful Response

successboolean

default: true

dataRunsList | any

Show properties

Any of:

RunsList

runsGraphRun[]required

Show properties

Array of GraphRun

idstring

graph_idstring | any

Show properties

Any of:

string

string

any

any

definitionobject

ui_stateobject

statusRunStatus

Allowed:draftqueuedrunningawaiting_inputsucceededfailedcancelled

nodesobject

errorstring | any

Show properties

Any of:

string

string

any

any

targetsstring[]

credits_consumednumber

default: 0

credits_totalnumber

default: 0

cancel_requestedboolean

default: false

cancel_requested_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

answersobject

pending_inputPendingInput | any

Show properties

Any of:

PendingInput

node_idstringrequired

item_indexinteger | any

Show properties

Any of:

integer

integer

any

any

item_countinteger | any

Show properties

Any of:

integer

integer

any

any

requestobject

any

any

regeneratestring[]

seed_run_idstring | any

Show properties

Any of:

string

string

any

any

pinned_task_idstring | any

Show properties

Any of:

string

string

any

any

forked_signaturestring

default: ""

editedboolean

default: false

copied_fromstring | any

Show properties

Any of:

string

string

any

any

exported_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

exported_creativesstring[]

produced_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

generationinteger

default: 0

task_idstring | any

Show properties

Any of:

string

string

any

any

owner_idstringrequired

created_atstring<date-time>

updated_atstring<date-time>

started_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

finished_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

heartbeat_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

deleted_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

tasksobject

next_cursorstring | any

Show properties

Any of:

string

string

any

any

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/graphs/string/runs" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/graphs/string/runs", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/graphs/string/runs",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "runs": [
      {
        "id": "string",
        "graph_id": "string",
        "definition": {},
        "ui_state": {},
        "status": "draft",
        "nodes": {
          "property1": {
            "status": "pending",
            "progress": 0,
            "outputs": {},
            "error": "string",
            "message": "string",
            "credits_consumed": 0,
            "duration_seconds": 0,
            "checkpoint": {},
            "items": {
              "property1": {
                "status": "pending",
                "progress": 0,
                "outputs": {},
                "error": "string",
                "message": "string",
                "credits_consumed": 0,
                "duration_seconds": 0,
                "checkpoint": {}
              },
              "property2": {
                "status": "pending",
                "progress": 0,
                "outputs": {},
                "error": "string",
                "message": "string",
                "credits_consumed": 0,
                "duration_seconds": 0,
                "checkpoint": {}
              }
            },
            "started_at": "2019-08-24T14:15:22Z"
          },
          "property2": {
            "status": "pending",
            "progress": 0,
            "outputs": {},
            "error": "string",
            "message": "string",
            "credits_consumed": 0,
            "duration_seconds": 0,
            "checkpoint": {},
            "items": {
              "property1": {
                "status": "pending",
                "progress": 0,
                "outputs": {},
                "error": "string",
                "message": "string",
                "credits_consumed": 0,
                "duration_seconds": 0,
                "checkpoint": {}
              },
              "property2": {
                "status": "pending",
                "progress": 0,
                "outputs": {},
                "error": "string",
                "message": "string",
                "credits_consumed": 0,
                "duration_seconds": 0,
                "checkpoint": {}
              }
            },
            "started_at": "2019-08-24T14:15:22Z"
          }
        },
        "error": "string",
        "targets": [
          "string"
        ],
        "credits_consumed": 0,
        "credits_total": 0,
        "cancel_requested": false,
        "cancel_requested_at": "2019-08-24T14:15:22Z",
        "answers": {},
        "pending_input": {
          "node_id": "string",
          "item_index": 0,
          "item_count": 0,
          "request": {}
        },
        "regenerate": [
          "string"
        ],
        "seed_run_id": "string",
        "pinned_task_id": "string",
        "forked_signature": "",
        "edited": false,
        "copied_from": "string",
        "exported_at": "2019-08-24T14:15:22Z",
        "exported_creatives": [
          "string"
        ],
        "produced_at": "2019-08-24T14:15:22Z",
        "generation": 0,
        "task_id": "string",
        "owner_id": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "started_at": "2019-08-24T14:15:22Z",
        "finished_at": "2019-08-24T14:15:22Z",
        "heartbeat_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z"
      }
    ],
    "tasks": {
      "property1": "string",
      "property2": "string"
    },
    "next_cursor": "string"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}