API overview

Base URL, request shape, pagination, idempotency and what a version means here.

A REST API over JSON. Every request is authenticated with a bearer token, every resource belongs to the organisation that token belongs to, and every write can be retried safely.

POST /v1/credentials HTTP/1.1
Host: api.nomi-tech.com
Authorization: Bearer nomi_sk_live_EXAMPLE
Content-Type: application/json
Idempotency-Key: order_example_12345

Base URL and version

Everything lives under https://api.nomi-tech.com. The /v1 prefix is the API's version: fields are added to responses without notice, and nothing is removed or given a new meaning inside a version.

Pagination

List endpoints take limit (1–100, default 25) and page in one of two ways. cursor is the nextCursor from the previous response and is what a job should use. offset also returns total, which is what a screen showing page numbers needs.

{
  "data": [ … ],
  "nextCursor": "…",
  "total": 1284
}

Idempotency

Send an Idempotency-Key on any POST or PATCH and a retry replays the first response instead of doing the work twice. Keys live for 24 hours and are scoped to your organisation. Three cases:

• Same key, same request, already answered — the stored response is replayed.
• Same key, a different request — refused. Serving the first answer to a second, different call is a write that disappears silently.
• Same key, still running — 409. Retry in a moment.