Datenmodell

Aufnahmen

Ein einzelner Audio-Clip unter einer übergeordneten note. Verweist via data.blob_id auf eine S3-Datei, kennt duration_seconds + sample_rate + mime und trägt ein freies transcriptions-JSONB, indexiert nach Modellname (vosk_small, vosk_large, künftige Engines) - so können wir später erneut transkribieren, ohne das alte Ergebnis zu verlieren. Aktiv ist jeweils das Modell unter data.primary_model.

Modellname: recording

Endpunkte: 5

Max. Seitengröße: 200

Felder

Validierungsregeln pro Feld. Werte, die diese Bedingungen verletzen, werden mit 400 abgewiesen, bevor sie die Datenbank erreichen.

Feld	Typ	Regeln
mime	`string`	max. Länge`64`
state	`enum`	enum`uploading \| ready \| transcribing \| transcribed \| failed`
blob_id	`string`	max. Länge`64`
channels	`number`	-
filename	`string`	max. Länge`200`
language	`string`	max. Länge`8`
client_id	`string`	max. Länge`64`
parent_id	`string`	max. Länge`64`ref →`voice_note`owned
size_bytes	`number`	-
recorded_at	`string`	max. Länge`32`
sample_rate	`number`	-
primary_model	`string`	max. Länge`32`
transcriptions	`dict`	-
requested_model	`string`	max. Länge`32`
appended_to_body	`bool`	-
duration_seconds	`number`	-
transcription_error	`string`	max. Länge`400`

Mutabilität

Welche Felder darfst du senden, und wann? Felder ohne Markierung werden vom Server vergeben - das Senden ist kein Fehler, sie werden stillschweigend ignoriert.

Anlegbar - im POST-Body lesbar.Änderbar - im PATCH-Body lesbar.Server-verwaltet - vom Body ignoriert.

Feld	Typ	Anlegbar	Änderbar
mime	string
state	enum
blob_id	string
channels	number
filename	string
language	string
client_id	string
parent_id	string
size_bytes	number
recorded_at	string
sample_rate	number
primary_model	string
transcriptions	dict
requested_model	string
appended_to_body	bool
duration_seconds	number
transcription_error	string
transcript_edit	-

Felder mit Anlegbar, aber ohne Änderbar, sind nach dem Erstellen unveränderlich. Server-verwaltete Felder umfassen id, Zeitstempel, Eigentümerschaft und Status.

Filter & Sortierung

Auf Listen-Endpunkten kombinierbar. Wiederholte Filter-Keys werden zu IN-Bedingungen, ein - vor einem Sort-Key kehrt die Richtung um. Beispiel: ?status=open&status=blocked&sort=-created_at.

Filter-Keys

parent_iddata__parent_id

statedata__state

primary_modeldata__primary_model

statusstatus

is_archivedis_archived

owned_byowned_by

Sortier-Keys

created_atcreated_at

recorded_atdata__recorded_at

Standard: -data__recorded_at

Endpunkte

Jeder Endpunkt unten zeigt seine HTTP-Methode, den Pfad und den dafür benötigten PAT-Scope. Code-Beispiele decken curl, JavaScript, TypeScript, Python, Rust, Java und WebSocket ab.

GET/xapi2/data/recordingrecording:list

Objekte auflisten

Liefert eine paginierte Liste sichtbarer Objekte. Standard-Seitengröße 20; mit ?limit= änderbar (typabhängig begrenzt). ?after=<id> für Keyset-Paginierung bei nach created_at sortierten Listen, ?offset= für Offset-Paginierung.

curl -H "Authorization: Bearer pat_…" \
     "https://sprachmemo.de/xapi2/data/recording?limit=20"

GET/xapi2/data/recording/{id}recording:read

Einzelnes Objekt lesen

Liefert das Objekt anhand der ID. 404, falls es nicht existiert oder du keinen Lese-Zugriff hast (beide Fälle sind bewusst zusammengelegt).

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

POST/xapi2/data/recordingrecording:create

Erstellen

Erstellt ein neues Objekt. Der Body ist ein flaches JSON-Dict mit Feldwerten. Server-seitige Felder (id, Zeitstempel, Ownership) werden automatisch gefüllt; nur die unten als anlegbar gelisteten Felder werden aus dem Body übernommen.

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

PATCH/xapi2/data/recording/{id}recording:update

Aktualisieren

Teilweise Aktualisierung. Nur Felder im Body werden verändert; alles andere bleibt erhalten. Gleiche Erlaubnisliste wie bei Create, abzüglich der nach dem Anlegen unveränderlichen Felder.

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

DELETE/xapi2/data/recording/{id}recording:delete

Löschen

Entfernt das Objekt. Es verschwindet sofort aus allen Standard-Listen und wird von read / list nicht mehr zurückgegeben.

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

In der CLI

Dieselben Endpunkte sind auch über die Sprachmemo CLI verfügbar. Für Skripte, CI und Bulk-Imports ist sie meist die schnellere Wahl.

voicecli recording list --limit 5
voicecli recording get <id>
voicecli recording create --parent-id "Hello"
voicecli recording upsert --unique parent_id --csv items.csv
voicecli recording schema   # Felder & Limits

Volle Befehlsreferenz, Profile, CSV-Import, Auto-Retry, NDJSON-Streaming → /docs/cli