Skip to main content

​
API Keys

API keys allow your applications to access Neural Factory programmatically via the REST API. Administrators can create, manage, and revoke API keys from the API Keys section.

​
Creating an API key

1

Navigate to API Keys

Open API Keys from the sidebar (admin section).
2

Click Create API Key

Click the Create API Key button.
3

Configure the key

  • Name — A descriptive name to identify this key (e.g., “Production Backend”, “CI/CD Pipeline”)
  • Permissions — Select what the key can access (varies by deployment)
4

Copy the key

The API key is displayed once after creation. Copy it immediately — you won’t be able to see it again.
Store your API key securely. Do not commit it to version control, share it in chat, or include it in client-side code.

​
Managing API keys

The API Keys page shows all active keys:
  • Name — The descriptive name you gave the key
  • Created — When the key was created
  • Last used — When the key was last used for an API call
  • Status — Active or Revoked

​
Revoking a key

To revoke an API key:
  1. Find the key in the list
  2. Click Revoke
  3. Confirm the action
Revoked keys immediately stop working. Any application using the key will receive authentication errors.

​
Using API keys

Include the API key in your API requests as a Bearer token in the Authorization header:
Agent work is asynchronous: POST /chat starts a task and returns a handle, which you then poll, stream, or receive by webhook. See The durable-run model for the request format and the three ways to collect a result. See the API Reference for full documentation on available endpoints.

​
Best practices

  • Create separate keys for each application or environment
  • Rotate keys periodically — revoke old keys and create new ones
  • Monitor the “Last used” column to identify unused keys
  • Revoke keys immediately if they may have been compromised
  • Send an idempotency_key when retrying a request, so a network retry re-attaches to the original task instead of starting — and billing — a second one
  • Expect 429 responses: keys are subject to the same parallel-task limits as the UI, counted against the key’s owner, so back off on Retry-After rather than retrying immediately