Authentication

Authenticate Pipevideo API requests with Bearer API keys.

API keys

Create API keys in the Pipevideo dashboard under API Keys. Keys are prefixed with pv_ and shown only once at creation.

Bearer token

Pass your key in the Authorization header:

Authorization: Bearer pv_your_api_key

Example

curl https://api.pipevideo.co/v1/usage \
  -H "Authorization: Bearer pv_your_api_key"

Key lifecycle

StateBehavior
ActiveAuthenticates requests normally
RevokedReturns 401 Invalid API key
ExpiredReturns 401 API key has expired (if expiration was set)
InactiveReturns 401 API key is inactive

Scoping

Each API key belongs to one organization. Requests authenticated with a key operate within that organization's scope — credit balance, generation history, and usage data are org-scoped automatically. No additional headers are required.

Public endpoints

GET /v1/engines does not require authentication. All other endpoints require a valid API key.

Security practices

  • Store keys in a secret manager, not source code.
  • Rotate keys on a schedule and after suspected compromise.
  • Use separate keys per environment (production, staging).

See API keys for detailed guidance.

Error responses

StatusMeaning
401Missing, invalid, expired, or inactive API key

See Errors for the full error reference.