API reference

The complete Neens HTTP API — 469 endpoints, generated from the live OpenAPI schema (version 0.16.6) so it can’t drift from the running service.

Authentication

Programmatic and ingest calls authenticate with a project API key (nk_live_…) sent as a bearer token:

curl https://YOUR-NEENS-HOST/sessions \
  -H "Authorization: Bearer nk_live_your_key_here"

Create keys under Settings → API keys (see API keys). The in-app UI uses nk_sess_… session cookies instead. A key resolves to exactly one company + project, so it can’t read or write another tenant’s data.

Explore it

• Read it here — browse by pillar in the sidebar; each endpoint lists its parameters, request body, and responses.
• Download the spec — /docs/openapi.json for Postman, code generation, or feeding an agent.
• Try it live — on a local or development run, a Neens instance serves interactive Swagger UI at /api-docs and ReDoc at /api-redoc. On a hosted instance these interactive explorers may not be reachable — use the downloadable spec above instead.

For agents & LLMs

Neens publishes llms.txt files so coding agents and LLM tools can discover and read the docs efficiently:

• /docs/llms.txt — a curated map of every documentation page.
• /docs/llms-full.txt — the entire documentation as one plain-text file, ready to paste into a model’s context.

Point your agent at these alongside the openapi.json above.

Versioning

This reference tracks platform release 0.16.6 (the schema’s info.version). Breaking changes ship with a release bump. The OTLP ingest path /v1/traces follows the stable OpenTelemetry contract and is safe to hard-code.

Sections

• Ingest & observe — Send traces and read back sessions, conversations, agents, and the agent topology.
• Diagnose — Failure clustering, the failure-mode taxonomy and Issues, topics, and insights.
• Evaluate — Judges, scores, enrichments, datasets, human annotations & review, and pre-prod eval runs.
• Fix & ship — Typed remediations, the evals-from-failures flywheel, and deploy-event correlation.
• Analyze — Custom dashboards, the metrics catalogue, and saved analyses.
• Assistant & prompts — The in-app chat assistant — questions plus approval-gated writes — and the versioned prompt registry.
• Administration — Tenancy, members & auth, personas, settings & LLM connections, retention, and the audit log.
• More endpoints — Additional endpoints not grouped above.