Explorar a referência

Regras

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

List rules (ordered by priority then created_at)

GET/households/{householdId}/rules

read:rules

Exemplo de pedido

bash

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

Resposta200 · Success

Create a classification rule

POST/households/{householdId}/rules

write:rules

Corpo do pedido

json

{  "name": "Auto-categorise coffee",  "predicate": {    "combinator": "all",    "conditions": [      {        "field": "payee_name",        "op": "contains",        "value": "coffee"      }    ]  },  "action": {    "setCategoryId": "01J8ME9B7QW3ZK5X2V8T4R6S1D"  }}

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/rules \     -d '{"name":"Auto-categorise coffee","predicate":{"combinator":"all","conditions":[{"field":"payee_name","op":"contains","value":"coffee"}]},"action":{"setCategoryId":"01J8ME9B7QW3ZK5X2V8T4R6S1D"}}'

Resposta201 · Success

Fetch a single rule

GET/households/{householdId}/rules/{id}

read:rules

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/rules/{id}

Resposta200 · Success

Update a rule (priority, enabled, predicate, action)

PATCH/households/{householdId}/rules/{id}

write:rules

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Corpo do pedido

json

{  "enabled": false}

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X PATCH https://api.vokse.ai/households/current/rules/{id} \     -d '{"enabled":false}'

Resposta200 · Success

Soft-delete a rule

DELETE/households/{householdId}/rules/{id}

write:rules

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/rules/{id}

Resposta204 · No content

Apply this rule to existing transactions (manual back-fill; trigger=manual)

POST/households/{householdId}/rules/{id}/apply

write:rules

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/rules/{id}/apply

Resposta200 · Success

Preview which existing transactions this rule matches (dry-run, applies nothing)

POST/households/{householdId}/rules/{id}/preview

read:rules

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/rules/{id}/preview

Resposta200 · Success

Apply every enabled rule (priority order, first-match-wins) to matching transactions

POST/households/{householdId}/rules/apply-all

write:rules

Exemplo de pedido

bash

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

Resposta200 · Success