Skip to content

Core concepts

Organization, Workspace, Environment, Home Cloud, Pool, API key and usage evidence.

Updated View as Markdown
For humans

Seven objects explain almost everything in AI Runtime. This page defines them once so the rest of the documentation can stay short.

Organization

The customer boundary. An Organization owns its members, roles, audit log and commercial Agreement, and it can hold several Workspaces. Membership and roles come from Clerk, the identity provider behind the console.

Workspace

The unit that isolates work. Pools, API keys, budgets, requests and usage evidence all belong to one Workspace, and a Workspace inherits the Organization’s Home Cloud and Agreement. Nothing in one Workspace can call a Pool in another.

Environment

production or development. API keys are issued for exactly one Environment, so a development key never reaches production traffic. The console switches environments for the whole scope, not per page.

Home Cloud

Where the customer plane for a Workspace runs: Google Cloud, AWS, Azure or the shared edition. It is chosen with the Agreement and inherited by every Workspace that belongs to it. A key issued for one Home Cloud is not accepted by another.

Pool

A Pool — called a Runtime Route in the API contract — is the model your code names. One Pool fixes:

  • the capability it serves (text, structured output, embeddings, transcription, speech, image, OCR or privacy filtering);
  • the provider connection and model that answer it, plus an optional safe fallback;
  • retry, circuit-breaker, rate-limit and hard-budget policy;
  • a stable slug. The slug is the model name you send in a request.

Workspace API key

The credential your code sends as Authorization: Bearer …. A key is scoped to one Workspace, one Environment and the runtime scope, and it is granted to specific Pools. The secret is displayed once, when you issue it. See API keys.

Usage evidence

Every accepted request writes a payload-free record: Pool, key, state, cost, and UTC timestamps. Prompts, outputs, images, audio, credentials and provider responses are never part of that record. Answers carry an x-airuntime-request-id header that opens the same record in the console.

When evidence for a period does not exist yet, AI Runtime shows it as unavailable. A missing value is never reported as zero.

Type to search…

↑↓ navigate↵ selectEsc close