Schemas¶

The shapes the API reference refers to.

Error¶

Fields

Field	Type	Description
`type`	string	"error", on answers Anthropic clients also read.
`error`	object
`error.message`	string
`error.type`	string
`error.code`	string

SignInProvider¶

An identity provider the gateway signs people in through.

Fields

Field	Type	Description
`name`	string	What `provider` names it by.
`label`	string	What a person is shown.
`signup`	boolean	Whether somebody new may create an organisation through it.
`password`	boolean	Whether it asks for a password, as an LDAP directory does, instead of redirecting.

SignInRedirect¶

Where the panel goes next. For keera login, the loopback address with the code.

Fields

Field	Type	Description
`redirect`	string

User¶

A person in one organisation.

Fields

Field	Type	Description
`id`	string
`org_id`	string
`email`	string
`name`	string
`external_id`	string	`<provider>:<subject>`. Empty until their first sign-in.
`role`	string	One of `operator`, `admin`, `member`.
`created_at`	string (date-time)
`disabled_at`	string (date-time)	Set while the person is turned off.
`last_active_at`	string (date-time)	Their last sign-in or request. Only in lists.

Membership¶

One organisation a person is in, or was invited to.

Fields

Field	Type	Description
`user_id`	string
`org_id`	string
`org_name`	string
`role`	string	One of `operator`, `admin`, `member`.
`invited`	boolean	Not joined yet. Switching to it joins.

Passkey¶

Fields

Field	Type	Description
`id`	string
`user_id`	string
`name`	string
`created_at`	string (date-time)
`last_used_at`	string (date-time)

PasskeyLink¶

A one-time set-up link. It holds the token, so it is shown once and never stored.

Fields

Field	Type	Description
`url`	string (uri)
`expires_at`	string (date-time)

RegistrationOptions¶

Fields

Field	Type	Description
`challenge_id`	string	Send it back with the answer.
`email`	string	The account the passkey is for.
`options`	`CreationOptions`

CreationOptions¶

What navigator.credentials.create is called with. Binary values are base64url.

Fields

Field	Type	Description
`challenge`	string
`rp`	object
`rp.id`	string
`rp.name`	string
`user`	object
`user.id`	string
`user.name`	string
`user.displayName`	string
`pubKeyCredParams`	array of object
`pubKeyCredParams[].type`	`public-key`
`pubKeyCredParams[].alg`	integer	A COSE algorithm, such as -7 for ES256.
`timeout`	integer	Milliseconds.
`excludeCredentials`	array of `CredentialRef`	The passkeys the person already has.
`authenticatorSelection`	object
`authenticatorSelection.residentKey`	string
`authenticatorSelection.requireResidentKey`	boolean
`authenticatorSelection.userVerification`	string
`attestation`	string

RequestOptions¶

What navigator.credentials.get is called with. It lists no credentials, so the browser offers every passkey it has for this gateway.

Fields

Field	Type	Description
`challenge`	string
`rpId`	string
`timeout`	integer	Milliseconds.
`userVerification`	string
`allowCredentials`	array of `CredentialRef`

CredentialRef¶

Fields

Field	Type	Description
`type`	`public-key`
`id`	string	base64url.

Registration¶

The browser's answer to navigator.credentials.create. Binary values are base64url.

Fields

Field	Type	Description
`id`	string
`client_data_json`	string
`authenticator_data`	string
`public_key`	string	The SubjectPublicKeyInfo, as `getPublicKey()` returns it.
`algorithm`	integer	The COSE algorithm, as `getPublicKeyAlgorithm()` returns it.

Assertion¶

The browser's answer to navigator.credentials.get. Binary values are base64url.

Fields

Field	Type	Description
`id`	string
`client_data_json`	string
`authenticator_data`	string
`signature`	string
`user_handle`	string

AccessKey¶

Fields

Everything in KeySummary, plus:

Field	Type	Description
`project_name`	string
`state`	string	One of `active`, `pending`, `expired`, `revoked`.
`scopes`	array of `AccessScope`	The levels whose limits apply, organisation first.
`allowed_models`	array of string	The models and routers the key may call.

AccessScope¶

One level above a key, with its limits and what is used of them.

Fields

Field	Type	Description
`type`	`ScopeType`
`id`	string
`name`	string
`rates`	array of `AccessRate`
`budgets`	array of `AccessBudget`
`system_prompt`	string	This level's own instruction, not the joined chain.
`filters`	array of string	This level's own filters.

AccessRate¶

One rate limit. Per day or month, the _used fields say how much is gone.

Fields

Field	Type	Description
`requests`	integer
`tokens`	integer
`period`	string	One of `minute`, `day`, `month`.
`requests_used`	integer
`tokens_used`	integer

AccessBudget¶

Fields

Field	Type	Description
`budget_micros`	integer	Millionths of the currency unit.
`spend_micros`	integer
`period`	`Period`
`resets_at`	string (date-time)

Refusal¶

A request the gateway turned away. The status is the reason: 402 a spent budget, 429 a rate limit, 404 a model the key may not use.

Fields

Field	Type	Description
`created_at`	string (date-time)
`alias`	string
`status`	integer
`key_id`	string
`error`	string	What the client was told.

Org¶

Fields

Field	Type	Description
`id`	string
`name`	string
`email_domain`	string	Places a first sign-in from this domain here.
`limited`	boolean	It signed up and has not paid yet. Its models may not run on the deployment's own machines, and it gets no sandboxes.
`created_at`	string (date-time)

Project¶

Fields

Field	Type	Description
`id`	string
`org_id`	string
`name`	string
`description`	string
`created_at`	string (date-time)

ProjectSummary¶

Fields

Everything in Project, plus:

Field	Type	Description
`limits`	`Limits`
`active_keys`	integer
`spend_micros`	integer (int64)	Spend this period, in millionths of the currency.
`budget_micros`	integer (int64)	The budget that will stop the project's keys first, or 0 for none.
`period`	`Period`

KeyKind¶

Type: string. standard reaches every model its guardrails allow. subscription reaches only models paid by the person's own Claude subscription. Defaults to standard. One of standard, subscription.

KeyInfo¶

An issued key, without its secret.

Fields

Field	Type	Description
`id`	string
`org_id`	string
`project_id`	string
`user_id`	string	The person whose spend this is.
`name`	string
`prefix`	string	The start of the secret, to recognise it by. Empty while pending.
`kind`	`KeyKind`
`created_at`	string (date-time)
`expires_at`	string (date-time)
`revoked_at`	string (date-time)
`pending`	boolean	Waiting to be activated. It has no secret yet.

KeySummary¶

Fields

Everything in KeyInfo, plus:

Field	Type	Description
`limits`	`Limits`
`last_used_at`	string (date-time)
`requests`	integer (int64)	Requests served.
`spend_micros`	integer (int64)
`subscription_micros`	integer (int64)	For a subscription key, what the person's Claude plan paid for, at API prices.
`plan`	`PlanUsage`

PlanUsage¶

How much of a Claude plan's usage limit is used, as Anthropic reports it.

Fields

Field	Type	Description
`five_hour`	number
`five_hour_resets_at`	string (date-time)
`seven_day`	number
`seven_day_resets_at`	string (date-time)
`status`	string	One of `allowed`, `allowed_warning`, `rejected`.
`updated_at`	string (date-time)

Period¶

Type: string. One of day, month.

ScopeType¶

Type: string. One of org, project, key.

Limits¶

One scope's guardrail. A field left out or null inherits from the level above. For the lists, an empty list allows nothing and null inherits, so answers always carry them. The sandbox fields may not be set on a key.

Fields

Field	Type	Description
`allowed_models`	array or null	Model aliases this scope may use.
`rate_limits`	array or null	At most one per period.
`budgets`	array or null	At most one per period.
`system_prompt`	string or null	Put ahead of every chat request's own messages, after those of the levels above. At most 16 KiB.
`filters`	array or null	Filter aliases, in the order they run, after those of the levels above.
`allowed_tools`	array or null	MCP tools this scope may call. An MCP server's alias for all its tools, or `alias/tool` for one.
`max_sandboxes`	integer or null	Live sandboxes at once. 0 is no limit.
`max_sandbox_ttl_seconds`	integer or null	Longest lifetime of one sandbox. 0 is no limit.
`sandbox_classes`	array or null	Sandbox classes this scope may use.
`max_sandbox_cpu_millis`	integer or null	Most CPU for one sandbox, in millicores. 0 is no limit.
`max_sandbox_memory_mib`	integer or null	Most memory for one sandbox, in MiB. 0 is no limit.
`allowed_repos`	array or null	Repositories a sandbox may check out: `owner/repo`, `owner` for all under it, or `*`. Where no level sets it, none may be. On an organisation, only an operator may change it.

RateLimit¶

The most a scope may use per period. Set requests, tokens or both.

Fields

Field	Type	Description
`requests`	integer (int64)
`tokens`	integer (int64)
`period`	string	One of `minute`, `day`, `month`. Default `"minute"`.

Budget¶

The most a scope may spend per period.

Fields

Field	Type	Description
`budget_micros`	integer (int64)	In millionths of the currency.
`period`	string	One of `day`, `month`. Default `"month"`.

Scope¶

One level's limits as the gateway enforces them.

Fields

Field	Type	Description
`type`	`ScopeType`
`id`	string
`rpm`	integer	Requests per minute. 0 is no limit.
`tpm`	integer	Tokens per minute. 0 is no limit.
`budget_micros`	integer (int64)	0 is no limit.
`period`	`Period`
`meter`	string	What the period counts. Absent is money. One of `requests`, `tokens`.
`quota`	integer (int64)	The most `meter` may count. 0 is no limit.

ResolvedSandbox¶

What a sandbox may be: the organisation's guardrail, narrowed by the project's. Zero means unlimited.

Fields

Field	Type	Description
`max_sandboxes`	integer
`max_sandbox_ttl_seconds`	integer
`sandbox_classes`	array or null	Null allows every class.
`max_sandbox_cpu_millis`	integer
`max_sandbox_memory_mib`	integer
`allowed_repos`	array or null	Null allows no repository, not every one.

EffectiveLevel¶

One level above a scope, with what it sets on its own.

Fields

Field	Type	Description
`type`	`ScopeType`
`id`	string
`name`	string
`limits`	`Limits`

Effective¶

What a request against a scope meets. Rate limits and budgets stay per level in scopes, because each level is enforced on its own.

Fields

Field	Type	Description
`type`	`ScopeType`
`id`	string
`levels`	array of `EffectiveLevel`	Organisation, then project, then key, as far as they apply.
`allowed_models`	array or null	null is every enabled model. An empty list is none.
`system_prompt`	string	Every level's prompt joined, outermost first.
`filters`	array of string	Every level's filters, in the order they run.
`allowed_tools`	array or null	null is every tool of every MCP server.
`scopes`	array of `Scope`
`sandbox`	`ResolvedSandbox`

AliasDeleted¶

The answer to deleting a filter, router, model or MCP server.

Fields

Field	Type	Description
`alias`	string
`deleted`	`true`

Filter¶

Reads a request before it is forwarded, and may change or stop it. See docs/filters.md.

Fields

Field	Type	Description
`org_id`	string
`alias`	string
`model`	string	The model it runs on. Empty on a pattern filter.
`mode`	string	One of `rewrite`, `gate`, `pattern`.
`prompt`	string	The instruction for its model. Empty on a pattern filter.
`rules`	array of `FilterRule`	A pattern filter's rules, applied in order.
`shadow`	boolean	Runs and records, but enforces nothing.
`description`	string
`created_at`	string (date-time)
`updated_at`	string (date-time)

FilterRule¶

One rule of a pattern filter. It either replaces or refuses.

Fields

Field	Type	Description
`pattern`	string	An RE2 expression, as Go's regexp reads it. It may not match the empty string.
`replace`	string	Put in literally for each match; `$1` is not expanded.
`refuse`	boolean	Refuse the request when this matches, instead of replacing.
`reason`	string	The sentence a refusal gives the sender. Only with `refuse`.

FilterStat¶

One filter's traffic over a window.

Fields

Field	Type	Description
`filter`	string
`runs`	integer (int64)
`passed`	integer (int64)
`rewrote`	integer (int64)
`refused`	integer (int64)
`errored`	integer (int64)
`shadowed`	integer (int64)	How many runs enforced nothing.
`latency_median_ms`	integer (int64)
`latency_p95_ms`	integer (int64)
`cost_micros`	integer (int64)
`segments`	integer (int64)
`changed`	integer (int64)
`last_run_at`	string (date-time)
`first_run_at`	string (date-time)

FilterPoint¶

One bucket of a filter's chart.

Fields

Field	Type	Description
`at`	string (date-time)
`runs`	integer (int64)
`refused`	integer (int64)
`errored`	integer (int64)
`rewrote`	integer (int64)
`cost_micros`	integer (int64)

FilterProjectRow¶

One project's runs of a filter.

Fields

Field	Type	Description
`project_id`	string	Empty for requests outside any project.
`runs`	integer (int64)
`refused`	integer (int64)
`rewrote`	integer (int64)
`errored`	integer (int64)
`cost_micros`	integer (int64)

FilterReport¶

Fields

Everything in FilterStat, plus:

Field	Type	Description
`from`	string (date-time)
`to`	string (date-time)
`bucket`	string	One of `hour`, `day`.
`series`	array of `FilterPoint`
`projects`	array of `FilterProjectRow`	Most refused first.
`requests`	integer (int64)	The organisation's requests in the window.
`org_cost_micros`	integer (int64)	The organisation's cost in the window.

FilterProbe¶

What one filter check found. A rewrite filter fills segments, a gate verdicts, a pattern filter hits.

Fields

Field	Type	Description
`alias`	string
`mode`	string	One of `rewrite`, `gate`, `pattern`.
`model`	string
`shadow`	boolean
`segments`	array of `FilterSegment`
`total_ms`	integer (int64)
`cost_micros`	integer (int64)
`error`	string
`refused`	boolean	It refused the sample instead of rewriting it.
`refusal`	string	Its sentence when it refused.
`verdicts`	array of `FilterVerdict`
`hits`	array of `FilterPatternHit`
`free`	boolean	The run cost nothing and used no GPU.
`warnings`	array of string
`ok`	boolean

FilterSegment¶

One sample text, before and after.

Fields

Field	Type	Description
`before`	string
`after`	string
`changed`	boolean

FilterVerdict¶

One gate run over half of the sample.

Fields

Field	Type	Description
`sent`	array of string
`refused`	boolean
`reason`	string
`expect_refusal`	boolean
`confidence`	number	Left out when the backend served no logprobs.

FilterPatternHit¶

One pattern rule that matched the sample.

Fields

Field	Type	Description
`rule`	string	The expression that matched.
`matches`	integer
`refused`	boolean

Router¶

A tree of steps a request goes through. See docs/routers.md.

Fields

Field	Type	Description
`org_id`	string
`alias`	string
`display_name`	string
`description`	string
`start`	`RouterStep`
`created_at`	string (date-time)
`updated_at`	string (date-time)

SavedRouter¶

Fields

Everything in Router, plus:

Field	Type	Description
`warning`	string	What the organisation's allow-list now does with the router.
`warnings`	array of string	Likely mistakes in the router itself.

RouterStep¶

One step of a router. Which fields it may set depends on kind:

filter and model name what they use in ref.
route has mode, destinations and branches; an instruction step also model, prompt and fallback, a size step ceilings.
rate_limit has requests, tokens and period; budget has budget_micros and period. Both may have exceeded.
system_prompt has prompt.

Every step but route and model needs next. A router has at most 64 steps.

Fields

Field	Type	Description
`id`	string	Unique in the router. Lowercase letters, digits and inner hyphens.
`kind`	string	One of `filter`, `route`, `rate_limit`, `budget`, `model`, `system_prompt`.
`ref`	string	The filter or model alias a `filter` or `model` step uses.
`requests`	integer (int64)	A rate limit's requests per period. 0 means no limit.
`tokens`	integer (int64)	A rate limit's tokens per period. 0 means no limit.
`budget_micros`	integer (int64)	A budget's most spend per period.
`prompt`	string	A system prompt step's text (up to 16 KiB), or an instruction step's instruction (up to 4 KiB).
`mode`	string	A route step's way of choosing. Defaults to instruction. One of `instruction`, `fallback`, `latency`, `least-busy`, `size`.
`model`	string	The model an instruction step decides with.
`destinations`	array of string	The models a route step chooses between.
`ceilings`	map of integer	A size step's largest request, in estimated tokens, per destination. Exactly one destination has none.
`fallback`	string	Where an instruction step sends what it could not decide. Empty refuses it.
`period`	string	What a limit counts over. A rate limit defaults to minute; a budget takes day or month and defaults to month. One of `minute`, `day`, `month`.
`next`	`RouterStep`
`exceeded`	`RouterStep`
`branches`	map of `RouterStep`	A route step's next steps, by destination. A destination with none is sent the request straight away.

UsageCell¶

Traffic added up over a window.

Fields

Field	Type	Description
`requests`	integer (int64)
`input_tokens`	integer (int64)
`output_tokens`	integer (int64)
`cost_micros`	integer (int64)
`refused`	integer (int64)	Every 4xx answer.
`failed`	integer (int64)	Every 5xx answer.
`ttft_median_ms`	integer (int64)

RouterStat¶

Fields

Everything in UsageCell, plus:

Field	Type	Description
`chose`	integer (int64)
`fell_back`	integer (int64)
`errored`	integer (int64)

RouterDestination¶

Fields

Everything in UsageCell, plus:

Field	Type	Description
`alias`	string

RouterReport¶

One router's own screen.

Fields

Field	Type	Description
`router`	string
`total`	`UsageCell`
`destinations`	array of `RouterDestination`	Most used first.
`chose`	integer (int64)
`fell_back`	integer (int64)
`errored`	integer (int64)
`decision_median_ms`	integer (int64)
`decision_p95_ms`	integer (int64)

RouterCheck¶

Fields

Field	Type	Description
`router`	string
`routes`	array of `RouteProbe`

RouteProbe¶

What checking one route step found. An instruction step fills decisions; the other modes fill chain.

Fields

Field	Type	Description
`step`	string
`mode`	string	One of `instruction`, `fallback`, `latency`, `least-busy`, `size`.
`model`	string
`destinations`	array of string	What the step offered when checked.
`dropped`	array of string	Destinations that were not offered, and why.
`decisions`	array of `RouteSampleDecision`
`chain`	array of `RouteHop`
`total_ms`	integer (int64)
`cost_micros`	integer (int64)
`error`	string
`warnings`	array of string
`ok`	boolean

RouteSampleDecision¶

One sample prompt and where the step sent it.

Fields

Field	Type	Description
`prompt`	string
`asks`	string	What the sample tests.
`chosen`	string
`confidence`	number	Left out when the backend served no logprobs.
`error`	string

RouteHop¶

One destination of a trying step, in the order it would be tried.

Fields

Field	Type	Description
`alias`	string
`answers`	boolean
`status`	integer
`ms`	integer (int64)
`note`	string
`reading`	string	Why it is in this place, on a step that ranks by measurement or size.

OrgModel¶

One of an organisation's models. Clients name only its alias.

Fields

Field	Type	Description
`alias`	string
`org_id`	string
`kind`	string	One of `chat`, `completion`, `embedding`, `decision`.
`backends`	array or null	Base URLs. `null` for anyone but an administrator.
`backend_model`	string
`provider`	string
`display_name`	string
`description`	string
`input_micros_per_mtok`	integer (int64)
`output_micros_per_mtok`	integer (int64)
`cached_input_micros_per_mtok`	integer (int64)
`cache_write_micros_per_mtok`	integer (int64)
`long_prompt`	`PriceTier`
`max_context_tokens`	integer
`release_date`	string (date)
`location`	string	Where it runs, such as `ch`, `usa` or `onprem`.
`has_api_key`	boolean	A credential is stored. Only administrators see it.
`subscription`	boolean	Paid by each caller's own Claude plan.
`platform_key`	boolean	The deployment holds the provider's key, and bills the model.
`enabled`	boolean

PriceTier¶

The prices for a prompt longer than above_tokens.

Fields

Field	Type	Description
`above_tokens`	integer	The longest prompt still charged the model's own prices.
`input_micros_per_mtok`	integer (int64)
`output_micros_per_mtok`	integer (int64)
`cached_input_micros_per_mtok`	integer (int64)
`cache_write_micros_per_mtok`	integer (int64)

ModelStat¶

How fast a model has been answering.

Fields

Field	Type	Description
`ttft_median_ms`	integer (int64)
`ttft_p95_ms`	integer (int64)

ModelProbe¶

What one model check found.

Fields

Field	Type	Description
`alias`	string
`backend`	string	The base URL that answered.
`reachable`	boolean
`status`	integer
`streamed`	boolean	The answer arrived as server-sent events.
`tool_calls`	boolean	The model's tool call came back in `tool_calls`.
`tool_call_as_text`	boolean	The tool call came back as prose, a parser mismatch.
`tools_off`	boolean	The backend refuses any request that offers tools.
`served_model`	string
`ttft_ms`	integer (int64)
`total_ms`	integer (int64)
`sample`	string	The start of the prose that came back.
`error`	string
`warnings`	array of string
`no_credit`	boolean	On the deployment's key with no credit left, so not called.
`ok`	boolean

HostedProvider¶

A hosted provider this build knows.

Fields

Field	Type	Description
`name`	string
`endpoint`	string	The OpenAI-compatible base URL, or a template holding `{product_id}`. Empty for anyone but an administrator.
`needs_product_id`	boolean	Each customer has their own endpoint.
`cached_input`	boolean	It publishes a cheaper rate for cached input.
`location`	string
`kinds`	array of string
`models`	array of `HostedProviderModel`
`summary`	string
`platform_key`	boolean	The deployment holds this provider's key, so models take none.

HostedProviderModel¶

One model a hosted provider serves.

Fields

Field	Type	Description
`id`	string
`display_name`	string
`max_context_tokens`	integer
`release_date`	string (date)
`input_micros_per_mtok`	integer (int64)
`output_micros_per_mtok`	integer (int64)
`cached_input_micros_per_mtok`	integer (int64)
`cache_write_micros_per_mtok`	integer (int64)
`long_prompt`	`PriceTier`
`description`	string
`snapshot`	string	The dated id the maker also uses, such as `claude-haiku-4-5-20251001`.

MCPServer¶

An MCP server the gateway stands in front of. See docs/mcp.md.

Fields

Field	Type	Description
`org_id`	string
`alias`	string
`url`	string	The Streamable HTTP endpoint. Empty for anyone but an administrator.
`description`	string
`auth_header`	string	The header the credential goes in. Empty means `Authorization`.
`has_api_key`	boolean	A credential is stored.
`enabled`	boolean

ToolCallRow¶

One MCP tool call.

Fields

Field	Type	Description
`id`	integer (int64)
`created_at`	string (date-time)
`project_id`	string
`user_id`	string
`key_id`	string
`server`	string	The MCP server's alias.
`tool`	string
`outcome`	string	One of `ok`, `tool_error`, `error`, `denied`, `refused`, `input_required`.
`latency_ms`	integer
`arg_bytes`	integer
`result_bytes`	integer
`cost_micros`	integer (int64)
`error`	string
`session_key`	string
`client`	string

ToolSummary¶

One tool's calls in a window, added up.

Fields

Field	Type	Description
`server`	string
`tool`	string
`calls`	integer (int64)
`failed`	integer (int64)	The tool's own failures and calls that got no result.
`denied`	integer (int64)
`refused`	integer (int64)
`latency_median_ms`	integer (int64)
`arg_bytes`	integer (int64)
`result_bytes`	integer (int64)

ConnectClient¶

A coding agent that can be pointed at the gateway.

Fields

Field	Type	Description
`client`	string	Its id, as in `keera connect <client>`.
`label`	string
`about`	string
`path`	string	The file the block goes in. Empty for a command to run.
`lang`	string	One of `json`, `toml`, `sh`, `python`.
`template`	string	The block, with `{{base}}`, `{{models}}`, `{{aliases}}`, `{{alias}}` and sometimes `{{key}}` to fill in.
`names`	map of array of string	Other ids each Anthropic model goes by.
`entry`	string	What `{{models}}` repeats once per model.
`run`	string	What to type once it is configured.
`note`	string

ConnectModel¶

One model or router a client configuration names.

Fields

Field	Type	Description
`alias`	string
`name`	string	Its name for people. Left out, one is made from the alias.
`max_context_tokens`	integer	Left out for the default. A router has none.
`backend_model`	string
`provider`	string

ConnectedClient¶

One client that called with the caller's keys.

Fields

Field	Type	Description
`client`	string
`label`	string
`requests`	integer (int64)
`last_used_at`	string (date-time)
`keys`	array of `ConnectedClientKey`	Newest first.

ConnectedClientKey¶

One key a client called with.

Fields

Field	Type	Description
`id`	string
`name`	string
`requests`	integer (int64)
`last_used_at`	string (date-time)

ReportLabels¶

The names a report's ids stand for. Every map holds the organisation's ids, not only those in the rows.

Fields

Field	Type	Description
`project_names`	map of string	Project names by id.
`key_names`	map of string	Key names by id.
`user_names`	map of string	Email addresses by user id.
`user_full_names`	map of string	Names by user id, for those who have one.

DiagnosticCheck¶

One thing a deployment has or has not. Go type Check.

Fields

Field	Type	Description
`area`	string	Groups the checks, such as `Deployment`, `Models` or `Routers`.
`name`	string
`verdict`	string	`warn` runs but lacks something; `fail` stops requests now. One of `ok`, `warn`, `fail`.
`detail`	string	What was found.
`fix`	string	What to do about it. Every failing check has one.

Diagnosis¶

Fields

Field	Type	Description
`checks`	array of `DiagnosticCheck`
`failures`	integer
`warnings`	integer
`probed`	boolean	Whether the models were actually called.

SetupState¶

What a deployment already has. Go type Setup.

Fields

Field	Type	Description
`orgs`	integer (int64)	Organisations in the deployment, whichever is asked about.
`keys`	integer (int64)	Active API keys.
`models`	integer (int64)	Enabled models.
`requests`	integer (int64)	1 once anything was served, else 0.
`filters`	integer (int64)
`routers`	integer (int64)
`sandboxes`	integer (int64)	Sandbox classes.
`mcp_servers`	integer (int64)
`credits`	integer (int64)	Paid or granted payments that added credit.
`invoiced`	boolean	Billed by invoice. Always false across every organisation.

UsageBucket¶

One row of a usage report.

Fields

Field	Type	Description
`group`	string	The id or value grouped by. Empty for requests without one.
`org_id`	string	Only across every organisation, grouped by model.
`requests`	integer (int64)	Requests served.
`input_tokens`	integer (int64)
`output_tokens`	integer (int64)
`cost_micros`	integer (int64)	Cost in millionths of a franc, refused and failed requests included.
`subscription_micros`	integer (int64)	What Claude subscriptions paid for, at API prices. Not part of `cost_micros`.

OverviewSeriesPoint¶

One bucket of the dashboard chart. Go type SeriesPoint.

Fields

Field	Type	Description
`at`	string (date-time)
`requests`	integer (int64)
`tokens`	integer (int64)
`cost_micros`	integer (int64)
`failed`	integer (int64)

Overview¶

The dashboard's figures.

Fields

Field	Type	Description
`from`	string (date-time)	Widened to whole days over more than two days.
`to`	string (date-time)
`bucket`	string	Hourly up to two days, daily beyond. One of `hour`, `day`.
`requests`	integer (int64)
`input_tokens`	integer (int64)
`output_tokens`	integer (int64)
`cost_micros`	integer (int64)
`subscription_micros`	integer (int64)	What Claude subscriptions paid for, at API prices. Not part of `cost_micros`.
`refused`	integer (int64)
`failed`	integer (int64)
`ttft_median_ms`	integer (int64)
`ttft_p95_ms`	integer (int64)
`series`	array of `OverviewSeriesPoint`
`top_projects`	array of `UsageBucket`
`top_models`	array of `UsageBucket`
`top_keys`	array of `UsageBucket`	Only on a narrowed overview.

UsageLine¶

One group's line on the usage chart.

Fields

Field	Type	Description
`group`	string
`org_id`	string	Only across every organisation, grouped by model.
`other`	boolean	This line sums every group without one of its own.
`total`	integer (int64)
`counts`	array of integer (int64)	Served requests at each time in `at`.

UsageChart¶

Served requests over time.

Fields

Field	Type	Description
`bucket`	string	One of `hour`, `day`.
`at`	array of string (date-time)
`lines`	array of `UsageLine`	The five busiest groups, then the rest.

MapClient¶

Fields

Everything in UsageCell, plus:

Field	Type	Description
`client`	string	The client's key. Empty for senders that did not name themselves.
`label`	string	How the client is shown.

MapModel¶

Fields

Everything in UsageCell, plus:

Field	Type	Description
`alias`	string
`kind`	string
`enabled`	boolean
`hosting`	string	Which side of the customer's network the model runs on. One of `internal`, `external`, `unknown`.
`endpoint`	string	The host serving it. Administrators only.

MapFlow¶

Fields

Everything in UsageCell, plus:

Field	Type	Description
`client`	string	Empty for senders that did not name themselves.
`alias`	string

AuditEntry¶

One row of the audit log.

Fields

Field	Type	Description
`id`	integer (int64)
`created_at`	string (date-time)
`actor`	string
`action`	string
`target_type`	string
`target_id`	string
`detail`	any	Whatever the action recorded.

AuditFacets¶

The actions and actors that occur in the log.

Fields

Field	Type	Description
`actions`	array of string
`actors`	array of string

RequestSpan¶

One step of one request. Go type store.Span.

Fields

Field	Type	Description
`name`	string	The step.
`of`	string	What the step was about: a filter, a router or a model.
`at_us`	integer (int64)	When it began, in microseconds after the gateway took the request.
`for_us`	integer (int64)	How long it ran, in microseconds.
`note`	string	The outcome in a few words.

RequestLogEntry¶

One inference request. Go type store.Request.

Fields

Field	Type	Description
`id`	integer (int64)
`created_at`	string (date-time)
`alias`	string	The model, as the client named it.
`status`	integer
`error`	string	What the client was told.
`note`	string	What went wrong on the way to an answer served all the same.
`key_id`	string
`project_id`	string
`user_id`	string
`org_id`	string
`client`	string	What sent the request, as it named itself.
`input_tokens`	integer (int64)
`cached_input_tokens`	integer (int64)	The part of the input served from the prompt cache.
`cache_write_tokens`	integer (int64)	The part of the input written to the prompt cache.
`output_tokens`	integer (int64)
`cost_micros`	integer (int64)
`latency_ms`	integer (int64)
`ttft_ms`	integer (int64)	Wait for the first token.
`stream`	boolean
`estimated`	boolean	The token counts, and so the cost, are a guess: the client hung up first.
`canceled`	boolean
`session_key`	string	The conversation it was part of.
`spans`	array of `RequestSpan`	Where the time went.
`request_id`	string	The id the gateway answered with.
`client_request_id`	string	The client's own id.

RequestOutcomes¶

A window counted by outcome.

Fields

Field	Type	Description
`total`	integer (int64)
`ok`	integer (int64)
`failed`	integer (int64)
`refused`	integer (int64)
`interrupted`	integer (int64)

FacetCount¶

One value a log can be narrowed by, and how many rows have it.

Fields

Field	Type	Description
`value`	string
`count`	integer (int64)

RequestFacets¶

What a log can be narrowed by, over the whole window.

Fields

Field	Type	Description
`models`	array of `FacetCount`
`keys`	array of `FacetCount`
`projects`	array of `FacetCount`
`users`	array of `FacetCount`
`statuses`	array of `FacetCount`	On sessions, each session's last status.

AgentSession¶

One task: a run of requests in one conversation.

Fields

Field	Type	Description
`id`	integer (int64)	The id of its first request, which names it.
`session_key`	string	The conversation.
`stated`	boolean	The client named the session itself, rather than it being inferred.
`started_at`	string (date-time)
`ended_at`	string (date-time)	When the last request finished.
`requests`	integer (int64)
`ok`	integer (int64)
`failed`	integer (int64)
`refused`	integer (int64)
`interrupted`	integer (int64)
`input_tokens`	integer (int64)
`output_tokens`	integer (int64)
`cost_micros`	integer (int64)
`ttft_median_ms`	integer (int64)
`models`	array of string	Every model it used.
`project_id`	string
`user_id`	string
`key_id`	string
`last_status`	integer	The status of its last request.
`last_error`	string	The error of its last request, if any.

AgentSessionTotals¶

What a window of sessions adds up to.

Fields

Field	Type	Description
`sessions`	integer (int64)
`unhappy`	integer (int64)	Sessions holding something that did not deliver.
`requests`	integer (int64)
`input_tokens`	integer (int64)
`output_tokens`	integer (int64)
`cost_micros`	integer (int64)
`requests_median`	integer (int64)
`duration_median_ms`	integer (int64)
`cost_median_micros`	integer (int64)
`longest_requests`	integer (int64)	Requests in the longest session.
`costliest_micros`	integer (int64)	Cost of the costliest session.
`outcomes`	`RequestOutcomes`	Sessions by outcome, whichever outcome was asked for.

BillingRow¶

One organisation's use of one provider model in a month.

Fields

Field	Type	Description
`org_id`	string
`org_name`	string	Empty for an organisation deleted since.
`provider`	string
`backend_model`	string	The provider's name for the model.
`calls`	integer (int64)
`input_tokens`	integer (int64)
`cached_input_tokens`	integer (int64)
`cache_write_tokens`	integer (int64)
`output_tokens`	integer (int64)
`billed_micros`	integer (int64)	What the organisation is billed.
`credit_micros`	integer (int64)	The part paid from credit.

BillingTotal¶

The month's rows added up.

Fields

Field	Type	Description
`calls`	integer (int64)
`billed_micros`	integer (int64)

SavedCard¶

Fields

Field	Type	Description
`label`	string	How the card is shown.
`expires_at`	string (date-time)

CreditAccount¶

An organisation's credit for the deployment's provider keys, in CHF.

Fields

Field	Type	Description
`org_id`	string
`balance_micros`	integer (int64)	Credit in millionths of a franc. Can go below 0.
`topup_below_micros`	integer (int64)	Below this balance the saved card is charged. 0 is off.
`topup_micros`	integer (int64)	What one automatic top-up pays. 0 is off.
`card`	`SavedCard`	The saved card. Absent without one.
`topup_error`	string	Why the last automatic top-up failed. None is tried until it is cleared.
`invoiced`	boolean	Billed by invoice, so no credit is needed.

Payment¶

Money into a credit account.

Fields

Field	Type	Description
`id`	string
`org_id`	string
`created_at`	string (date-time)
`kind`	string	A payment by card, an automatic top-up, or a grant. One of `topup`, `auto`, `grant`.
`amount_micros`	integer (int64)	The credit. Below 0 on a grant that takes some away.
`vat_micros`	integer (int64)
`fee_micros`	integer (int64)	The transaction fee on top. It is not credited.
`state`	string	One of `pending`, `paid`, `failed`.
`save_card`	boolean
`transaction_id`	integer (int64)	PostFinance's transaction. Absent on a grant.
`actor`	string	Who started it.
`note`	string	Why a grant was made, or why a payment failed.
`settled_at`	string (date-time)

SandboxIsolation¶

Type: string. standard is the usual container runtime, hardened; isolated puts gVisor in front of the host kernel; vm is a Kata Containers VM. One of standard, isolated, vm.

SandboxPurpose¶

Type: string. engineer is a person's own machine, which people attach to and which is suspended when idle. agent is one task's machine, which nothing attaches to and which is terminated when its time runs out. One of engineer, agent.

SandboxState¶

Type: string. One of pending, ready, suspended, expired, failed, terminated.

SandboxClass¶

A machine a developer or an agent can ask for by name.

Fields

Field	Type	Description
`org_id`	string
`name`	string
`description`	string
`image`	string	The OCI image the sandbox runs.
`isolation`	`SandboxIsolation`
`cpu_millis`	integer
`memory_mib`	integer
`disk_mib`	integer	The persistent volume. Zero keeps nothing across a suspend.
`default_ttl_seconds`	integer
`max_ttl_seconds`	integer
`warm`	integer	How many idle sandboxes are kept started.
`purposes`	array of `SandboxPurpose`	What it may be asked for. Absent means both.
`created_at`	string (date-time)
`updated_at`	string (date-time)

Sandbox¶

One sandbox. The row outlives the machine.

Fields

Field	Type	Description
`id`	string
`org_id`	string
`project_id`	string
`user_id`	string
`owner`	string	The address it was created for.
`name`	string
`class`	string
`purpose`	`SandboxPurpose`
`state`	`SandboxState`
`detail`	string	Why it is in its state, such as why it is still pending.
`image`	string
`isolation`	`SandboxIsolation`
`cpu_millis`	integer
`memory_mib`	integer
`disk_mib`	integer
`key_id`	string	The API key minted for it.
`session_key`	string	An agent sandbox's session, so the two can be shown together.
`repo`	string
`branch`	string
`node`	string
`backing`	string	A machine of its own, or a claim on a warm pool. One of `sandbox`, `claim`.
`created_at`	string (date-time)
`ready_at`	string (date-time)
`last_active_at`	string (date-time)
`expires_at`	string (date-time)
`suspended_at`	string (date-time)
`terminated_at`	string (date-time)
`running_seconds`	integer	How long it has actually held compute.

SandboxUsage¶

What one group of sandboxes came to over a window.

Fields

Field	Type	Description
`group`	string	A class name, project id or person's address.
`org_id`	string	Only on a report across every organisation grouped by class.
`count`	integer
`running_seconds`	integer
`core_seconds`	integer	Running seconds weighted by CPU.
`live`	integer	How many still hold resources.

InferenceModel¶

A model or router, with the fields of both OpenAI's and Anthropic's model objects.

Fields

Field	Type	Description
`id`	string	The alias to send as `model`.
`object`	`model`
`created`	integer	The release date as a Unix time, or 0.
`owned_by`	`keera`
`type`	`model`
`created_at`	string (date-time)	The release date, when one is stated.
`max_context_tokens`	integer
`display_name`	string
`description`	string
`location`	string	Where prompts sent to it go.
`destinations`	array of string	Only on routers: every model it may send to.

InferenceModelList¶

Fields

Field	Type	Description
`object`	`list`
`data`	array of `InferenceModel`
`has_more`	`false`
`first_id`	string or null
`last_id`	string or null

JsonRpcMessage¶

A JSON-RPC 2.0 request, notification or response.

Fields

Field	Type	Description
`jsonrpc`	`2.0`
`id`	string or integer or null
`method`	string
`params`	any
`result`	any
`error`	object
`error.code`	integer
`error.message`	string
`error.data`	any