For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authentication

Getting Your Credentials

  1. Run release auth login

  2. Your credentials are stored in ~/.release.yaml:

login: [email protected]
token: your-api-token

Note: The key is login, not email. This is a common source of confusion when scripting.

You can also retrieve your token from web.release.com/profile.

User Authentication

Use these headers for most API operations, including all AI Sandbox and GraphQL API calls:

Header
Value
Description

X-User-Email

login from ~/.release.yaml

Your Release account email

X-User-Token

token from ~/.release.yaml

Your authentication token

Account Authentication

Some Platform API endpoints use account-level credentials instead. Find these values in Account Settings > Account Info:

Header
Value
Description

X-Account-ID

Account ID

Your Release account ID

X-Account-Token

Account token

Account-level authentication token

Which Headers to Use

Each endpoint's documentation specifies which authentication method it requires. When in doubt:

  • Platform API: Most endpoints accept both; account-level auth is required for CI/CD integrations

  • AI Sandbox API: Always use user authentication (X-User-Email + X-User-Token)

  • GraphQL API: Always use user authentication (X-User-Email + X-User-Token)

Last updated

Was this helpful?