> For the complete documentation index, see [llms.txt](https://docs.release.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.release.com/reference-documentation/release-api.md).

# Release API

The Release API lets you programmatically manage environments, deployments, clusters, and AI sandboxes. Most users start with the [Platform API](/reference-documentation/release-api/platform-api.md).

## Choose Your API

| API                                                                      | Base URL                                        | Use When                                                                                                                                                                      |
| ------------------------------------------------------------------------ | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Platform API](/reference-documentation/release-api/platform-api.md)     | `https://api.release.com`                       | Managing accounts, apps, environments, deploys, clusters, builds                                                                                                              |
| [AI Sandbox API](/reference-documentation/release-api/ai-sandbox-api.md) | `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](/reference-documentation/release-api/graphql-api.md)       | `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](/cli/installation.md) and run `release auth login` to get started. Exact required headers differ per API section — see [Authentication](/reference-documentation/release-api/authentication.md) 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](/reference-documentation/release-api/agent-integration-guide.md).

## 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"}` |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.release.com/reference-documentation/release-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.