Looking for the product guide instead? Start at Introduction and Concepts. Prefer a terminal over raw HTTP? The CLI wraps this same API.
What it can and cannot do
Making a request
Every request goes to the same base URL:Response format
Successful responses wrap the payload indata. List endpoints also include a pagination block:
code.
Finding an endpoint
The API Reference tab documents every operation, grouped by resource. Each page has a request builder: paste a key into it and you can run the call against your own studio.Studios
Start here. Almost every other route hangs off a
studioId.Playtests
Create a draft, patch it, duplicate it, seed its roster.
Sessions
Recorded sessions, and the highlights cut from them.
Exports
Pull a whole dataset out as a file.
Next steps
Quickstart
Three calls: your studios, a studio’s playtests, then its sessions.
Authentication
The header contract, and how far one key reaches.
Set up a playtest from the command line
Build a draft from code, then publish it in the studio.
Rate limits
120 requests per 60 seconds, per key, and how to retry.
Errors
Every status code the API returns, and what to do about each one.
Pagination
Walking a long list without missing a page.