Skip to main content
POST
Start a play session

Authorizations

Authorization
string
header
required

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

Body

application/json
id
string<uuid>
required

Made by the client (a UUID)

project
string
required
Pattern: ^[a-z0-9][a-z0-9_-]*\/[a-z0-9][a-z0-9-]*$
Example:

"mira/lantern-run"

version
string
required
Required string length: 1 - 64
Example:

"1.2.0"

client
enum<string>
required
Available options:
desktop,
web
device_id
string

The Patch Desktop install or browser playing, made by the client

Maximum string length: 64
app_version
string
Maximum string length: 40

Response

Started

id
string<uuid>
required
project
string
required
Example:

"mira/lantern-run"

version
string
required
client
string
required
Example:

"desktop"

started_at
string
required
last_seen_at
string
required
ended_at
string | null
required
end
enum<string> | null
required
Available options:
ended,
exited,
crashed,
timed_out,
null
heartbeat_s
integer
required

Send a heartbeat this often