Browse the reference

AI assistant

12 endpoints

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

GET/households/{householdId}/ai/actions

ai:chat

Example request

bash

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

Response200 · Success

Cancel a pending destructive action.

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

ai:chat

Parameters

Name	In	Required
id	path	Required

Example request

bash

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

Response200 · Success

Confirm and execute a pending assistant action.

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

ai:chat

Parameters

Name	In	Required
id	path	Required

Example request

bash

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

Response200 · 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

Request body

json

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

Example request

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

Response201 · 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

Parameters

Name	In	Required
limit	query	Optional
cursor	query	Optional
q	query	Optional

Example request

bash

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

Response200 · Success

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

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

ai:chat

Parameters

Name	In	Required
id	path	Required

Example request

bash

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

Response200 · Success

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

ai:chat

Parameters

Name	In	Required
id	path	Required

Example request

bash

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

Response200 · Success

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

ai:chat

Parameters

Name	In	Required
id	path	Required

Example request

bash

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

Response204 · No content

Stop further turns on this conversation.

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

ai:chat

Parameters

Name	In	Required
id	path	Required

Example request

bash

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

Response200 · Success

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

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

ai:chat

Example request

bash

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

Response200 · Success

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

GET/households/{householdId}/ai/tools

ai:tools

Example request

bash

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

Response200 · Success

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

GET/households/{householdId}/ai/usage

ai:tools

Example request

bash

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

Response200 · Success