Get a task run

curl --request GET \
  --url https://api.cloud.wherobots.com/task-runs/{taskRunId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cloud.wherobots.com/task-runs/{taskRunId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloud.wherobots.com/task-runs/{taskRunId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "taskRunId": "<string>",
  "taskName": "<string>",
  "state": "PENDING",
  "region": "<string>",
  "submittedAt": "2023-11-07T05:31:56Z",
  "taskId": "<string>",
  "taskTriggerId": "<string>",
  "type": "uniontask",
  "runSource": "manual",
  "batchTime": "2023-11-07T05:31:56Z",
  "rerunOfId": "<string>",
  "batchKind": "tick",
  "windowStart": "2023-11-07T05:31:56Z",
  "windowEnd": "2023-11-07T05:31:56Z",
  "noComputeReason": "cancelled",
  "failureClass": "QUOTA_REJECTED",
  "runAsId": "<string>",
  "requestedById": "<string>",
  "workload": {
    "type": "uniontask",
    "jobRunId": "<string>",
    "kubeAppId": "<string>",
    "unionExecutionId": "<string>"
  },
  "cancelRequestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z",
  "durationSeconds": 123,
  "executionRequest": {},
  "name": "<string>",
  "inputs": {},
  "cached": false,
  "results": {},
  "errorMessage": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

API playground

Get a task run

Get a single task run by id, with its state projected from the execution.

A succeeded run also carries what it produced, read from the backend: its outputs by name, so a task returning one value reads as {"o0": ...}. Null where the run produced nothing, has not succeeded, or its outputs could not be read just now.

The state is synced from the backend periodically, so it can lag the run by up to 2 minutes: a run that has already finished may still read as RUNNING for that long. When polling for completion, allow for this delay.

404: no task run of this id the caller’s organization owns — the same answer whether it never existed or belongs to another organization.

GET

task-runs

{taskRunId}

Get a task run

curl --request GET \
  --url https://api.cloud.wherobots.com/task-runs/{taskRunId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cloud.wherobots.com/task-runs/{taskRunId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloud.wherobots.com/task-runs/{taskRunId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "taskRunId": "<string>",
  "taskName": "<string>",
  "state": "PENDING",
  "region": "<string>",
  "submittedAt": "2023-11-07T05:31:56Z",
  "taskId": "<string>",
  "taskTriggerId": "<string>",
  "type": "uniontask",
  "runSource": "manual",
  "batchTime": "2023-11-07T05:31:56Z",
  "rerunOfId": "<string>",
  "batchKind": "tick",
  "windowStart": "2023-11-07T05:31:56Z",
  "windowEnd": "2023-11-07T05:31:56Z",
  "noComputeReason": "cancelled",
  "failureClass": "QUOTA_REJECTED",
  "runAsId": "<string>",
  "requestedById": "<string>",
  "workload": {
    "type": "uniontask",
    "jobRunId": "<string>",
    "kubeAppId": "<string>",
    "unionExecutionId": "<string>"
  },
  "cancelRequestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z",
  "durationSeconds": 123,
  "executionRequest": {},
  "name": "<string>",
  "inputs": {},
  "cached": false,
  "results": {},
  "errorMessage": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

{
  "errors": [
    {
      "code": "BAD_REQUEST_ERROR",
      "message": "<string>",
      "details": "<string>",
      "path": "<string>",
      "suggestion": "Contact us at support@wherobots.com to get help with resolving your error.",
      "documentation_url": "<string>",
      "field": "<string>"
    }
  ],
  "requestId": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

taskRunId

string

required

The id of the task run.

Response

Successful Response

e.g. { "taskRunId": "npqy9q19q4wlm3", "taskName": "predict_mosaic_geometries_recipe", "state": "SUCCEEDED", "region": "aws-us-west-2", "submittedAt": "2026-06-04T18:00:00Z", "name": "College Park roofs, 2023", "inputs": { "aoi_uri": "s3://wherobots-examples/rasterflow/aois/collegepark.parquet", "start": "2023-01-01T00:00:00Z", "end": "2024-01-01T00:00:00Z", "model_recipe": "sam3-text-geometry", "text_prompt": ["roofs"], "confidence_threshold": 0.3, "target_crs": "EPSG:3857" }, "startedAt": "2026-06-04T18:01:10Z", "endedAt": null, "durationSeconds": 240, "cached": false, "results": {"o0": "s3://.../predictions.parquet"}, "errorMessage": null }

taskRunId

string

required

taskName

string

required

Current mutable Task display metadata, not historical identity.

state

enum<string>

required

Available options:

PENDING,

SUBMITTED,

RUNNING,

SUCCEEDED,

FAILED,

TIMED_OUT,

CANCELLING,

CANCELLED,

UNKNOWN,

SKIPPED,

MISSED,

REJECTED

region

string

required

submittedAt

string<date-time>

required

taskId

string | null

taskTriggerId

string | null

type

enum<string> | null

Concrete task polymorphic identities.

Available options:

uniontask,

scripttask

runSource

enum<string>

default:manual

Origin of a run, independent of its backend.

Available options:

manual,

schedule,

rerun

batchTime

string<date-time> | null

rerunOfId

string | null

The task run this one reran, when runSource is rerun. Null otherwise.

batchKind

enum<string> | null

What batchTime means: tick for a nominal schedule time, gap for a journal boundary such as a pause or schedule edit. Null when batchTime is null.

Available options:

tick,

gap

windowStart

string<date-time> | null

windowEnd

string<date-time> | null

noComputeReason

Journal outcomes that deliberately launch no workload.

Available options:

cancelled,

overlap,

epoch_gap,

inputs_rejected

failureClass

enum<string> | null

Terminal dispatch and execution failure categories.

Available options:

QUOTA_REJECTED,

CONFIG_REJECTED,

USER_CODE,

PLATFORM,

TIMEOUT

runAsId

string | null

requestedById

string | null

workload

TaskRunWorkload · object | null

Recorded execution identity; absent before launch, never inferred from Task Run ID.

Show child attributes

cancelRequestedAt

string<date-time> | null

startedAt

string<date-time> | null

endedAt

string<date-time> | null

durationSeconds

integer | null

How long the backend executed the run, from its start to its end (or to now, while running). 0 if it never started there. A cached run executes nothing, so this is the moment it took to return the stored result, not how long the result took to produce.

executionRequest

Executionrequest · object | null

Durable admitted Job Run payload when available, otherwise the captured prelaunch request. URI does not pin historical object bytes.

Show child attributes

name

string | null

inputs

Inputs · object

cached

boolean

default:false

Whether the run returned a result stored by an earlier run of the same task with the same inputs, instead of executing. Only a run that succeeded stores its result; one that failed or was cancelled is never reused. False until the run has ended.

results

Results · object | null

errorMessage

string | null

Why the run did not succeed. A run that could not be started says so and gives the task run ID to quote to support.