Data model

Notes

A voice note. Holds title + free-form body (the transcription, editable like any Samsung-style note) + tags + favourite + colour. Parent for one or many recording rows.

Model name: voice_note
Endpoints: 5
Max page size: 200

Fields

Per-field validation rules. Values that violate any constraint are rejected with 400 before they reach the database.

FieldTypeConstraints
bodystring
max length65000
tagstags-
colorstring
max length24
titlestring
max length200
pinnedbool-
favoritebool-
last_recording_atstring
max length32
last_recording_idstring
max length64
updated_at_markerstring
max length32

Mutability

Which fields can you send, and when? Anything without a marker is server-managed - sending it isn't an error, it's silently ignored.

Create-only - read from POST body.Patchable - read from PATCH body.Server-managed - ignored on the body.
FieldCreatePatch
body
tags
color
title
pinned
favorite
last_recording_at
last_recording_id
updated_at_marker

Fields marked create-only but not patchable are immutable after creation. Server-managed fields include id, timestamps, ownership, and status.

Filtering & sorting

Combinable on list endpoints. Repeating a filter key produces an IN clause; prefixing a sort key with - reverses direction. Example: ?status=open&status=blocked&sort=-created_at.

Filter keys

favoritedata__favorite
tagsdata__tags
colordata__color
pinneddata__pinned
statusstatus
is_archivedis_archived
owned_byowned_by

Sort keys

created_atcreated_at
updated_atupdated_at
titledata__title
last_recording_atdata__last_recording_at

Default: -data__last_recording_at

Endpoints

Each endpoint below lists its HTTP method, path, and the PAT scope it needs. Code samples cover curl, JavaScript, TypeScript, Python, Rust, Java, and WebSocket.

GET/xapi2/data/voice_notevoice_note:list

List objects

Returns a paginated list of objects you can read. Default page size is 20; pass ?limit= to change (capped per type). Use ?after=<id> for keyset pagination on created_at-sorted lists, or ?offset= for offset paging.

curl -H "Authorization: Bearer pat_…" \
     "https://sprachmemo.de/xapi2/data/voice_note?limit=20"
GET/xapi2/data/voice_note/{id}voice_note:read

Read one

Returns the object by id. 404 if it does not exist or you cannot read it (the two cases are intentionally conflated).

curl -H "Authorization: Bearer pat_…" \
     https://sprachmemo.de/xapi2/data/voice_note/OBJECT_ID
POST/xapi2/data/voice_notevoice_note:create

Create

Creates a new object. Body is a flat JSON dict of field values. Server-side fields (id, timestamps, ownership) are filled automatically; only fields listed below as creatable are read from the body.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X POST https://sprachmemo.de/xapi2/data/voice_note \
     -d '{"name": "…"}'
PATCH/xapi2/data/voice_note/{id}voice_note:update

Update

Partial update. Only fields included in the body are touched; everything else is preserved. Same allow-list as create, minus the fields that are immutable post-create.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X PATCH https://sprachmemo.de/xapi2/data/voice_note/OBJECT_ID \
     -d '{"name": "…"}'
DELETE/xapi2/data/voice_note/{id}voice_note:delete

Delete

Removes the object. It vanishes from every default list immediately and stops being returned by read / list.

curl -H "Authorization: Bearer pat_…" \
     -X DELETE https://sprachmemo.de/xapi2/data/voice_note/OBJECT_ID

Use in CLI

The same endpoints are also exposed via the Sprachmemo CLI. For scripts, CI, and bulk imports it's usually the faster path.

voicecli voice_note list --limit 5
voicecli voice_note get <id>
voicecli voice_note create --title "Hello"
voicecli voice_note upsert --unique title --csv items.csv
voicecli voice_note schema   # fields & limits

Full command reference, profiles, CSV import, auto-retry, NDJSON streaming → /docs/cli