Skip to content
Start free

For developers

Build on your workspace.

Everything you do in nerix, you can do from code. Make an API key, then ask the assistant, add and search files, export documents, run long tasks and publish websites with an SDK, a command line or an AI assistant that can run commands.

Ask for accessConnecting your own software to the nerix AI hub? Read the hub page

01API keys

One key per script, with only the scopes it needs.

Open the app, go to Settings, then API keys. Choose a name and the scopes: chat, search, read documents, write documents, or admin. The key is shown once and stored only as a hash, so keep it in a secret store and never in your code. You can revoke it at any time.

  • chat

    Ask the assistant and start long tasks.

  • search

    Search your files.

  • documents:read / documents:write

    List, add and export documents.

  • admin

    Read the workspace and its usage.

02SDK

A typed client for Node.

No dependencies beyond fetch. Errors come back as typed classes with the API's own codes, and answers can stream.

import { Nerix } from "@nerix/workspace";

const nerix = new Nerix({ apiKey: process.env.NERIX_API_KEY });

const { text, citations } = await nerix.ask("What are our notice periods?");

const stream = await nerix.ask("Draft a reply", { stream: true });
for await (const { event, data } of stream) {
  if (event === "text.delta") process.stdout.write(data.delta);
}

const pdf = await nerix.documents.export(documentId, "pdf");
Fig. 1 Ask a question, stream the answer, export a document.

03Command line

The same, from a terminal.

Every command takes --json, uses plain exit codes and never prints your key, so scripts and AI agents can rely on it. The key is stored in a file only you can read.

$ nerix login
$ nerix ask "What are our notice periods?"
$ nerix files upload contract.pdf --wait
$ nerix search "notice period" --json
$ nerix tasks run "Brief on three competitors" --budget 300 --watch
$ nerix docs export <id> --format pdf --out brief.pdf
$ nerix sites publish <id>
Fig. 2 Sign in once, then work.

04AI assistants

Let an assistant work in your workspace.

An AI coding assistant that can run commands, such as Claude Code, can use the command line directly. The package includes a short AGENTS.md that tells it what each command does, what comes back and what to ask you first. Give it a key with the fewest scopes that do the job. A direct connection for assistant apps is not available yet.

The SDK and command line are in early access and installed from the repository for now. Ask us and we will send you the package.

Ask for access