Saltar para o conteúdo
vokse.
Explorar a referência
Todos os recursos

Objetivos

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

Get the goal attached to a category

GET/households/{householdId}/categories/{categoryId}/goal
read:goals

Parâmetros

NomeLocalObrigatório
categoryIdpathObrigatório
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/categories/{categoryId}/goal
Resposta200 · Success

Create or replace the goal on a category (one goal per category)

PUT/households/{householdId}/categories/{categoryId}/goal
write:goals

Parâmetros

NomeLocalObrigatório
categoryIdpathObrigatório
Corpo do pedido
json
{  "kind": "target_by_date",  "targetCents": 600000,  "byDate": "2026-12-31"}
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X PUT https://api.vokse.ai/households/current/categories/{categoryId}/goal \     -d '{"kind":"target_by_date","targetCents":600000,"byDate":"2026-12-31"}'
Resposta200 · Success

Remove the goal from a category

DELETE/households/{householdId}/categories/{categoryId}/goal
write:goals

Parâmetros

NomeLocalObrigatório
categoryIdpathObrigatório
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X DELETE https://api.vokse.ai/households/current/categories/{categoryId}/goal
Resposta204 · No content

List every goal in the household

GET/households/{householdId}/goals
read:goals
Exemplo de pedido
bash
curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/goals
Resposta200 · Success