Every documented route with its headers, request body and response, ready to copy into your own client.
These are the documented shapes of each route. Nothing on this page issues a request — copy a body into your own client and point it at your tenancy.
Routes
/v1/agents
Every agent the calling token can see, with its current configuration and quota position.
| Authorization | Bearer nx_live_… |
|---|---|
| Accept | application/json |
{
"data": [
{
"id": "agt_8fk2",
"name": "DataPulse",
"model": "nexus-dense-70b",
"status": "ready",
"quota": { "used": 4120311, "limit": 120000000 }
}
],
"has_more": false
}
Replace the bearer token with one issued from your own workspace. Tokens are scoped per agent and revocable individually.
/v1/agents/{id}/execute
Runs the agent against an input and returns its output plus the sources it used.
| Authorization | Bearer nx_live_… |
|---|---|
| Content-Type | application/json |
| Idempotency-Key | <uuid> |
{
"input": "Compare CAC across NA and EU for Q3",
"context": { "dataSource": "warehouse://prod/sales" },
"stream": false
}
{
"id": "run_2p91",
"status": "succeeded",
"output": "…",
"citations": [
{ "source": "warehouse://prod/sales", "rows": 1420000 }
],
"usage": { "input_tokens": 1180, "output_tokens": 640 }
}
Replace the bearer token with one issued from your own workspace. Tokens are scoped per agent and revocable individually.
/v1/workflows/{id}/runs
Triggers a workflow and returns a run identifier you can poll or subscribe to.
| Authorization | Bearer nx_live_… |
|---|---|
| Content-Type | application/json |
{
"payload": { "lead_id": "ld_4413" },
"dry_run": false
}
{
"run_id": "wr_71ba",
"status": "running",
"nodes_total": 5,
"nodes_complete": 0,
"started_at": "2026-08-20T09:14:22Z"
}
Replace the bearer token with one issued from your own workspace. Tokens are scoped per agent and revocable individually.
/v1/workflows/runs/{run_id}
The state of each node, including which one failed and why.
| Authorization | Bearer nx_live_… |
|---|
{
"run_id": "wr_71ba",
"status": "failed",
"failed_node": "crm_write",
"error": {
"code": "upstream_rejected",
"message": "CRM returned 409: duplicate external id"
},
"nodes": [
{ "id": "trigger", "status": "succeeded", "ms": 4 },
{ "id": "research", "status": "succeeded", "ms": 2810 },
{ "id": "score", "status": "succeeded", "ms": 61 },
{ "id": "draft_email", "status": "succeeded", "ms": 1204 },
{ "id": "crm_write", "status": "failed", "ms": 92 }
]
}
Replace the bearer token with one issued from your own workspace. Tokens are scoped per agent and revocable individually.
/v1/knowledge/{corpus}/documents
Adds or replaces a document in a corpus, carrying the access rules it should be retrieved under.
| Authorization | Bearer nx_live_… |
|---|---|
| Content-Type | application/json |
{
"external_id": "policy-returns-v7",
"title": "Returns policy",
"body": "…",
"acl": { "groups": ["support", "legal"] }
}
{
"id": "doc_5c02",
"external_id": "policy-returns-v7",
"chunks": 34,
"indexed": true,
"replaced_version": "policy-returns-v6"
}
Replace the bearer token with one issued from your own workspace. Tokens are scoped per agent and revocable individually.
/v1/tokens/{id}
Immediate and irreversible. In-flight requests using the token are terminated.
| Authorization | Bearer nx_live_… |
|---|
{
"id": "tok_9931",
"revoked": true,
"revoked_at": "2026-08-20T09:31:08Z",
"in_flight_terminated": 2
}
Replace the bearer token with one issued from your own workspace. Tokens are scoped per agent and revocable individually.