Skip to main content
POST
Create a playtest (draft)

Authorizations

Authorization
string
header
required

Personal API key (prefix up_). Create one in the studio under Account → API keys.

Path Parameters

studioId
string
required

Body

application/json
playtestType
enum<string>
required

The kind of playtest to run.

Available options:
single,
multi,
longitudinal
playtestName
string
required

Display name of the playtest.

Required string length: 2 - 80
playtestHighlightsConfig
object
required

Highlight generation settings. Supply as nested JSON via --body.

playtestSessionCount
integer
required

Number of play sessions to collect, from 1 to 6. Single-session playtests use 1.

Required range: x <= 6
minSessionDuration
integer
required

Minimum length of a valid session, in seconds.

playtestDescription
string

Optional description shown to your team.

Maximum string length: 2000
buildDistributionUrl
string<uri>

URL where players download or launch the build.

Maximum string length: 2048
sessionCooldown
integer

Minimum gap between a player's sessions, in seconds (up to 3600).

Required range: x <= 3600
emails
string<email>[]

Email addresses to add to the playtest roster.

maxPlayers
integer

Total-player cap for a shareable self-join link. Omit for a roster-only playtest.

Required range: 1 <= x <= 1000

Response

201 - application/json

The created draft playtest

data
object
required