Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.usenexio.com/llms.txt

Use this file to discover all available pages before exploring further.

All /api/v1/* requests require a Bearer token in the Authorization header. GET /health is the only unauthenticated public endpoint.
Authorization: Bearer nx_live_YOUR_API_KEY

Key types

PrefixRoutes toNotes
nx_live_The org’s live environmentProduction traffic. Real data.
nx_<slug>_The named non-prod environmentPer-environment isolated webhooks, runs history, and usage attribution. See the environments guide.
nx_test_The org’s test environment (grandfathered)Existing keys continue to work; new non-prod integrations should use nx_*.
Every key is bound to exactly one environment at creation. To move work to a different environment, create a new key in the target environment and rotate to it.

Creating keys

  1. Sign in at platform.usenexio.com
  2. Open Settings → API Keys
  3. Click Create, give it a descriptive name, copy the value
Keys are shown only once. If you lose one, revoke it and create a new one.

Revoking keys

Go to Settings → API Keys, find the key, click Revoke. Revoked keys return 401 immediately.

Error response

{
  "code": "unauthorized",
  "message": "Missing or invalid API key"
}
If API key lookup is temporarily unavailable, the API returns 503 with code: "auth_unavailable".
Never embed API keys in client-side code or public repositories. Use one key per integration point so revocation stays clean.