Release API

The Release API lets you programmatically manage environments, deployments, clusters, and AI sandboxes. Most users start with the Platform API.

Choose Your API

API	Base URL	Use When
Platform API	https://api.release.com	Managing accounts, apps, environments, deploys, clusters, builds
AI Sandbox API	https://backend-{handle}-envs.gcp.release.com	Creating sandbox sessions, running executions, managing snapshots and memory. The URL is scoped to your environment handle (e.g. https://backend-thor-envs.gcp.release.com)
GraphQL API	https://api.release.com/graphql	Mutations (pause/resume/delete environments), complex queries

Authentication

All APIs authenticate via headers using credentials from your ~/.release.yaml file. Install the Release CLI and run release auth login to get started. Exact required headers differ per API section — see Authentication for the full reference.

Machine-Readable API Contract

The canonical OpenAPI specification is available at:

https://api.release.com/openapi.json

Use this endpoint to generate clients, feed agent toolchains, or validate integrations programmatically. For a guide on integrating with the Release API as an AI agent or automated tool, see Agent Integration Guide.

Conventions

Convention	Format	Example
Timestamps	ISO 8601	2025-01-15T10:30:00Z
IDs	Hashid strings	"abc123"
Nullable fields	Returns null	"field": null
Errors	JSON with error or errors array	{"error": "message"}