Skip to main content
VVela
Try the API

Authentication

Every request to ImagePipeline requires an X-API-Key header. Get your key from the dashboard.

X-API-Key: <your_api_key>

The security scheme, from the OpenAPI spec:

securitySchemes:
  ApiKeyAuth:
    type: apiKey
    in: header
    name: X-API-Key

Example​

curl https://api.imagepipeline.io/health \
  -H "X-API-Key: $IMAGEPIPELINE_API_KEY"

Handling keys safely​

  • Treat your API key as a secret — never commit it or ship it in client-side code.
  • Store it in an environment variable:
export IMAGEPIPELINE_API_KEY="<your_api_key>"
  • Rotate keys from the dashboard if one is exposed.
warning

A missing or invalid key is rejected. See Errors for the full error model and failure reason codes.