Reference

Account

Who the key is, what plan the account is on, and what it has left to spend. Free to call, and the right first call from any new integration.

GET/api/v1/me

bash

curl https://corollary-labs.com/api/v1/me \
  -H "Authorization: Bearer $COROLLARY_API_KEY"

Response

json

{
  "object": "account",
  "key": { "id": "0f40ebe7-a331-4c4f-919a-ed19f403f1ca", "name": "analysis-server" },
  "plan": { "id": "free", "name": "Free", "monthly_credits": 30000 },
  "credits": { "available": 28410, "reserved": 0 }
}

key.idstring: The key that made the request, as listed on the keys page.
key.namestring: The name given when it was made.
plan.id"free" | "lab": The plan the account is on, read from its subscription.
plan.monthly_creditsinteger: The allowance the plan grants each month.
credits.availableinteger: What can be spent now: this month's grant plus purchased credits, less what has been used and what is held.
credits.reservedinteger: Held by work in progress. Released, and replaced by the real cost, when that work finishes.
creditsobject | null: Null when the ledger did not answer. Not zero — a zero would read as spent.

Calling this issues the month's allowance if it has not been issued yet, so an account that only ever uses the API is granted its credits without opening the app. Reading it is not metered. The creditsfigures are the account's, not the key's: every key on an account sees the same balance.

NextRunsCreate, read, stream, answer and cancel a research run.