Skip to main content
GET
A covers job: its takes, and the free allowance left

Authorizations

Authorization
string
header
required

An API key (pch_...) or the token from pch login.

Path Parameters

owner
string
required
Example:

"patch"

slug
string
required
Example:

"demo-mod"

job
string<uuid>
required

Query Parameters

wait
integer | null
Required range: 0 <= x <= 50

Response

The job

id
string<uuid>
required
project
string
required
kind
enum<string>
required
Available options:
make,
fix
state
enum<string>
required

succeeded once every take has settled and at least one is ready. failed when none could be made: next says whether another try can help

Available options:
queued,
running,
succeeded,
failed,
canceled
shape
string | null
required
subject
string | null
required
instruction
string | null
required
fixes
string<uuid> | null
required

The take a fix job fixes

takes
object[]
required
allowance
object
required
next
string
required

What to do next, for the person and their agent

created_at
string
required