Skip to content
Kumquat
Esc
↑↓navigate↵open⌘Jpreview

Restart Run

Execute this instance again — or, once it has exported, the same graph as an instance of its own.

Re-queued in place while nothing relies on it: a document per attempt would turn a board somebody is iterating on into a pile of near-identical versions. Once it has put a file on a card, clearing its states would rewrite the record of what made that file, so it forks instead — and the node cache means the fork re-pays only what it re-rolls.

A re-roll may take over a run parked on a gate: that run has no worker, and asking for another of the options the gate is offering is what the button on them is for. It supersedes the question, which the replay asks again over what the re-roll produced.

POST/api/v1/runs/{run_id}/start
Authorization
AuthorizationBearer token · headerrequired
or
AuthorizationOAuth2 access token · headerrequired
Path parameters
run_idstringrequired
Request body
application/json
Any of:
RunStart
targetsstring[]
from_runstring | any
Show properties
Any of:
string
string
any
any
regenerateInvocation[]
Show properties
Array of Invocation
node_idstringrequired
min length 1
iteminteger | any
Show properties
Any of:
integer
integer
any
any
executeboolean
default: true
any
any
Responses
200Successful Response
successboolean
default: true
dataGraphRun | any
Show properties
Any 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
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 POST "/api/v1/runs/string/start" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "targets": [
    "string"
  ],
  "from_run": "string",
  "regenerate": [
    {
      "node_id": "string",
      "item": 0
    }
  ],
  "execute": true
}'
Response
{
  "success": true,
  "data": {
    "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"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}