Skip to content

Jump to

Notes API

Organization-wide notes that let agents (and humans) record context, observations, or scratch thoughts that persist beyond a single conversation. Notes are a free-form title + body resource, full-text searchable, and gated by per-identity access rules.

Visibility model: agent-created notes are auto-granted to the creating identity and are invisible to every other agent until a user in the Inkbox Console — or a caller using an admin-scoped API key — grants them. Users on the Console always see every note in the org regardless of grants.

API base URL:

https://inkbox.ai/api/v1/notes

Quick start

Create an account and get your API key from the Inkbox console:

X-API-Key: YOUR_API_KEY

Notes

Create note

Create a new note (title optional, body required)

List notes

List accessible notes with optional full-text search

Get note

Get a single note by ID

/api/v1/notes/{note_id}

Update note

Update title or body with JSON-merge-patch semantics

/api/v1/notes/{note_id}

Delete note

Delete a note

/api/v1/notes/{note_id}

Access control

Grant identity access

Grant an agent identity read/CRUD access to a note (admin only)

/api/v1/notes/{note_id}/access

List access rules

List every identity granted access to a note

/api/v1/notes/{note_id}/access

Revoke identity access

Revoke an identity (claimed agents may only self-revoke)

/api/v1/notes/{note_id}/access/{identity_id}

Additional resources