Get Started

Credits

Check credit balance and start checkout from the CLI.

Credits are quota for API, MCP, and CLI operations. The CLI exposes balance and checkout commands for the current personal or workspace context.

One credit is priced at $0.01. Checkout requires at least 500 credits total across allocations.

Check balance

epismo credit balance

The selected workspace determines which balance is returned. If no workspace is selected, the command uses personal space. When EPISMO_TOKEN is set, the token's embedded workspace determines the balance context.

The response includes:

Field Meaning
balance Available credits in the selected context
shortfall Amount currently missing for a credit requirement

Start checkout

epismo credit checkout --allocations '[{"userId":"user-id","quantity":500}]'

The command returns checkout information, including a URL. In a workspace context, allocations are associated with that workspace.

Each allocation requires a non-empty userId and positive integer quantity.

Command costs

Command Cost
epismo pack create 5 credits
epismo pack search 5 credits
epismo track search 2 credits
epismo pack get 1 credit
epismo pack update 1 credit
epismo pack delete 1 credit
epismo pack like 1 credit
epismo track create 1 credit
epismo track update 1 credit
epismo track get 1 credit
epismo track apply 1 credit
epismo track delete 1 credit
epismo alias upsert 1 credit
epismo alias list 1 credit
epismo alias delete 1 credit
epismo credit balance 1 credit
epismo credit checkout 1 credit
  • epismo pack get consumes the same single credit for outline, selected block/step, and full reads.
  • Use outline pack reads before --full to keep later agent context smaller.
  • Use workspace-scoped CI tokens so credit usage is attributed to the intended workspace.
  • Check balance before jobs that run many searches/detail gets or hydrate large contexts.

A credit-gated operation can return 402 Payment Required when the selected context has insufficient balance. Epismo counts credits only after the operation succeeds, so failed validation and unsuccessful requests are not charged.