Explorar a referência

Voz

6 endpoints · As descrições dos endpoints estão em inglês.

List voice memos in this household

GET/households/{householdId}/voice

read:voice

Parâmetros

Nome	Local	Obrigatório
cursor	query	Opcional
limit	query	Opcional
status	query	Opcional
inboxOnly	query	Opcional

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/voice

Resposta200 · Success

Upload a voice memo (mp3/m4a/wav/webm/ogg, max 25 MB)

POST/households/{householdId}/voice

write:voice

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/voice \     -F "file=@receipt.jpg"

Resposta201 · Success

Get a voice memo + 300s presigned URL for the audio

GET/households/{householdId}/voice/{voiceMemoId}

read:voice

Parâmetros

Nome	Local	Obrigatório
voiceMemoId	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/voice/{voiceMemoId}

Resposta200 · Success

Soft-delete a voice memo

DELETE/households/{householdId}/voice/{voiceMemoId}

write:voice

Parâmetros

Nome	Local	Obrigatório
voiceMemoId	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X DELETE https://api.vokse.ai/households/current/voice/{voiceMemoId}

Resposta204 · No content

Materialise the parsed voice memo into a Transaction. Overrides win over the parse.

POST/households/{householdId}/voice/{voiceMemoId}/confirm

write:voice

Parâmetros

Nome	Local	Obrigatório
voiceMemoId	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/voice/{voiceMemoId}/confirm

Resposta201 · Success

Re-enqueue a failed transcription

POST/households/{householdId}/voice/{voiceMemoId}/retry

write:voice

Parâmetros

Nome	Local	Obrigatório
voiceMemoId	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/voice/{voiceMemoId}/retry

Resposta201 · Success