Get usage

Send your key as Authorization: Bearer cym_test_…. Requires the results:read scope. Test keys read the simulator; live keys read your paired Cymos.

No parameters.

• 429rate_limit_exceeded: Too many requests this minute for the key (or twice that across the project), or too many open streams for the project. Retry after the seconds in Retry-After.quota_exceeded: A live key's project has used its monthly live-hour cap. There is no Retry-After. Don't retry; raise the live-hour cap in the dashboard. Headers: Retry-After, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.
• 503live_unavailable: This operation has no live data for this project yet (for example, no paired Cymo covers it). Don't retry the same request; pair a Cymo that covers it, or build against a test key.service_unavailable: A dependency, such as API key verification, is unreachable, or the project is busy with another write. Retry after the seconds in Retry-After, with backoff.
• 4XXInvalid request, credential, permission or revision.
• defaultError with a stable code and request ID.

Every error is a { error, meta } envelope with a stable code. See Errors for each code and whether to retry.

import { Cymo } from "@cymos/sdk";

const cymo = new Cymo({ apiKey: process.env.CYMO_API_KEY! });

const { data, meta } = await cymo.usage.get({});

$ cymatics usage get --json

curl "https://api.cymatics.tech/v1/usage" \
  -H "Authorization: Bearer $CYMO_API_KEY"

get_usage({})

The MCP tool get_usage calls this operation with your key.