Overview

The REST API lets your app manage workspaces, providers, models, prompts, mappings, workflows, indexes, quotas, and metrics. It is served under one base URL.

https://app.nemu.cc/api/v1

Authentication

Every request carries a bearer token. Get one by running an OAuth flow, then send it in the Authorization header.

string

required

Bearer <access_token>

How to get a token

Versioning

Pin a dated version with the Nemu-Api-Version header. Omit it to use the latest version. Every response echoes the version it was served with.

string

A dated version such as 2026-07-14.

See versioning for the full details.

Response shape

A list endpoint wraps its rows in data, and often includes a total. A single item endpoint wraps the item in data.

{
  "data": [
    { "id": "ws_1", "name": "prod" },
    { "id": "ws_2", "name": "staging" }
  ],
  "total": 2
}

Three endpoints do not follow this shape:

Endpoint	Shape
Indexes	Bare arrays and bare objects, with no `data`
Workspace budget	A bare object, with no `data`
Metrics list	`data` plus a nested `pagination` object

PATCH responses return { "success": true } and no data. Re-read the item if you need its new state.

Workspace scoped resources

Providers, models, prompts, mappings, and workflows belong to a workspace. Pass the workspace on reads as a workspace_id query parameter.

GET /api/v1/providers?workspace_id=ws_1

Writes are not workspace scoped. A create always lands in your account’s default workspace, and a workspace_id in the body is ignored. Indexes are resolved from the default workspace on reads as well.

Updates replace, they do not merge

Every PATCH validates the same schema as the matching POST, so the required fields on create are required on update too. Sending only the fields you changed returns 400. PUT is accepted wherever PATCH is and behaves identically.

Verbs

Verb	Use
`GET`	Read a collection or a single item
`POST`	Create an item
`PATCH`	Update fields on an item
`PUT`	Replace an item, accepted wherever `PATCH` is
`DELETE`	Remove an item

Status codes

Code	Meaning
`200`	Success
`400`	Invalid body or unsupported API version
`401`	Missing, invalid, or expired token
`403`	The token lacks the scope or the account lacks permission
`404`	The item was not found
`409`	A conflict, such as a duplicate name
`429`	Rate limited, check the `Retry-After` header

Rate limits

Responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. When you exceed a limit the API returns 429 with a Retry-After header in seconds.

Resources

Resource	Base path	Scope
User	`/user`	`profile:read`
Workspaces	`/workspaces`	`workspaces:read`, `workspaces:write`
Providers	`/providers`	`providers:read`, `providers:write`
Models	`/models`	`models:read`, `models:write`
Mappings	`/mappings`	`mapping:read`, `mapping:write`
Prompts	`/prompts`	`prompts:read`, `prompts:write`
Workflows	`/workflows`	`models:read`
Indexes	`/indexes`	Any authenticated token
Quotas	`/quotas`	`quotas:read`, `quotas:write`
Metrics	`/metrics`	`usage:read`

Get started

Setup

API reference

Authentication

How to get a token

Versioning

Response shape

Workspace scoped resources

Updates replace, they do not merge

Verbs

Status codes

Rate limits

Resources

​Authentication

How to get a token

​Versioning

​Response shape

​Workspace scoped resources

​Updates replace, they do not merge

​Verbs

​Status codes

​Rate limits

​Resources

Authentication

Versioning

Response shape

Workspace scoped resources

Updates replace, they do not merge

Verbs

Status codes

Rate limits

Resources