Skip to main content
Command reference

codespar account

Account: balances, the merged ledger, a money summary, spend per agent, payments, sessions, test balance and test funding

3 min read
View MarkdownEdit on GitHub

Account: balances, the merged ledger, a money summary, spend per agent, payments, sessions, test balance and test funding

10 commands in @codespar/cli 0.18.1.

Each one prints what its operation answered. What a command prints has the rule, and Configuration has the exit codes and the shape of a failure.

codespar account balances

Account balances, per currency

codespar account balances
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

GET /v1/account/balances · parameters, responses and refusals

codespar account ledger

The project's ledger, every wallet merged

codespar account ledger
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

GET /v1/account/ledger · parameters, responses and refusals

codespar account summary

BRL money in, agent spend, tool calls and sessions over a window

codespar account summary
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

GET /v1/account/summary · parameters, responses and refusals

codespar account agent-activity

BRL spent and received per agent, over a window

codespar account agent-activity
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

GET /v1/account/agent-activity · parameters, responses and refusals

codespar account payments

The project's payments, newest first

codespar account payments
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

GET /v1/account/payments · parameters, responses and refusals

codespar account fund-sandbox

Add test balance (test projects only)

codespar account fund-sandbox --input '{"amount_minor":1000,"idempotency_key":"string","rail":"pix","target":"account","mandate_id":"mandate_0000000000000000","consumer_id":"csm_0000000000000000"}'
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds
-i, --input <json>Request body as a JSON string
-f, --input-file <path>Request body from a JSON file

POST /v1/account/fund/sandbox · parameters, responses and refusals

codespar account fund-sandbox-initial

Grant the initial test balance (test projects only, once)

codespar account fund-sandbox-initial
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

POST /v1/account/fund/sandbox/initial · parameters, responses and refusals

codespar account sessions

The project's sessions, as the activity list draws them

codespar account sessions
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

GET /v1/account/sessions · parameters, responses and refusals

codespar account test-balance

The test balance, the refill quota and the Adicionar fundos cap

codespar account test-balance
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds

GET /v1/account/test-balance · parameters, responses and refusals

codespar account fund-sandbox-refill

Refill the test balance (test projects only, confirmed)

codespar account fund-sandbox-refill --input '{"confirm":true}'
optionwhat it does
-q, --query <key=value>Query parameter (repeatable) (default: [])
--timeout <ms>Per-request timeout in milliseconds
-i, --input <json>Request body as a JSON string
-f, --input-file <path>Request body from a JSON file

POST /v1/account/fund/sandbox/refill · parameters, responses and refusals

codespar account | CodeSpar