Skip to main content
POST
GetRun

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json
name
string
includeSummary
boolean

Include aggregated Call and Attempt counts.

Response

Success

A product-level container for one tree of function Calls.

A Run supplies product ownership, submission identity, discovery, cancellation, and the root result. Its Call tree, and the execution dispatches summarized by those Calls, are its children.

name
string

Resource name in the form runs/{run}.

state
enum<string>

State of the root Call.

Available options:
STATE_UNSPECIFIED,
STATE_RUNNING,
STATE_COMPLETED,
STATE_FAILED,
STATE_CANCELLED,
STATE_CANCELLING
spec
spec · object

What the client submits to start the Run.

rootCall
string

Root Call of this Run.

displayName
string

Display label, defaulting to the root Call's function name.

summary
summary · object

Populated only by GetRun with include_summary.

output
string<byte> | null

cloudpickle of the root Call's successful return value.

outputRepr
string | null

Truncated repr of the root Call's successful return value.

created_by
string | null

User that submitted this Run.

created_at
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

updated_at
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

errorMessage
string | null

Terminal failure or cancellation explanation, when one exists.

workspace
string

The workspace that owns the Run and pays for it, its creating credential's.

cf. Zitadel resource_owner; Modal apps belong to a workspace.

finished_at
string<date-time>

Completion time of the root Call; unset while the Run is active.

Example:

"2023-01-15T01:30:15.01Z"