Skip to content

Check forge job status

GET
/api/v1/forge/status/{job_id}

Return the current status and result (when completed) for a forge job.

Authorizations

Parameters

Path Parameters

job_id
required
string

Responses

200

Successful Response

Typed envelope for GET /forge/status/{job_id} (200).

object
data
required

Envelope returned when polling job status (200).

Attributes: job_id: UUID of the forge job. status: Current lifecycle state. result: Present when status is ‘completed’. error: Present when status is ‘failed’.

object
error
Any of:
string
job_id
required
string
result
Any of:
status
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string