API: all pagesDocs homeOverviewAPITools & MCPBasicsSavingReading and contextAgent runsWebhooks and connectorsRetries and idempotencyErrors and limitsCreditsPrivacy and deletionConsole sign-in

Credits

  • What costs what:
    • one /v1/context or /v1/retrieve call, with that turn’s saves up to 500 tokens: 1 credit;
    • +1 credit per extra 500 tokens saved in the turn;
    • saves outside a turn: tokens ÷ 500;
    • quick reads (state, decisions, glossary, timeline, code map, people): 0.1 credit.
  • Free: corrections, deletes, exports, jobs, admin calls, failed calls, 503s, degraded answers (up to 20 a minute).
  • Admin views:
    • GET /v1/admin/usage shows credits by action, by end user and by day (by_day, UTC days of the period), plus the plan’s monthly credits.
    • GET /v1/admin/requests lists the last 24 hours of API requests per route (calls, errors, p50 / p95), read from the request log, which never holds memory text.
    • POST /v1/records {q, source, space, status, since, until, limit, next} lists the team’s records in every space, newest saved first, each with its space, source and status (current / outdated / conflict / pinned). Not for user tokens.
    • POST /v1/names {q} (the Console’s ⌘K) finds the people and things the team’s records name whose name holds q (2+ letters; the 10 most recently written spaces), each with its kind, records and space, plus the values of the best 3 that changed (changes = how often). Not for user tokens or space-limited keys.
    • POST /v1/memory/view {user, id, history: true} adds how each value the record states changed, the corrections about it, its status and how many answers cited it this week.
    • POST /v1/reviews lists what waits for a person team-wide: open conflicts (each side with its records), first names that may be several people, records Keeper flagged (keeper_mode: off / flagged / held).
    • POST /v1/live is the newest records team-wide plus saved in the last minute, waiting in line and saves that stored nothing today.
    • POST /v1/directory {user} lists the people a space’s records name: the roles records state, what they own and work on, confirmed same-person names.
    • GET /v1/admin/audit lists the team’s account events (keys, sign-ups, two-step sign-in), newest first.
    • GET /v1/admin/keys lists the team’s keys (never a secret). A new key may set expires (a UTC date) and spaces (the only spaces it may use; not with admin).
    • Webhooks: POST /v1/admin/webhooks {url, events} without a secret makes one and returns it ONCE; GET /v1/admin/webhooks/deliveries?subscription_id= lists deliveries; POST /v1/admin/webhooks/resend {delivery_id} sends one again with the same delivery id.
    • Watches: POST /v1/watches/pause {user, watch_id, paused}; POST /v1/watches/all lists every watch of the team with its last match (record ids).
    • Switching kit: POST /v1/imports/preview {user, format, file} counts first (items, users, already imported; nothing saved). An import saves each end user of the export into that user’s own space (split_users: false keeps one space).
    • POST /v1/jobs/all lists the team’s import jobs, newest first (progress and errors).
    • Connectors: GET /v1/admin/connectors adds what each synced (records, threads, last) and connect_ready per kind; GET /v1/admin/connectors/detail?connector_id= lists its threads, who-is-who and the latest synced records; POST /v1/admin/connectors/delete {connector_id, delete_synced: true} also deletes what it synced.
    • Agent runs: POST /v1/runs/all lists the team’s runs (newest first, step count, outcome); POST /v1/runs/detail {user, run_id} returns its steps and, for a successful run, the solved case the next agent gets.
    • GET /v1/admin/mcp lists the AI apps people signed in to over the remote MCP (app, person, space, scopes) and the MCP address; POST /v1/admin/mcp {action: "revoke", client_id, user, space} ends one (its 1-hour access token expires by itself).
    • POST /v1/context {explain: true} also returns explain_stages: the time of each stage (read, find + rank, check, pack), how many candidates it looked at and kept, and the best ones below the cut; add model_family for token_counts per part.
    • GET /v1/admin/summary is the Console Home: memories (+ today), memory spaces (people / teams), context calls today, context p95, credits used of the month, and what needs attention (open conflicts per space, server alerts, the credit pace with the date 100% is reached). Owners and admins; refreshed once a minute.
    • /v1/admin/billing shows payments, sets automatic top-up ({action: "autotopup", below, credits}) and sets notice contacts ({action: "contact", role: "billing" | "admin" | "security", email}).
  • Notices: at 80% and 100% of a period’s credits you get one credits.threshold webhook and one email each. When credits fall below your auto top-up threshold, one credits.topup_due per period.