Authentication

API Key Authentication

The Cleanview API uses API key authentication. All requests must include a valid API key in the x-api-key header.

API keys follow this format:

cv_pub_[32 random characters base64url encoded]

Example: cv_pub_KJ3x9mN2pQ8rS7tV5wY6zA1bC4dE0fG2

Include your API key in the x-api-key header:

x-api-key: cv_pub_your_api_key_here

curl -H "x-api-key: cv_pub_your_api_key_here" \
  https://api.cleanview.co/api/v1/eia-860m

When authentication fails, the API will return a 401 Unauthorized status code with an error response:

{
  "error": "INVALID_API_KEY",
  "message": "The provided API key is invalid or has been revoked"
}

Error Code	Description
`MISSING_API_KEY`	No API key provided in the request
`INVALID_API_KEY`	API key doesn’t exist or is inactive

Keep Your API Key Secure

Never expose your API key in client-side code or public repositories
Store API keys as environment variables
Use different API keys for different environments (development, staging, production)
Regularly rotate your API keys

Server-Side Only

API keys should only be used in server-side applications. Never include them in:

Monitor Usage

Schedule a demo

During the beta phase, API keys are manually provisioned. Visit our demo page to request access.

Tell us how you plan to use the API

Let us know if you plan to use the data for internal business use only or want to integrate it into your product.

Receive your key

Our team will review your request and provide you with an API key along with any specific usage guidelines.

Future Self-Service: We’re working on a self-service API key management portal that will be available in a future version of the API.