shield-exclamationAuthentication

AlphaNeural uses API keys for all requests. Send your key in an HTTP header over HTTPS.

Where to put the API key

Send the key as a Bearer token:

-H "Authorization: Bearer $ALPHANEURAL_API_KEY"

This is the style used throughout the proxy examples in the OpenAPI spec.

Option B. Proxy-native header style

Send the key in x-alphaneural-api-key:

-H "x-alphaneural-api-key: $ALPHANEURAL_API_KEY"

This header is defined as the security scheme in the OpenAPI spec (source of truth).

Quick test

List models (any authenticated endpoint works):

curl https://proxy.alfnrl.io/v1/models \
  -H "Authorization: Bearer $ALPHANEURAL_API_KEY"

Using the OpenAI SDKs

Because AlphaNeural is OpenAI-compatible, you can point the OpenAI SDKs at the AlphaNeural base URL and keep the rest of your code the same.

Python

Node.js / Javascript

Security notes

  • Treat API keys like passwords. Keep them server-side and load them from environment variables or a secrets manager.

  • Rotate keys if they are ever exposed. Admin endpoints and usage reporting are also protected by the same API key mechanism in the spec.

Last updated