Explorar la referencia

Asistente de IA

12 endpoints · Las descripciones de los endpoints están en inglés.

List pending AI actions awaiting user confirmation. Paginated with opaque cursor.

GET/households/{householdId}/ai/actions

ai:chat

Ejemplo de petición

bash

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

Respuesta200 · Success

Cancel a pending destructive action.

POST/households/{householdId}/ai/actions/{id}/cancel

ai:chat

Parámetros

Nombre	En	Obligatorio
id	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/ai/actions/{id}/cancel

Respuesta200 · Success

Confirm and execute a pending assistant action.

POST/households/{householdId}/ai/actions/{id}/confirm

ai:chat

Parámetros

Nombre	En	Obligatorio
id	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/ai/actions/{id}/confirm

Respuesta200 · 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/chat

ai:chat

Cuerpo de la petición

json

{  "message": "How much did I spend on groceries last month?"}

Ejemplo de petición

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?"}'

Respuesta201 · 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/conversations

ai:chat

Parámetros

Nombre	En	Obligatorio
limit	query	Opcional
cursor	query	Opcional
q	query	Opcional

Ejemplo de petición

bash

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

Respuesta200 · Success

Fetch a single conversation (creator + household owners only).

GET/households/{householdId}/ai/conversations/{id}

ai:chat

Parámetros

Nombre	En	Obligatorio
id	path	Obligatorio

Ejemplo de petición

bash

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

Respuesta200 · Success

PATCH/households/{householdId}/ai/conversations/{id}

ai:chat

Parámetros

Nombre	En	Obligatorio
id	path	Obligatorio

Ejemplo de petición

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X PATCH https://api.vokse.ai/households/current/ai/conversations/{id}

Respuesta200 · Success

DELETE/households/{householdId}/ai/conversations/{id}

ai:chat

Parámetros

Nombre	En	Obligatorio
id	path	Obligatorio

Ejemplo de petición

bash

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

Respuesta204 · No content

Stop further turns on this conversation.

POST/households/{householdId}/ai/conversations/{id}/stop

ai:chat

Parámetros

Nombre	En	Obligatorio
id	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/ai/conversations/{id}/stop

Respuesta200 · Success

Bulk-delete the current user's conversations (ids or all).

POST/households/{householdId}/ai/conversations/bulk-delete

ai:chat

Ejemplo de petición

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/ai/conversations/bulk-delete

Respuesta200 · Success

Tools available to the current member's role (count + names).

GET/households/{householdId}/ai/tools

ai:tools

Ejemplo de petición

bash

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

Respuesta200 · Success

Current user AI usage for today + daily cap + household monthly cap.

GET/households/{householdId}/ai/usage

ai:tools

Ejemplo de petición

bash

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

Respuesta200 · Success