> ## Documentation Index
> Fetch the complete documentation index at: https://nemonist.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> The nemonist API: OpenRouter-compatible, at https://nemonist.com/api/v1.

Every endpoint is under `https://nemonist.com/api/v1` and takes a nemonist key as a bearer token:

```bash theme={null}
curl https://nemonist.com/api/v1/models -H "Authorization: Bearer $NEMONIST_API_KEY"
```

Pages in this section are generated from nemonist's OpenAPI spec; each has a playground that sends the request to nemonist with your key.

## Endpoints

| Area | Endpoints |
| - | - |
| Model requests | Chat completions, Responses, Anthropic Messages, embeddings, rerank, images, audio |
| Models | Models, endpoints, providers, benchmarks |
| Account | API keys, credits, activity, generations, workspaces, organization members |
| Memory | Read a workspace's memory and graph, send to its inbox, erase all memory |
| Folders | Your memory folders: notes, requests, files, jobs, keys, export |

## Memory

* [`GET /memory-file`](https://nemonist.com/docs/api-reference/memory/read-a-workspaces-memory) returns one project's memory: each file's text and summary, and the latest memory reads and edits with their reason, model and time. Send the contents of the project's `.nemonist/key` in the `x-nemonist-workspace-key` header.
* [`DELETE /memory`](https://nemonist.com/docs/api-reference/memory/erase-all-memory) erases every project's memory under your account, and the request records kept for it. It cannot be undone.
* [`GET /memory-graph`](https://nemonist.com/docs/api-reference/memory/get-a-workspaces-memory-graph) returns the project's memory graph: notes, turns, judgments, work items and jobs, and how they connect. Named by `x-nemonist-workspace-key`, like `/memory-file`.
* [`POST /inbox`](https://nemonist.com/docs/api-reference/memory/send-a-message-to-a-folder) queues a message for the project's next turn; your agent sees it then, and [`GET /inbox`](https://nemonist.com/docs/api-reference/memory/list-a-folders-inbox-by-its-key) lists each message with the reply it got.

## Folders

The folder endpoints take your account's API key alone and answer only your own folders; another member's folder is not found. Each folder's id (`fld_...`) comes from [`GET /folders`](https://nemonist.com/docs/api-reference/folders/list-your-folders).

* Read: the folder, one note, its memory graph, its server-side tool use, its inbox and its jobs.
* [`GET /folders/{id}/history`](https://nemonist.com/docs/api-reference/folders/list-recorded-requests) lists the requests it served; [`GET /folders/{id}/history/{commit}`](https://nemonist.com/docs/api-reference/folders/read-a-recorded-request) returns one exactly as your client sent it.
* [`GET /folders/{id}/export`](https://nemonist.com/docs/api-reference/folders/export-a-folder) returns every note, work item and judgment as JSON Lines.
* Files: list, upload (one signed URL, or multipart for a large file), download, and [delete](https://nemonist.com/docs/api-reference/folders/delete-an-uploaded-file.md) for good.
* Change: rename, nightly sleep on or off, issue or revoke a key, merge into another folder, erase.

### From a terminal: `nemonist`

`nemonist` reads a folder from your shell the way `git log` and `gh` read a repository. It is one Python 3 file with nothing else to install:

```bash theme={null}
mkdir -p ~/.local/bin && curl -fsSLo ~/.local/bin/nemonist https://nemonist.com/nemonist && chmod +x ~/.local/bin/nemonist
export PATH="$PATH:$HOME/.local/bin"
export NEMONIST_API_KEY=sk-nm-...    # your account API key
```

Add the two `export` lines to `~/.zshrc` or `~/.bashrc` to keep them. Run it inside a project: it reads the folder from the nearest `.nemonist/config` above you, or takes `--folder fld_...`.

| Command | What it shows |
| - | - |
| `nemonist folder list`, `nemonist folder view` | Your folders; one folder with its index |
| `nemonist log [-S text] [--author A] [--since D] [--until D] [-n N] [--oneline] [-- path]` | Commits, newest first, every page |
| `nemonist show <commit>` | One commit: parent, checks (the turn's judgments) and each note's change |
| `nemonist show <commit>:<path>` | The note as that commit left it |
| `nemonist ls-tree [commit]` | Every note as that commit left the folder |
| `nemonist diff <a> [<b>] [--stat]` | A unified diff of the whole folder between two commits (`b` is today when left out), as `git diff a b`; `--stat` prints each changed note with its line counts and a total. A note the kept history cannot rebuild at either end is named on stderr and the command exits 1 |
| `nemonist diff <a> [<b>] -- <path>` | A unified diff of one note between two commits (`b` is today when left out) |
| `nemonist tag`, `nemonist tag create <name> [commit] [-m msg]`, `nemonist tag delete <name>` | Tags |
| `nemonist archive [commit] [-o file]` | The notes at that commit as a zip |
| `nemonist stats` | Contributors and commit activity |
| `nemonist blame <path> [--at commit]` | Each line of a note beside the commit that last changed it; `?` where the kept history cannot tell |
| `nemonist goal list [--state open\|closed\|all]`, `nemonist goal view <id>` | Work items, as `gh issue list` and `gh issue view` |
| `nemonist goal edit <id> --parent <item> --reason WHY` (`--parent ""` removes it) | Make a work item part of another, as GitHub's sub-issues (at most 7 layers and 100 parts, no circle); `goal list` shows each parent's `(closed/total)` and `goal view` its parts |
| `nemonist goal insights [--period 2W\|1M\|3M\|max] [-q filter]` | The goals' burn up, as GitHub Projects' Insights: goals open and closed at the end of each UTC day, and today's counts by state, role and progress |

A commit can be a tag or the first characters of its id (at least four). `--json` prints the API's own objects. When the kept history cannot rebuild a version, or cannot say whether a note existed at that commit, `nemonist` says so and exits 1 rather than guess. `nemonist blame` marks a line it cannot place with `?` and never names a guessed commit. Your key is sent only to `https://nemonist.com`; to use another API, name it yourself with `--api` or `NEMONIST_API`. A `.nemonist/config` that names any other endpoint is refused, so a cloned project cannot redirect your key.

## Errors

Errors are JSON, `{"error": {"code": ..., "message": ...}}`. See [Errors and retries](https://nemonist.com/docs/concepts/errors.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.