In der Referenz stöbern
Alle Ressourcen
Sprache
6 Endpunkte · Die Endpunktbeschreibungen sind auf Englisch.
List voice memos in this household
GET
/households/{householdId}/voiceread:voice
Parameter
| Name | Ort | Erforderlich |
|---|---|---|
| cursor | query | Optional |
| limit | query | Optional |
| status | query | Optional |
| inboxOnly | query | Optional |
Beispielanfrage
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/voiceAntwort200 · Success
Upload a voice memo (mp3/m4a/wav/webm/ogg, max 25 MB)
POST
/households/{householdId}/voicewrite:voice
Beispielanfrage
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/voice \ -F "file=@receipt.jpg"Antwort201 · Success
Get a voice memo + 300s presigned URL for the audio
GET
/households/{householdId}/voice/{voiceMemoId}read:voice
Parameter
| Name | Ort | Erforderlich |
|---|---|---|
| voiceMemoId | path | Erforderlich |
Beispielanfrage
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/voice/{voiceMemoId}Antwort200 · Success
Soft-delete a voice memo
DELETE
/households/{householdId}/voice/{voiceMemoId}write:voice
Parameter
| Name | Ort | Erforderlich |
|---|---|---|
| voiceMemoId | path | Erforderlich |
Beispielanfrage
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X DELETE https://api.vokse.ai/households/current/voice/{voiceMemoId}Antwort204 · No content
Materialise the parsed voice memo into a Transaction. Overrides win over the parse.
POST
/households/{householdId}/voice/{voiceMemoId}/confirmwrite:voice
Parameter
| Name | Ort | Erforderlich |
|---|---|---|
| voiceMemoId | path | Erforderlich |
Beispielanfrage
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/voice/{voiceMemoId}/confirmAntwort201 · Success
Re-enqueue a failed transcription
POST
/households/{householdId}/voice/{voiceMemoId}/retrywrite:voice
Parameter
| Name | Ort | Erforderlich |
|---|---|---|
| voiceMemoId | path | Erforderlich |
Beispielanfrage
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/voice/{voiceMemoId}/retryAntwort201 · Success