canonical: https://jentic.com/apis/release.com/release

# Release.com Platform API

The Release.com Platform API runs the ephemeral environments, builds, and deploy pipelines behind Release.com. Apps hold builds you can create, rebuild, cancel, and read logs for, while spaces are the environments that apps deploy into, which you can create, pause, resume, extend before they expire, or delete. Pipelines deploy into a space and can be aborted mid-run, and account-level calls cover clusters with kubeconfig download, certificate generation, upgrades, and database snapshot listing.

## For AI agents

Create builds, spin up and pause ephemeral environments, run and abort deploy pipelines, and manage clusters on Release.com. Every operation sends the X-User-Email and X-User-Token headers.

## Scope

Does not handle source control hosting, code review, or application monitoring. Use for Release.com builds, ephemeral environments, deploy pipelines, and clusters only.

## Capabilities

- Start a build for an app and read its build log
- Rebuild or cancel an in-flight build by build id
- Spin up an ephemeral environment (space) for an app and tear it down when done
- Pause, resume, or extend the expiration of an environment to control cost
- Run a deploy pipeline into a space and abort it if it goes wrong
- Download a kubeconfig for a cluster or a remote development environment
- List database snapshots and trigger upgrades on an account's clusters

## Use cases

### Agent-managed preview environments

A coding agent opens a pull request and needs somewhere to test it. Through the Release.com Platform API it creates a space for the app, waits for the deploy pipeline in that space, and reads the instances to find what is running, then deletes the space when the review is done.

Example prompt: Call POST `/apps/{app_id}/spaces` for the app, then GET `/apps/{app_id}/spaces/{space_id}/pipelines` to watch the deploy, and DELETE `/apps/{app_id}/spaces/{id}` once the review closes

### Diagnose a failed build

When a build fails, the agent lists the app's builds filtered by branch, opens the failing one, and reads its log to find the error. After a fix lands it can trigger a rebuild of the same build instead of starting from scratch.

Example prompt: Call GET `/apps/{app_id}/builds` with branch set to the feature branch, then GET `/apps/{app_id}/builds/{id}/log` for the failed build, and POST `/apps/{app_id}/builds/{id}/rebuild` after the fix

### Control environment cost

Idle ephemeral environments cost money. An agent can pause spaces outside working hours and resume them in the morning, extend the expiration of one still under review, or override its schedule for a demo.

Example prompt: Call POST `/apps/{app_id}/spaces/{id}/pause` for each idle space at night and POST `/apps/{app_id}/spaces/{id}/resume` the next morning

### Cluster access and maintenance

Account-level cluster operations let an agent list an account's clusters, verify one, download its kubeconfig for kubectl access, generate a certificate, list database snapshots, or start an upgrade.

Example prompt: Call GET `/accounts/{account_id}/clusters`, then GET `/accounts/{account_id}/clusters/{id}/kubeconfig` for the target cluster

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/apps/{app_id}/spaces` | Create an environment for an app |
| POST | `/apps/{app_id}/builds` | Create a build |
| GET | `/apps/{app_id}/builds/{id}/log` | Read a build log |
| POST | `/apps/{app_id}/spaces/{space_id}/pipelines` | Run a deploy pipeline in a space |
| PUT | `/apps/{app_id}/spaces/{space_id}/pipelines/{id}/abort` | Abort a deploy |
| POST | `/apps/{app_id}/spaces/{id}/pause` | Pause an environment |
| PUT | `/apps/{app_id}/spaces/{id}/extend_expiration` | Extend environment expiration |
| GET | `/accounts/{account_id}/clusters/{id}/kubeconfig` | Download cluster kubeconfig |

## Key resources

- **Apps** — Applications on Release.com: create, read, update, clone, delete, list branches and tags and services
- **Builds** — Builds per app: create, list, read, rebuild, cancel, and read logs
- **Spaces** — Ephemeral environments per app: create, list, delete, pause, resume, extend expiration, override schedule
- **Pipelines** — Deploy runs into a space: create, list, read, abort
- **Clusters** — Account clusters: create, verify, upgrade, certificate, kubeconfig, database snapshots
- **Remote development** — Remote development environment in a space, with kubeconfig download

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 57 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 74 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 89 / 100
  - Security: 50 / 100
  - AI Discoverability: 35 / 100
- **View full report:** https://jentic.com/apis/release.com/release/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Release.com by hand means sending both the X-User-Email and X-User-Token headers on every call and tracking app, space, and pipeline ids across nested paths. Through Jentic you install once, import Release.com from the API Directory, store both values once, and your agent calls it.
- **Permission scoping:** Release.com puts the app id in the URL path (`/apps/{app_id}/...`), and the space id under it, so a rule can pin your agent to one app or one environment. You choose the operations it may call, so destructive ones like app deletion or cluster upgrades are not included unless you add them.
- **Credential handling:** Your Release.com email and token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a preview environment' or 'abort a deploy', and Jentic returns the matching Release.com operation with its input schema so the agent calls the right endpoint.

## Related APIs

- **Render** — Hosting platform with preview environments
- **Vercel** — Frontend deploys with preview URLs
- **GitHub** — Pull requests and branches that environments are built from
- **CircleCI** — Test pipelines to run before an environment deploy

## FAQ

### What authentication does the Release.com Platform API use?

Per its OpenAPI spec, requests carry two API key headers together: X-User-Email with the user's email address and X-User-Token with the user's token, which the spec notes comes from ~/.release.yaml. Through Jentic, both values are stored encrypted by your own Jentic One instance and injected at execution time.

### Can I pause or extend an ephemeral environment with the Release.com API?

Yes. Spaces have pause and resume operations, an extend_expiration operation that pushes back the expiry, and an override_schedule operation, all addressed by app id and space id in the path.

### How do I read a build log through Jentic?

Search Jentic for 'get a Release build log'. It returns GET `/apps/{app_id}/builds/{id}/log` with its input schema; your agent supplies the app id and build id, and Jentic sends the request with your stored headers.

### What are the rate limits for the Release.com Platform API?

The OpenAPI spec does not specify rate limits. Check the Release.com documentation at https://docs.release.com for current limits.

### Is there a Release.com MCP server?

You don't need an MCP server to give your agent Release.com. Jentic connects it directly from the API Directory: import it, store your email and token once, and your agent calls it. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the Release.com Platform API?

Yes. For example, allow GET and POST under `/apps/123/spaces` plus the pause and resume operations, and your agent can create and park environments for that one app but cannot delete apps, touch clusters, or work on any other app. Every call it makes is logged.