Skip to main content
Userplay has two programmatic surfaces: a REST API, and userplay, a CLI that wraps it. Both take the same personal API key, and both reach every studio your account belongs to.

Pick a surface

The CLI calls the same endpoints, returns the same errors, and honours the same rate limits. Nothing is available in one and missing from the other.

What you can automate

Both surfaces read everything the studio shows: playtests, sessions, submissions, highlights, players, key vaults, and results. They write most of what a playtest needs before it goes live. They cannot publish it, and they cannot delete anything. What it can and cannot do has the full grid.

One key, from the studio

Create a personal key under Account > Developer, in the Access keys section. Keys start with up_, carry the permissions of the person who created them, and work across every studio that person belongs to. See API keys for creating, rotating, and retiring one.

Reference

Two generated references sit alongside this guide, each in its own tab. API Reference documents every endpoint and carries a request builder: paste a key into it and run the call against your own studio. CLI Reference documents every command, argument, and flag.

Next steps

API quickstart

Three calls: your studios, a studio’s playtests, then its sessions.

CLI quickstart

From install to your first write, with a dry run in between.

API Reference

Every endpoint, runnable in the browser.

CLI Reference

Every command, grouped by resource.