Skip to content
Kindgi

A run's progress (status and timing, no data)

GET
/v1/runs/{runId}/progress
curl --request GET \
  --url https://example.com/v1/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/progress \
  --header 'Authorization: Bearer <token>'

The run’s status and timing, without its input, output or failure message: safe to show in a browser. Accepts an API token, or a public run token (kgi_pt_…) that names the run or one of its ancestors.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
runId
required
string format: uuid

RunId — opaque branded string (a UUID).

Responses

Section titled “Responses”

200

Section titled “200”

The run’s progress.

Media typeapplication/json

A run’s progress: status and timing, without its input, output, failure message or tenant. Safe to show in a browser.

object
id
required

RunId.

string format: uuid
flowId
required
string
flowVersion
required
string
status
required
string
Allowed values: pending running suspended completed failed cancelled
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
completedAt
string format: date-time
parentRunId
string format: uuid
Example
{
  "status": "pending"
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No run with that id that the token may read.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}