Explorar a referência
Todos os recursos
Assistente de IA
12 endpoints · As descrições dos endpoints estão em inglês.
List pending AI actions awaiting user confirmation. Paginated with opaque cursor.
GET
/households/{householdId}/ai/actionsai:chat
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/ai/actionsResposta200 · Success
Cancel a pending destructive action.
POST
/households/{householdId}/ai/actions/{id}/cancelai:chat
Parâmetros
| Nome | Local | Obrigatório |
|---|---|---|
| id | 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/ai/actions/{id}/cancelResposta200 · Success
Confirm and execute a pending assistant action.
POST
/households/{householdId}/ai/actions/{id}/confirmai:chat
Parâmetros
| Nome | Local | Obrigatório |
|---|---|---|
| id | 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/ai/actions/{id}/confirmResposta200 · Success
Stream a chat turn (SSE). Returns text/event-stream. 403 AI_CONSENT_REQUIRED until the ai_processing consent is granted.
POST
/households/{householdId}/ai/chatai:chat
Corpo do pedido
json
{ "message": "How much did I spend on groceries last month?"}Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/ai/chat \ -d '{"message":"How much did I spend on groceries last month?"}'Resposta201 · Success
List conversations in the household visible to the user. Ordered by updatedAt (most recent first); cursor-paginated; optional q title search.
GET
/households/{householdId}/ai/conversationsai:chat
Parâmetros
| Nome | Local | Obrigatório |
|---|---|---|
| limit | query | Opcional |
| cursor | query | Opcional |
| q | query | Opcional |
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/ai/conversationsResposta200 · Success
Fetch a single conversation (creator + household owners only).
GET
/households/{householdId}/ai/conversations/{id}ai:chat
Parâmetros
| Nome | Local | Obrigatório |
|---|---|---|
| id | path | Obrigatório |
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/ai/conversations/{id}Resposta200 · Success
PATCH
/households/{householdId}/ai/conversations/{id}ai:chat
Parâmetros
| Nome | Local | Obrigatório |
|---|---|---|
| id | path | Obrigatório |
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X PATCH https://api.vokse.ai/households/current/ai/conversations/{id}Resposta200 · Success
DELETE
/households/{householdId}/ai/conversations/{id}ai:chat
Parâmetros
| Nome | Local | Obrigatório |
|---|---|---|
| id | path | Obrigatório |
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X DELETE https://api.vokse.ai/households/current/ai/conversations/{id}Resposta204 · No content
Stop further turns on this conversation.
POST
/households/{householdId}/ai/conversations/{id}/stopai:chat
Parâmetros
| Nome | Local | Obrigatório |
|---|---|---|
| id | 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/ai/conversations/{id}/stopResposta200 · Success
Bulk-delete the current user's conversations (ids or all).
POST
/households/{householdId}/ai/conversations/bulk-deleteai:chat
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -H "Idempotency-Key: $(uuidgen)" \ -X POST https://api.vokse.ai/households/current/ai/conversations/bulk-deleteResposta200 · Success
Tools available to the current member's role (count + names).
GET
/households/{householdId}/ai/toolsai:tools
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/ai/toolsResposta200 · Success
Current user AI usage for today + daily cap + household monthly cap.
GET
/households/{householdId}/ai/usageai:tools
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \ -X GET https://api.vokse.ai/households/current/ai/usageResposta200 · Success