Explorar la referencia
Todos los recursos
Voz
6 endpoints · Las descripciones de los endpoints están en inglés.
List voice memos in this household
GET
/households/{householdId}/voiceread:voice
Parámetros
| Nombre | En | Obligatorio |
|---|---|---|
| cursor | query | Opcional |
| limit | query | Opcional |
| status | query | Opcional |
| inboxOnly | query | Opcional |
Ejemplo de petición
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/voiceRespuesta200 · Success
Upload a voice memo (mp3/m4a/wav/webm/ogg, max 25 MB)
POST
/households/{householdId}/voicewrite:voice
Ejemplo de petición
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/voice \ -F "file=@receipt.jpg"Respuesta201 · Success
Get a voice memo + 300s presigned URL for the audio
GET
/households/{householdId}/voice/{voiceMemoId}read:voice
Parámetros
| Nombre | En | Obligatorio |
|---|---|---|
| voiceMemoId | path | Obligatorio |
Ejemplo de petición
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/voice/{voiceMemoId}Respuesta200 · Success
Soft-delete a voice memo
DELETE
/households/{householdId}/voice/{voiceMemoId}write:voice
Parámetros
| Nombre | En | Obligatorio |
|---|---|---|
| voiceMemoId | path | Obligatorio |
Ejemplo de petición
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X DELETE https://api.vokse.ai/households/current/voice/{voiceMemoId}Respuesta204 · No content
Materialise the parsed voice memo into a Transaction. Overrides win over the parse.
POST
/households/{householdId}/voice/{voiceMemoId}/confirmwrite:voice
Parámetros
| Nombre | En | Obligatorio |
|---|---|---|
| voiceMemoId | path | Obligatorio |
Ejemplo de petición
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/voice/{voiceMemoId}/confirmRespuesta201 · Success
Re-enqueue a failed transcription
POST
/households/{householdId}/voice/{voiceMemoId}/retrywrite:voice
Parámetros
| Nombre | En | Obligatorio |
|---|---|---|
| voiceMemoId | path | Obligatorio |
Ejemplo de petición
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/voice/{voiceMemoId}/retryRespuesta201 · Success