Skip to main content
POST
Start making covers from the game's own stills

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"

Body

application/json
stills
object[]
required
Required array length: 1 - 3 elements
subject
string
required

The one thing the cover shows, e.g. 'the stone colossus'

Maximum string length: 80
shape
enum<string>
deprecated

Ignored: covers are always made in both shapes, so every game gets a tall cover too. Kept so older callers still work.

Available options:
wide,
tall,
both
takes
integer

Takes of each shape, wide and tall, 3 by default

Required range: 1 <= x <= 3

Response

The job, with its takes being made

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