Skip to main content
POST
Confirm an upload, and start making the media's copies

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"

id
string<uuid>
required

Response

The media, making its copies or ready

id
string<uuid>
required
kind
enum<string>
required

cover: the wide 16:9 key art every card shows (one). screenshot: up to 20. clip: up to 5, for the game page. tall_cover: the tall 2:3 key art for where games stand as tall tiles (one). hover_clip: 4 to 8 seconds of play, no UI, that cards fade into while pointed at (one, at most 20 MB). A new cover, tall cover or hover clip replaces the old once it's ready.

Available options:
cover,
screenshot,
clip,
tall_cover,
hover_clip
status
enum<string>
required

pending until its upload is completed. processing while its smaller copies are made: a few seconds for a picture and, for a clip, about as long as it plays. ready once they and the file are public, which is when it shows. failed when they couldn't be made, with why in error: complete it again to try again. Only its managers see it before it's ready.

Available options:
pending,
processing,
ready,
failed
url
string
required

Where it's served from, once it's ready

levels
object[]
required

Smaller copies of a picture (WebP) or a clip (MP4, H.264, without sound), smallest first, each at its own address that never changes. Show the smallest that's sharp where it goes. Empty for animated pictures, for flat art and short clips with no smaller copy, and for media from before Patch made copies until theirs are made: then use the file itself.

content_type
string
required
sha256
string
required
size
integer
required
width
integer | null
required
height
integer | null
required
alt
string | null
required
error
string | null
required

Why its copies couldn't be made, when it's failed

position
integer
required

Order among media of the same kind

generated
boolean
required

Made by an image model: a cover or tall cover that's key art built from the game's real frames

job_id
string<uuid> | null
required

The covers job whose take it is, when Patch's free covers made it

created_at
string
required