Information
- OpenAPI version:
3.1.0
Overview
Viewing v1— superseded by v2
Layer REST API (v1) 1.0.0
Section titled “Layer REST API (v1) 1.0.0”REST API for AI-powered game asset creation on the Layer platform.
Authentication
All endpoints require a Bearer token in the Authorization header:
Authorization: Bearer <token>Personal Access Tokens (recommended)
The simplest way to authenticate is with a Personal Access Token (PAT):
- Log in to app.layer.ai
- Go to Settings > Personal Access Tokens
- Click Create Token, give it a name, and copy the token value
- Pass it as
Authorization: Bearer <your-pat-token>
PATs are long-lived and ideal for scripts, CI pipelines, and partner integrations.
OAuth2 (browser-based)
For browser-based applications, use the Auth0 OAuth2 flow. Redirect users to
the Layer login page, exchange the authorization code for a JWT access token,
and use it as Authorization: Bearer <jwt>.
Creative Units
Generations consume Creative Units (CUs). Use the estimate endpoints to check
cost before executing. Check workspace balance via GET /v1/workspaces/{id}.
Pagination
List endpoints support cursor-based pagination via limit and cursor query
parameters. Responses include a pagination object with next_cursor,
has_more_results, and total_count. Cursors are opaque — do not parse or
construct them.
Errors
All errors return RFC 7807 Problem Details:
{
"type": "https://api.layer.ai/errors/ERROR_CODE",
"title": "Human-readable title",
"status": 404,
"detail": "Detailed description of what went wrong."
}Common status codes: 401 (unauthenticated), 403 (forbidden), 404 (not found),
422 (invalid input), 429 (rate limited).
Creative Units are not checked when a run is submitted, so an underfunded workspace
does not fail at submission time. Call the estimate endpoint and read
has_sufficient_creative_units to check up front; otherwise the run is accepted and
then reaches a terminal FAILED state with error_code INSUFFICIENT_BALANCE.
Versioning
/v1 and /v2 are both stable and served together; v1 routes are unaffected by v2.
/v2 is a complete surface — every resource is reachable under it, so a client can pin
/v2 and never fall back. It differs from v1 in the generation surface: inference runs
take reference sets — trained subjects, styles, and characters — alongside a base model,
and the v1 /models catalog is split into /base-models and /reference-sets.
Every other resource is the same endpoint under both prefixes: identical handler, request
body, and response shape. Their v2 operation ids carry a V2 suffix so generated clients
get one symbol per published path.
Authentication
Section titled “Authentication”bearerAuth
Section titled “bearerAuth”Bearer authentication with a Layer Personal Access Token (PAT), prefixed pat_. Send it as Authorization: Bearer <token>. Create one in the app under Settings → Personal Access Tokens. An Auth0 session JWT is also accepted for first-party browser use.
Security scheme type: http