Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nestrilabs/nestri/llms.txt

Use this file to discover all available pages before exploring further.

The Nestri REST API lets you build on top of Nestri’s cloud gaming infrastructure. Every endpoint returns JSON, all responses share a consistent envelope shape, and errors follow a single predictable structure. The API is versioned at 0.0.1 and served over HTTPS.

​
Base URLs

Two environments are available. Use the production URL for live integrations and the sandbox URL when testing.
EnvironmentBase URL
Productionhttps://api.nestri.io
Sandboxhttps://api.dev.nestri.io
Every response includes a Cache-Control: no-store header. Do not cache API responses on the client side.

​
Response envelope

All successful responses wrap their payload in a top-level data key. 
{
  "data": { ... }
}
Array responses return data as an array: 
{
  "data": [ { ... }, { ... } ]
}

​
Error responses

When a request fails, the API returns a JSON object with three fields.
​
type
string
required
High-level error category. One of authentication, not_found, validation, or internal.
​
code
string
required
Machine-readable error code for programmatic handling (e.g. UNAUTHORIZED, RESOURCE_NOT_FOUND, INVALID_PARAMETER, INTERNAL_ERROR).
​
message
string
required
Human-readable explanation of what went wrong.
Example error response: 
{
  "type": "authentication",
  "code": "UNAUTHORIZED",
  "message": "You are not authorized to access this resource"
}

​
HTTP status codes

StatusMeaning
200Request succeeded
400Bad request — validation or missing parameters
401Unauthenticated — missing or invalid token
404Resource not found
429Rate limit exceeded
500Internal server error

​
Endpoints

Account

Fetch the current user’s profile and linked Steam accounts.

Games

List your game library or look up a specific game by ID.

Steam

List linked Steam accounts and trigger the OpenID login flow.

Friends

List or look up friends by their Steam ID.

Build docs developers (and LLMs) love

Get started for freeTalk to us