Skip to content
Beta. This surface may change before GA; breaking changes are dated in the changelog.

Build with Nicia

You will give each tenant a stable Brain, sync the structured records your product already owns, add source documents, and read grounded context with citations. Nicia does not replace your system of record.

  1. Overview
  2. Quickstart
  3. Add a Brain
  4. Authentication
  5. Errors and Idempotency
  6. OpenAPI reference
  1. Set API=https://api.nicia.ai and keep credentials server-side.
  2. Choose an immutable handle such as tenant:${stableTenantId}. Do not use a mutable company slug.
  3. Provision with PUT /v1/brains/{handle} and set mode to reviewed.
  4. Use your management credential only in your provisioning backend. Mint a sync key with write and review, and an agent key with read and write but never review.
  5. Write application-owned records with deterministic ids and stable idempotency keys. Approve only the change id returned by that sync write.
  6. Add non-empty source text as addressed documents. Empty record or source collections are successful no-ops; an empty document or malformed request fails validation, and missing rows never mean deletion.
  7. Run a typed query and a /context read. Surface its citations and receipt to your users.
  8. Submit an agent-authored update. It must stage for review while accepted state remains unchanged.
  9. Retry only 429 and 5xx with the same idempotency key or address, honor Retry-After, then revoke credentials and clean up your test Brain.
  • Repeating provisioning returns the same Brain.
  • Repeating a write does not create a duplicate record or change.
  • Context includes a citation for the document you added.
  • An agent key cannot settle its own staged change.
  • Empty record or source collections are successful no-ops. Empty documents and malformed input fail visibly without partial state.

See the detailed activation guide, API errors, idempotency guidance, and OpenAPI JSON.