Skip to documentation

Opsis API / v1

Authentication

Authenticate requests and keep your API keys secure.

Authenticate a request

Send your secret key with each authenticated request. The recommended header is Authorization: Bearer. X-API-Key is also supported.

shell
curl https://api.useopsis.com/v1/me \
  -H "Authorization: Bearer $OPSIS_API_KEY"
Alternative header
curl https://api.useopsis.com/v1/me \
  -H "X-API-Key: $OPSIS_API_KEY"

Create keys in API settings. Keys authenticate your account; they don’t bypass plan eligibility, balances, or rate limits.

Keep credentials on your server

Route your application’s requests through your backend. Never ship a key in a frontend bundle, a public environment variable, a URL, or a repository. Don’t include authorization headers in logs or support reports.

Use separate named keys for each application or environment. If a key is exposed, revoke it immediately and update your integration with a replacement. Revocation is permanent.

Public endpoints

GET /v1/health and GET /v1/capabilities need no key. Use them to check availability and discover the deployed API contract before authenticating.