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.

A environment is an isolated tenancy scope under your Nexio org. Every org has exactly one live environment (your production instance) and can create up to five non-prod environments for development, staging, integration testing, or anything else you need isolated from live traffic. Each environment carries its own:
  • API keys prefixed nx_<slug>_*
  • Webhook endpoints with independent signing secrets
  • Runs history scoped to that environment
  • Usage attribution rolled up to your org for billing

​
When to use an environment

  • You’re building or refactoring an integration and don’t want test traffic to mix with production data.
  • You want a dedicated environment for replay, canary, or load-testing.
  • You need different webhook delivery targets per environment (different URLs, different signing secrets).
If you just need to send a single test run from the portal UI, use the Run Tester instead (formerly called “Environment” in the sidebar — renamed to free the word for tenancy).

​
Creating an environment

  1. Open the Environment dropdown at the top of /runs, /metrics, /usage, /webhooks, or /api-keys.
  2. Select + Create environment.
  3. Choose a slug (lowercase letters, digits, underscores; 1–16 characters). Reserved slugs: live, test, internal, admin, api, nexio, draft, all (note: staging, prod, production are now claimable).
  4. Save. The portal creates the environment and prompts you to create an API key bound to it.

​
From the API

curl -X POST https://api.usenexio.com/api/v1/environments \
  -H "Authorization: Bearer nx_live_$YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "dev"
  }'
Response (201 Created): 
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "slug": "dev",
  "kind": "environment",
  "created_at": "2026-05-22T00:00:00Z"
}
(pinned_engine_version is omitted when no pin is set. After Phase 2 ships, you’ll see it as "pinned_engine_version": "1.x" or similar.)

​
Sending a run to an environment

After you have an API key for the environment, send runs the same way you do today — the auth path routes by the key. 
curl -X POST https://api.usenexio.com/api/v1/engines/<engine-slug>/runs \
  -H "Authorization: Bearer nx_dev_$YOUR_DEV_KEY" \
  -H "Content-Type: application/json" \
  -d @input.json
The resulting run row is stamped with the environment’s UUID. Runs from nx_dev_* keys appear only when you select dev in the portal’s Environment filter, never under live.

​
Filtering portal pages by environment

The Environment dropdown at the top of scoped pages writes a ?environment=<slug> URL query. The non-live options are tinted with a warning color so you can see at a glance when you’re not in production.
  • Live — your production instance. Default for new sessions.
  • <your-environment-slugs> — the non-prod environments you’ve created.
  • All — cross-environment rollup view (read-only; mutation actions disabled).
Shareable URLs include the environment scope — when you share a runs list with a teammate, they see the same filter applied.

​
Webhooks per environment

Each environment has its own webhook configuration. A run in your dev environment delivers to the dev webhook URL with the dev signing secret; it never touches your live webhook target. Set up webhook endpoints from the portal /webhooks page after selecting the target environment from the dropdown.

​
API key types

PrefixPurpose
nx_live_*Production keys. Route to your live environment.
nx_<slug>_*Non-prod keys. Route to the named environment.
nx_test_* (legacy)Grandfathered to the test environment. Continue to work; new keys should use nx_*.
A 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.

​
Limits

  • 5 non-live environments per org by default (soft cap; contact support to raise).
  • Slug regex ^[a-z0-9_]{1,16}$. Slugs are permanent — to rename, create a new environment and migrate your keys.
  • One live environment per org. Created automatically; cannot be deleted via the API.

​
See also