API Reference

Get a run

View Markdown

GET /api/runs/{id}

Get a run

Operation IDgetRun

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Success response body

200Run details with active status

Run details with active status

Content typeapplication/json

responseobject

17 properties

idinteger

task_idinteger

task_versioninteger

trigger_typestring

Allowed values: manual, cron, api

statusstring

Allowed values: pending, running, success, completed, failed, cancelled

argumentsstring | null

JSON-encoded arguments

Nullable: yes

connector_mappingstring | null

JSON-encoded map of connector slot name to connector ID

Nullable: yes

started_atstring | null · date-time

Nullable: yes

completed_atstring | null · date-time

Nullable: yes

duration_msinteger | null

Nullable: yes

item_countinteger | null

Nullable: yes

error_messagestring | null

Nullable: yes

log_filestring | null

Nullable: yes

metrics_summarystring | null

Nullable: yes

created_atstring · date-time

updated_atstring · date-time

is_activeboolean

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/runs/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/runs/YOUR_ID", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);