Skip to main content
POST
CreateCall

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
call
call · object
required

One logical function invocation within a product Run.

A Call is stable across execution attempts. The resource leaf is the lowercase hexadecimal SHA-256 digest of its Run, parent_call, and child_index. Attempt-specific execution identity lives on child Attempt resources; this resource is their summary.

parent
string

Response

Success

One logical function invocation within a product Run.

A Call is stable across execution attempts. The resource leaf is the lowercase hexadecimal SHA-256 digest of its Run, parent_call, and child_index. Attempt-specific execution identity lives on child Attempt resources; this resource is their summary.

spec
spec · object
required

The function, arguments, and execution requirements of every Attempt.

name
string

Resource name in the form runs/{run}/calls/{call}.

Pattern: ^runs/[0-9a-f-]{36}/calls/[0-9a-f]{64}$
parentCall
string | null

Call that emitted this Call. Absent for the root.

childIndex
integer

Zero-based order of this Call among parent_call's children. Replay emits the same Call at the same index. Always 0 for the root Call, which has no parent_call.

state
enum<string>

Current externally observable lifecycle state.

Available options:
STATE_UNSPECIFIED,
STATE_RUNNING,
STATE_COMPLETED,
STATE_FAILED,
STATE_CANCELLED,
STATE_CANCELLING
attemptCount
integer

Number of Attempt resources created for this Call.

output
string<byte> | null

cloudpickle of the successful return value of the latest Attempt.

outputRepr
string | null

Truncated repr of the successful return value of the latest Attempt.

errorMessage
string | null

Terminal failure explanation from the latest Attempt, when one exists.

created_at
string<date-time>

Time the Call was durably snapshotted into this Run.

Example:

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

started_at
string<date-time>

Earliest time any Attempt first transitioned to running.

Example:

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

updated_at
string<date-time>

Most recent observed lifecycle transition across all Attempts.

Example:

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

finished_at
string<date-time>

Time the latest Attempt completed, when the Call is terminal.

Example:

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

created_by
string | null

User that created the owning Run.

hasChildren
boolean | null

Child existence at read time. Populated by GetCall and ListCalls, not execution responses.

workspace
string

The workspace that owns the Call's Run.

cf. Zitadel resource_owner.