Skip to main content

​
Overview

Our API uses date-based versioning to ensure backward compatibility and provide clear migration paths as we evolve the platform. Each Auth Client is automatically configured with an API version, which determines the behavior and available features for your requests.

​
Version Headers

Every API response includes an X-API-Version header that indicates which version was used to process your request. This helps you track and debug version-specific behavior. 
X-API-Version: 2025-12-01.chucky
You can override the Auth Client’s default version by providing your own X-API-Version header in the request: 
curl https://api.example.com/v1/resource \
  -H "X-API-Version: 2025-12-01.chucky" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Default Behavior

When creating a new Auth Client, it will automatically be configured to use the latest stable API version. This ensures your integration starts with a reliable, production-ready version of the API.

​
Version Selection

Different API version documentations are accessible via the version selector in the top left corner of the documentation.

​
Upgrading Your API Version

To permanently upgrade your Auth Client to a newer API version:
  1. Go to Dashboard > Developer Settings
  2. Edit your Auth Client
  3. Select the new API version from the dropdown
  4. Save your changes
All future requests using that client’s token will use the new version.
You can test a newer version before committing by passing the X-API-Version header in your requests. This lets you verify compatibility without changing your client’s default version.
curl https://api.nomos.energy/v1/resource \
  -H "X-API-Version: 2026-01-29.edison" \
  -H "Authorization: Bearer YOUR_TOKEN"
Once you’ve confirmed everything works, upgrade your client’s version in the dashboard.

​
Currently available versions:

VersionValueDescription
chucky2025-12-01.chuckyInitial stable release
batman2025-12-16.batmanPrevious release
edison2026-01-29.edisonLatest release