Skip to main content
POST
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
Synchronously wait for a job to terminate. Useful for shell scripts and simple HTTP clients that can’t consume SSE. Returns immediately when the job is already in a terminal status; otherwise blocks up to timeout_seconds (default 30, max 60) before returning the current state with is_terminal: false. Implementation: server-side polling on a 1-second interval, refreshing the row each tick. Avoids holding an open broker subscription so connection-pool pressure stays bounded — the long-running idiom is /events/stream (SSE) when you need intermediate updates rather than just terminal status.

Path parameters

string (uuid)
required

Request body

WaitJobRequest,null
integer
How long to block before returning the current state. 1..60 seconds. The endpoint returns as soon as the job reaches a terminal status, so this is only the upper bound. Default: 30. Minimum: 1. Maximum: 60.

Response

WaitJobResponse
string
required
string
required
boolean
required
True if the job reached succeeded/failed/cancelled before the timeout. False means the timeout fired and the returned status is still in-flight.
number
required
Wall-clock seconds spent blocking inside the handler.
string,null
string,null
number,null

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026