Skip to main content

​
Authentication

All Nexio API requests (except /health) must include an API key in the X-API-Key header.

​
Header Format

X-API-Key: nx_live_YOUR_API_KEY

​
Key Types

PrefixEnvironmentBilling
nx_live_ProductionBilled per evaluation
nx_test_SandboxNot billed, test data
Use nx_test_ keys for development and integration testing. Switch to nx_live_ keys in production.

​
Obtaining API Keys

  1. Sign in to platform.usenexio.com
  2. Navigate to Settings → API Keys
  3. Click Create Key, give it a name
  4. Copy the key value — it is displayed only once

​
Example

curl https://api.usenexio.com/api/v1/jobs/eval_7xKp2mNc \
  -H "X-API-Key: nx_live_YOUR_KEY"

​
Error Responses

Missing or invalid key — 401 Unauthorized: 
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}
Key valid but access denied — 403 Forbidden: 
{
  "error": {
    "code": "forbidden",
    "message": "Access denied"
  }
}

​
Security Best Practices

  • Never embed API keys in client-side code or public repositories
  • Use nx_test_ keys in CI/CD pipelines and staging environments
  • Rotate keys periodically; revoke compromised keys immediately
  • Use one key per application / integration point — makes revocation clean