Strait Docs
API Reference

Job run management and monitoring

List runs

GET
/v1/runs

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

project_id*string
status?string
Value in"delayed" | "queued" | "dequeued" | "executing" | "waiting" | "completed" | "failed" | "timed_out" | "crashed" | "system_failed" | "canceled" | "expired" | "dead_letter"
metadata_key?string
metadata_value?string
limit?integer
Default50
cursor?string
Formatdate-time
triggered_by?string

Filter by trigger source (manual, cron, spawn, workflow, retry, event)

batch_id?string

Filter runs by batch operation ID

payload_contains?string

JSON object for JSONB containment filter on run payload

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs?project_id=string"
[
  {
    "id": "string",
    "job_id": "string",
    "project_id": "string",
    "status": "delayed",
    "attempt": 0,
    "payload": {},
    "result": {},
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "error": "string",
    "triggered_by": "string",
    "scheduled_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",
    "next_retry_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "parent_run_id": "string",
    "priority": 0,
    "idempotency_key": "string",
    "job_version": 0,
    "workflow_step_run_id": "string",
    "max_attempts_override": 0,
    "timeout_secs_override": 0,
    "retry_backoff": "string",
    "retry_initial_delay_secs": 0,
    "retry_max_delay_secs": 0,
    "execution_trace": {
      "queue_wait_ms": 0,
      "dequeue_ms": 0,
      "connect_ms": 0,
      "ttfb_ms": 0,
      "transfer_ms": 0,
      "total_ms": 0,
      "dispatch_ms": 0
    },
    "debug_mode": true,
    "continuation_of": "string",
    "lineage_depth": 0,
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "job_version_id": "string",
    "created_by": "string",
    "batch_id": "string",
    "concurrency_key": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

List dead-lettered runs

GET
/v1/runs/dlq

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

project_id*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/dlq?project_id=string"
[
  {
    "id": "string",
    "job_id": "string",
    "project_id": "string",
    "status": "delayed",
    "attempt": 0,
    "payload": {},
    "result": {},
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "error": "string",
    "triggered_by": "string",
    "scheduled_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",
    "next_retry_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "parent_run_id": "string",
    "priority": 0,
    "idempotency_key": "string",
    "job_version": 0,
    "workflow_step_run_id": "string",
    "max_attempts_override": 0,
    "timeout_secs_override": 0,
    "retry_backoff": "string",
    "retry_initial_delay_secs": 0,
    "retry_max_delay_secs": 0,
    "execution_trace": {
      "queue_wait_ms": 0,
      "dequeue_ms": 0,
      "connect_ms": 0,
      "ttfb_ms": 0,
      "transfer_ms": 0,
      "total_ms": 0,
      "dispatch_ms": 0
    },
    "debug_mode": true,
    "continuation_of": "string",
    "lineage_depth": 0,
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "job_version_id": "string",
    "created_by": "string",
    "batch_id": "string",
    "concurrency_key": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Cancel multiple runs

POST
/v1/runs/bulk-cancel

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "http://localhost:8080/v1/runs/bulk-cancel" \  -H "Content-Type: application/json" \  -d '{}'
{
  "results": [
    {
      "id": "string",
      "status": "string",
      "error": "string"
    }
  ],
  "total": 0,
  "canceled": 0,
  "failed": 0
}

Get a run

GET
/v1/runs/{runID}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string"
{
  "id": "string",
  "job_id": "string",
  "project_id": "string",
  "status": "delayed",
  "attempt": 0,
  "payload": {},
  "result": {},
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "error": "string",
  "triggered_by": "string",
  "scheduled_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",
  "next_retry_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "parent_run_id": "string",
  "priority": 0,
  "idempotency_key": "string",
  "job_version": 0,
  "workflow_step_run_id": "string",
  "max_attempts_override": 0,
  "timeout_secs_override": 0,
  "retry_backoff": "string",
  "retry_initial_delay_secs": 0,
  "retry_max_delay_secs": 0,
  "execution_trace": {
    "queue_wait_ms": 0,
    "dequeue_ms": 0,
    "connect_ms": 0,
    "ttfb_ms": 0,
    "transfer_ms": 0,
    "total_ms": 0,
    "dispatch_ms": 0
  },
  "debug_mode": true,
  "continuation_of": "string",
  "lineage_depth": 0,
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "job_version_id": "string",
  "created_by": "string",
  "batch_id": "string",
  "concurrency_key": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Cancel a run

DELETE
/v1/runs/{runID}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

curl -X DELETE "http://localhost:8080/v1/runs/string"
Empty

Replay a failed run

POST
/v1/runs/{runID}/replay

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X POST "http://localhost:8080/v1/runs/string/replay"
{
  "id": "string",
  "job_id": "string",
  "project_id": "string",
  "status": "delayed",
  "attempt": 0,
  "payload": {},
  "result": {},
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "error": "string",
  "triggered_by": "string",
  "scheduled_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",
  "next_retry_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "parent_run_id": "string",
  "priority": 0,
  "idempotency_key": "string",
  "job_version": 0,
  "workflow_step_run_id": "string",
  "max_attempts_override": 0,
  "timeout_secs_override": 0,
  "retry_backoff": "string",
  "retry_initial_delay_secs": 0,
  "retry_max_delay_secs": 0,
  "execution_trace": {
    "queue_wait_ms": 0,
    "dequeue_ms": 0,
    "connect_ms": 0,
    "ttfb_ms": 0,
    "transfer_ms": 0,
    "total_ms": 0,
    "dispatch_ms": 0
  },
  "debug_mode": true,
  "continuation_of": "string",
  "lineage_depth": 0,
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "job_version_id": "string",
  "created_by": "string",
  "batch_id": "string",
  "concurrency_key": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Replay a dead-lettered run

POST
/v1/runs/{runID}/dlq-replay

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X POST "http://localhost:8080/v1/runs/string/dlq-replay"
{
  "id": "string",
  "job_id": "string",
  "project_id": "string",
  "status": "delayed",
  "attempt": 0,
  "payload": {},
  "result": {},
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "error": "string",
  "triggered_by": "string",
  "scheduled_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",
  "next_retry_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "parent_run_id": "string",
  "priority": 0,
  "idempotency_key": "string",
  "job_version": 0,
  "workflow_step_run_id": "string",
  "max_attempts_override": 0,
  "timeout_secs_override": 0,
  "retry_backoff": "string",
  "retry_initial_delay_secs": 0,
  "retry_max_delay_secs": 0,
  "execution_trace": {
    "queue_wait_ms": 0,
    "dequeue_ms": 0,
    "connect_ms": 0,
    "ttfb_ms": 0,
    "transfer_ms": 0,
    "total_ms": 0,
    "dispatch_ms": 0
  },
  "debug_mode": true,
  "continuation_of": "string",
  "lineage_depth": 0,
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "job_version_id": "string",
  "created_by": "string",
  "batch_id": "string",
  "concurrency_key": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Bulk replay dead-lettered runs

POST
/v1/runs/bulk-dlq-replay

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:8080/v1/runs/bulk-dlq-replay" \  -H "Content-Type: application/json" \  -d '{}'
{
  "replayed": [
    {
      "id": "string",
      "job_id": "string",
      "project_id": "string",
      "status": "delayed",
      "attempt": 0,
      "payload": {},
      "result": {},
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "error": "string",
      "triggered_by": "string",
      "scheduled_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",
      "next_retry_at": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z",
      "parent_run_id": "string",
      "priority": 0,
      "idempotency_key": "string",
      "job_version": 0,
      "workflow_step_run_id": "string",
      "max_attempts_override": 0,
      "timeout_secs_override": 0,
      "retry_backoff": "string",
      "retry_initial_delay_secs": 0,
      "retry_max_delay_secs": 0,
      "execution_trace": {
        "queue_wait_ms": 0,
        "dequeue_ms": 0,
        "connect_ms": 0,
        "ttfb_ms": 0,
        "transfer_ms": 0,
        "total_ms": 0,
        "dispatch_ms": 0
      },
      "debug_mode": true,
      "continuation_of": "string",
      "lineage_depth": 0,
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "job_version_id": "string",
      "created_by": "string",
      "batch_id": "string",
      "concurrency_key": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "count": 0
}
{
  "error": "string",
  "request_id": "string"
}
{
  "error": "string",
  "request_id": "string"
}

Cancel all runs matching filters

POST
/v1/runs/bulk-cancel-all

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

project_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "http://localhost:8080/v1/runs/bulk-cancel-all?project_id=string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "results": [
    {
      "id": "string",
      "status": "string",
      "error": "string"
    }
  ],
  "total": 0,
  "canceled": 0,
  "failed": 0
}

Replay multiple runs by ID

POST
/v1/runs/bulk-replay

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "http://localhost:8080/v1/runs/bulk-replay" \  -H "Content-Type: application/json" \  -d '{    "run_ids": [      "string"    ]  }'
[
  {
    "id": "string",
    "job_id": "string",
    "project_id": "string",
    "status": "delayed",
    "attempt": 0,
    "payload": {},
    "result": {},
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "error": "string",
    "triggered_by": "string",
    "scheduled_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",
    "next_retry_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "parent_run_id": "string",
    "priority": 0,
    "idempotency_key": "string",
    "job_version": 0,
    "workflow_step_run_id": "string",
    "max_attempts_override": 0,
    "timeout_secs_override": 0,
    "retry_backoff": "string",
    "retry_initial_delay_secs": 0,
    "retry_max_delay_secs": 0,
    "execution_trace": {
      "queue_wait_ms": 0,
      "dequeue_ms": 0,
      "connect_ms": 0,
      "ttfb_ms": 0,
      "transfer_ms": 0,
      "total_ms": 0,
      "dispatch_ms": 0
    },
    "debug_mode": true,
    "continuation_of": "string",
    "lineage_depth": 0,
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "job_version_id": "string",
    "created_by": "string",
    "batch_id": "string",
    "concurrency_key": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

SSE event stream

GET
/v1/runs/{runID}/stream

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

text/event-stream

curl -X GET "http://localhost:8080/v1/runs/string/stream"
"string"

List child runs

GET
/v1/runs/{runID}/children

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string/children"
[
  {
    "id": "string",
    "job_id": "string",
    "project_id": "string",
    "status": "delayed",
    "attempt": 0,
    "payload": {},
    "result": {},
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "error": "string",
    "triggered_by": "string",
    "scheduled_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",
    "next_retry_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "parent_run_id": "string",
    "priority": 0,
    "idempotency_key": "string",
    "job_version": 0,
    "workflow_step_run_id": "string",
    "max_attempts_override": 0,
    "timeout_secs_override": 0,
    "retry_backoff": "string",
    "retry_initial_delay_secs": 0,
    "retry_max_delay_secs": 0,
    "execution_trace": {
      "queue_wait_ms": 0,
      "dequeue_ms": 0,
      "connect_ms": 0,
      "ttfb_ms": 0,
      "transfer_ms": 0,
      "total_ms": 0,
      "dispatch_ms": 0
    },
    "debug_mode": true,
    "continuation_of": "string",
    "lineage_depth": 0,
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "job_version_id": "string",
    "created_by": "string",
    "batch_id": "string",
    "concurrency_key": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

List run events

GET
/v1/runs/{runID}/events

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Query Parameters

level?string
type?string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string/events"
[
  {
    "id": "string",
    "run_id": "string",
    "type": "string",
    "level": "string",
    "message": "string",
    "data": {},
    "created_at": "2019-08-24T14:15:22Z"
  }
]

List run checkpoints

GET
/v1/runs/{runID}/checkpoints

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string/checkpoints"
[
  {
    "id": "string",
    "run_id": "string",
    "sequence": 0,
    "source": "string",
    "state": {},
    "created_at": "2019-08-24T14:15:22Z"
  }
]

List run AI model usage

GET
/v1/runs/{runID}/usage

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string/usage"
[
  {
    "id": "string",
    "run_id": "string",
    "provider": "string",
    "model": "string",
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "cost_microusd": 0,
    "created_at": "2019-08-24T14:15:22Z"
  }
]

List run tool calls

GET
/v1/runs/{runID}/tool-calls

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string/tool-calls"
[
  {
    "id": "string",
    "run_id": "string",
    "tool_name": "string",
    "input": {},
    "output": {},
    "duration_ms": 0,
    "status": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

List run structured outputs

GET
/v1/runs/{runID}/outputs

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string/outputs"
[
  {
    "id": "string",
    "run_id": "string",
    "output_key": "string",
    "schema": {},
    "value": {},
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Get debug bundle

GET
/v1/runs/{runID}/debug-bundle

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string/debug-bundle"
{
  "run": {
    "id": "string",
    "job_id": "string",
    "project_id": "string",
    "status": "delayed",
    "attempt": 0,
    "payload": {},
    "result": {},
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "error": "string",
    "triggered_by": "string",
    "scheduled_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",
    "next_retry_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "parent_run_id": "string",
    "priority": 0,
    "idempotency_key": "string",
    "job_version": 0,
    "workflow_step_run_id": "string",
    "max_attempts_override": 0,
    "timeout_secs_override": 0,
    "retry_backoff": "string",
    "retry_initial_delay_secs": 0,
    "retry_max_delay_secs": 0,
    "execution_trace": {
      "queue_wait_ms": 0,
      "dequeue_ms": 0,
      "connect_ms": 0,
      "ttfb_ms": 0,
      "transfer_ms": 0,
      "total_ms": 0,
      "dispatch_ms": 0
    },
    "debug_mode": true,
    "continuation_of": "string",
    "lineage_depth": 0,
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "job_version_id": "string",
    "created_by": "string",
    "batch_id": "string",
    "concurrency_key": "string",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "events": [
    {
      "id": "string",
      "run_id": "string",
      "type": "string",
      "level": "string",
      "message": "string",
      "data": {},
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "checkpoints": [
    {
      "id": "string",
      "run_id": "string",
      "sequence": 0,
      "source": "string",
      "state": {},
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "usage": [
    {
      "id": "string",
      "run_id": "string",
      "provider": "string",
      "model": "string",
      "prompt_tokens": 0,
      "completion_tokens": 0,
      "total_tokens": 0,
      "cost_microusd": 0,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "tool_calls": [
    {
      "id": "string",
      "run_id": "string",
      "tool_name": "string",
      "input": {},
      "output": {},
      "duration_ms": 0,
      "status": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "outputs": [
    {
      "id": "string",
      "run_id": "string",
      "output_key": "string",
      "schema": {},
      "value": {},
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Enable/disable debug mode

POST
/v1/runs/{runID}/debug

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

debug_mode?boolean

Response Body

curl -X POST "http://localhost:8080/v1/runs/string/debug" \  -H "Content-Type: application/json" \  -d '{}'
Empty

List run continuation lineage

GET
/v1/runs/{runID}/lineage

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string/lineage"
[
  {
    "id": "string",
    "job_id": "string",
    "project_id": "string",
    "status": "delayed",
    "attempt": 0,
    "payload": {},
    "result": {},
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "error": "string",
    "triggered_by": "string",
    "scheduled_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",
    "next_retry_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "parent_run_id": "string",
    "priority": 0,
    "idempotency_key": "string",
    "job_version": 0,
    "workflow_step_run_id": "string",
    "max_attempts_override": 0,
    "timeout_secs_override": 0,
    "retry_backoff": "string",
    "retry_initial_delay_secs": 0,
    "retry_max_delay_secs": 0,
    "execution_trace": {
      "queue_wait_ms": 0,
      "dequeue_ms": 0,
      "connect_ms": 0,
      "ttfb_ms": 0,
      "transfer_ms": 0,
      "total_ms": 0,
      "dispatch_ms": 0
    },
    "debug_mode": true,
    "continuation_of": "string",
    "lineage_depth": 0,
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "job_version_id": "string",
    "created_by": "string",
    "batch_id": "string",
    "concurrency_key": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Get dependency status for a run

GET
/v1/runs/{runID}/dependency-status

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/runs/string/dependency-status"
{
  "run_id": "string",
  "job_id": "string",
  "status": "delayed",
  "dependencies": [
    {
      "id": "string",
      "job_id": "string",
      "depends_on_job_id": "string",
      "condition": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "dependencies_satisfied": true
}

Reset idempotency key for a run

DELETE
/v1/runs/{runID}/idempotency-key

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X DELETE "http://localhost:8080/v1/runs/string/idempotency-key"
{
  "status": "string",
  "run_id": "string"
}

Reschedule a run

POST
/v1/runs/{runID}/reschedule

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "http://localhost:8080/v1/runs/string/reschedule" \  -H "Content-Type: application/json" \  -d '{    "scheduled_at": "2019-08-24T14:15:22Z"  }'
{
  "id": "string",
  "job_id": "string",
  "project_id": "string",
  "status": "delayed",
  "attempt": 0,
  "payload": {},
  "result": {},
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "error": "string",
  "triggered_by": "string",
  "scheduled_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",
  "next_retry_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "parent_run_id": "string",
  "priority": 0,
  "idempotency_key": "string",
  "job_version": 0,
  "workflow_step_run_id": "string",
  "max_attempts_override": 0,
  "timeout_secs_override": 0,
  "retry_backoff": "string",
  "retry_initial_delay_secs": 0,
  "retry_max_delay_secs": 0,
  "execution_trace": {
    "queue_wait_ms": 0,
    "dequeue_ms": 0,
    "connect_ms": 0,
    "ttfb_ms": 0,
    "transfer_ms": 0,
    "total_ms": 0,
    "dispatch_ms": 0
  },
  "debug_mode": true,
  "continuation_of": "string",
  "lineage_depth": 0,
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "job_version_id": "string",
  "created_by": "string",
  "batch_id": "string",
  "concurrency_key": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Pause a managed run

POST
/v1/runs/{runID}/pause

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X POST "http://localhost:8080/v1/runs/string/pause"
{
  "id": "string",
  "job_id": "string",
  "project_id": "string",
  "status": "delayed",
  "attempt": 0,
  "payload": {},
  "result": {},
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "error": "string",
  "triggered_by": "string",
  "scheduled_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",
  "next_retry_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "parent_run_id": "string",
  "priority": 0,
  "idempotency_key": "string",
  "job_version": 0,
  "workflow_step_run_id": "string",
  "max_attempts_override": 0,
  "timeout_secs_override": 0,
  "retry_backoff": "string",
  "retry_initial_delay_secs": 0,
  "retry_max_delay_secs": 0,
  "execution_trace": {
    "queue_wait_ms": 0,
    "dequeue_ms": 0,
    "connect_ms": 0,
    "ttfb_ms": 0,
    "transfer_ms": 0,
    "total_ms": 0,
    "dispatch_ms": 0
  },
  "debug_mode": true,
  "continuation_of": "string",
  "lineage_depth": 0,
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "job_version_id": "string",
  "created_by": "string",
  "batch_id": "string",
  "concurrency_key": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Resume a paused run

POST
/v1/runs/{runID}/resume

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

application/json

curl -X POST "http://localhost:8080/v1/runs/string/resume"
{
  "id": "string",
  "job_id": "string",
  "project_id": "string",
  "status": "delayed",
  "attempt": 0,
  "payload": {},
  "result": {},
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "error": "string",
  "triggered_by": "string",
  "scheduled_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",
  "next_retry_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "parent_run_id": "string",
  "priority": 0,
  "idempotency_key": "string",
  "job_version": 0,
  "workflow_step_run_id": "string",
  "max_attempts_override": 0,
  "timeout_secs_override": 0,
  "retry_backoff": "string",
  "retry_initial_delay_secs": 0,
  "retry_max_delay_secs": 0,
  "execution_trace": {
    "queue_wait_ms": 0,
    "dequeue_ms": 0,
    "connect_ms": 0,
    "ttfb_ms": 0,
    "transfer_ms": 0,
    "total_ms": 0,
    "dispatch_ms": 0
  },
  "debug_mode": true,
  "continuation_of": "string",
  "lineage_depth": 0,
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "job_version_id": "string",
  "created_by": "string",
  "batch_id": "string",
  "concurrency_key": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Restart a managed run with optional preset override

POST
/v1/runs/{runID}/restart

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

machine_preset?string

Response Body

application/json

curl -X POST "http://localhost:8080/v1/runs/string/restart" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "job_id": "string",
  "project_id": "string",
  "status": "delayed",
  "attempt": 0,
  "payload": {},
  "result": {},
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "error": "string",
  "triggered_by": "string",
  "scheduled_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",
  "next_retry_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "parent_run_id": "string",
  "priority": 0,
  "idempotency_key": "string",
  "job_version": 0,
  "workflow_step_run_id": "string",
  "max_attempts_override": 0,
  "timeout_secs_override": 0,
  "retry_backoff": "string",
  "retry_initial_delay_secs": 0,
  "retry_max_delay_secs": 0,
  "execution_trace": {
    "queue_wait_ms": 0,
    "dequeue_ms": 0,
    "connect_ms": 0,
    "ttfb_ms": 0,
    "transfer_ms": 0,
    "total_ms": 0,
    "dispatch_ms": 0
  },
  "debug_mode": true,
  "continuation_of": "string",
  "lineage_depth": 0,
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "job_version_id": "string",
  "created_by": "string",
  "batch_id": "string",
  "concurrency_key": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

SSE stream of LLM chunks

GET
/v1/runs/{runID}/stream/chunks

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

curl -X GET "http://localhost:8080/v1/runs/string/stream/chunks"
Empty

List run state (management API)

GET
/v1/runs/{runID}/state

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

runID*string

Response Body

curl -X GET "http://localhost:8080/v1/runs/string/state"
Empty
Was this page helpful?
Edit on GitHub

Environments

Environment-specific configuration and variables

Workflows

Workflow DAG definition and management