Skip to content

Get Job

GET
/v1/jobs/{job_id}
curl --request GET \
--url https://example.com/v1/jobs/example
job_id
required
Job Id
string
x-api-key
Any of:
string

Successful Response

Media typeapplication/json
JobOut
object
tenant_id
required
Tenant Id
string
id
required
Id
string
proposal_id
Any of:
string
job_type
required
Job Type
string
provider_kind
required
Provider Kind
string
status
required
Status
string
Allowed values: queued running succeeded failed
payload
required
Payload
object
key
additional properties
any
result
Any of:
object
key
additional properties
any
error_message
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
"status": "queued"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}