← Receivers

credits:balance

credits family

Returns the credits balance for the authenticated caller's slug

Effect
ask
Awaits an outcome — the call returns the response below.
Caller
session
The class of authority the caller must already hold, decided from the attested context with no round trip.
Reversible
no
This cannot be undone. Dry-run it first where the contract allows.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code
Codex
Cursor
Gemini CLI
Claude Desktop
ChatGPT
curl -X POST https://one.ie/api/ask/credits:balance \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": {}}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

Takes no arguments.

Response

What comes back from the call.

No declared fields.

Traffic

Every call to credits:balance, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names credits:balance, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

UI 1
  • one.ie/web/src/components/speed/speed-run.ts:441
API route 2
  • one.ie/web/src/lib/receiver-index.generated.ts:96
  • one.ie/web/src/pages/api/billing/balance.ts:14
→

Answered by

credits:balance one.ie/web/src/lib/resolvers/market.ts:1053 Dispatched through POST /api/ask/credits:balance, after the envelope validates the payload.
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": {}
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}