> ## Documentation Index
> Fetch the complete documentation index at: https://phaseo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Phaseo Gateway base URL: https://api.phaseo.app/v1. Send `Authorization: Bearer $PHASEO_API_KEY` with every request.
> Model IDs look like `provider/model`, for example `openai/gpt-6-astra`. Do not guess IDs: list them with `GET /v1/models` or check https://phaseo.app/models. `phaseo/free` routes to an available free model and needs no wallet balance.
> For new text integrations prefer `POST /v1/responses`. `POST /v1/chat/completions` (OpenAI format) and `POST /v1/messages` (Anthropic format) suit existing code.
> The full API contract is https://phaseo.app/docs/openapi/v1/openapi.yaml. Official SDKs: `@phaseo/sdk` (TypeScript) and `phaseo` (Python), plus Go, C#, PHP, Ruby and Rust.
> Search these docs over MCP at https://phaseo.app/docs/mcp, and install Phaseo skills with `npx skills add https://phaseo.app/docs`. If a page is wrong or out of date, report it with the MCP `submit_feedback` tool.
> Manage Phaseo accounts with the `phaseo` CLI (`npm install -g @phaseo/cli`, then `phaseo login` or `phaseo login --device-code`), the `/v1` Management API or the MCP server at `https://mcp.phaseo.app/mcp?access=manage`. Do not send users to the dashboard for account tasks. A person is still needed for sign-up, approving a sign-in, paying the first top-up on the checkout link that `phaseo credits add` returns when no card is saved, confirming each saved-card top-up from the emailed link, and account security (password, MFA, passkeys). Create API keys with `phaseo keys create --name <name> --json`; never guess one. Credit top-ups need `phaseo login --scopes billing:write` first. Task map: https://phaseo.app/docs/v1/developers/manage-from-an-agent.md.

# Glossary

> Find what a Phaseo term means in one sentence, where it applies, and the page that covers it in full.

Look up a word you met in the dashboard, the API or these docs. Each row gives a one-sentence meaning, links to the page that covers the term in full, and lists where it applies: API, Dashboard, CLI, SDK, MCP, Chat or Slack.

## Accounts and access

| Term | Meaning | Applies to |
| - | - | - |
| [Admin](https://phaseo.app/docs/v1/developers/management-api-keys.md) | A workspace role that manages admin-only settings, such as budgets, spend rules, guardrails and trust policies, and reads the audit log. | API, Dashboard, CLI, MCP |
| [Member](https://phaseo.app/docs/v1/developers/management-api-keys.md) | A workspace role that uses the workspace and can see its spend rules, but can't change owner- and admin-only settings. | API, Dashboard, CLI, MCP |
| [Owner](https://phaseo.app/docs/v1/developers/management-api-keys.md) | A workspace role that manages the same admin-only settings as an admin and receives owner emails, such as model deprecation alerts. | API, Dashboard, CLI, MCP |
| [Workspace](https://phaseo.app/docs/v1/guides/workspaces.md) | A container that keeps its own API keys, routing settings, presets, guardrails and admin access separate from other workspaces. | API, Dashboard, CLI |

## Keys and authentication

| Term | Meaning | Applies to |
| - | - | - |
| [API key](https://phaseo.app/docs/v1/developers/authentication.md#choose-a-credential) | A secret starting `phaseo_v1_sk_`, sent as a bearer token to authenticate model and generation requests. | API, Dashboard, CLI, SDK, MCP |
| [BYOK](https://phaseo.app/docs/v1/guides/routing-and-fallbacks.md#byok-considerations) | Bring your own key: Phaseo routes requests with your provider API key, and the provider bills the model usage. | API, Dashboard |
| [BYOK fallback](https://phaseo.app/docs/v1/guides/routing-and-fallbacks.md#byok-considerations) | A workspace setting that decides whether a failed BYOK request may retry on Phaseo credits. | API, Dashboard |
| [Capability](https://phaseo.app/docs/v1/developers/management-api-keys.md#choose-an-access-level) | A permission on a management key or OAuth sign-in, such as `keys:write`, that decides which administration APIs it can call. | API, Dashboard, CLI, MCP |
| [Management key](https://phaseo.app/docs/v1/developers/management-api-keys.md) | A secret starting `phaseo_v1_mk_` for administration APIs such as keys, presets and guardrails; it can't send inference requests. | API, Dashboard |
| [OAuth app](https://phaseo.app/docs/v1/guides/integrations/phaseo-cli.md#oauth-apps) | An app that signs people in with Phaseo OAuth and acts for them within the scopes and workspace they approve. | API, Dashboard, CLI, MCP |
| [Trusted workload](https://phaseo.app/docs/v1/developers/trusted-workloads.md) | A deployment or CI job that sends its platform's short-lived OIDC token instead of an API key, matched by a trust policy. | API, Dashboard |

## Models and providers

| Term | Meaning | Applies to |
| - | - | - |
| [Context length](https://phaseo.app/docs/v1/exploring/models.md#what-a-model-page-shows) | The context size a provider route supports for a model, shown for each provider on the model page. | API, Dashboard |
| [Deprecated (model)](https://phaseo.app/docs/v1/guides/model-retirement.md#how-a-model-is-retired) | The lab or provider has announced the model's retirement, and its requests are still served as usual. | API, Dashboard |
| [Model ID](https://phaseo.app/docs/v1/api-reference/parameters.md#parameter-model) | The ID you send as `model`, such as `openai/gpt-6-astra`, shown in the quickstart on each model page. | API, Dashboard, CLI, SDK, MCP |
| [Private model](https://phaseo.app/docs/v1/guides/private-models.md) | A dedicated or self-hosted OpenAI-compatible deployment added to your workspace, which only your workspace can see or call. | API, Dashboard |
| [Provider](https://phaseo.app/docs/v1/developers/introduction.md#models-and-providers) | A company that hosts a model and sets its availability, supported parameters, pricing and performance. | API, Dashboard, SDK, MCP |
| [Provider status icon](https://phaseo.app/docs/v1/guides/provider-statuses.md#status-icon) | The status Phaseo sets by hand for a provider route: `Active`, `Lower priority` (backup only) or `Disabled`. | Dashboard |
| [Provider-qualified model ID](https://phaseo.app/docs/v1/guides/provider-qualified-models.md) | A model ID with a provider prefix, such as `baseten:thinking-machines/inkling-small`, that runs on that provider with no fallback. | API, SDK |
| [Quantization](https://phaseo.app/docs/v1/guides/quantization.md) | Storing a model's weights in a smaller number type, such as `FP8` or `INT4`, which serves faster at some cost to quality. | API, Dashboard, SDK |
| [Retired (model)](https://phaseo.app/docs/v1/guides/model-retirement.md#how-a-model-is-retired) | The retirement date has passed; requests work while a provider serves the model, then fail with `410 model_retired`. | API, Dashboard |
| [Routable model](https://phaseo.app/docs/v1/exploring/models.md#catalog-models-and-callable-models) | A model with at least one provider route active on the Gateway now; `GET /v1/models` lists only these by default. | API, Dashboard, MCP |

## Requests and responses

| Term | Meaning | Applies to |
| - | - | - |
| [Cached tokens](https://phaseo.app/docs/v1/guides/prompt-caching.md#usage-and-pricing-fields) | Input tokens the provider read from its prompt cache, billed at the cache-read rate and reported as `cached_tokens`. | API, SDK |
| [Gateway](https://phaseo.app/docs/v1/developers/introduction.md) | The Phaseo API at `https://api.phaseo.app/v1`, which routes each request to a provider that hosts the model. | API, SDK |
| [Generation ID](https://phaseo.app/docs/v1/api-reference/endpoint/generation.md) | The `G-` request ID returned in `x-request-id` and error bodies; use it for logs, lookups and support. | API, Dashboard, SDK |
| [Prompt caching](https://phaseo.app/docs/v1/guides/prompt-caching.md) | Keeping the start of a prompt the same so the provider reads it from cache and bills it at the cache-read rate. | API, SDK |
| [Reasoning effort](https://phaseo.app/docs/v1/api-reference/parameters.md#parameter-reasoning) | How much a reasoning model thinks before answering, set with `reasoning.effort` or `reasoning_effort`, from `none` to `max`. | API, SDK |
| [Reasoning tokens](https://phaseo.app/docs/v1/guides/context-and-token-budgeting.md#what-counts-towards-a-request) | Tokens a reasoning model spends before it answers; they count as output and use part of the output limit. | API, SDK |
| [Service tier](https://phaseo.app/docs/v1/guides/service-tiers.md) | A speed and price tier for a text request (`standard`, `fast`, `ultrafast` or `flex`), served only by providers offering it. | API, SDK |
| [Session ID](https://phaseo.app/docs/v1/guides/routing-and-fallbacks.md#keep-a-conversation-on-one-provider) | A `session_id` you send to keep a conversation's requests on one provider, for up to 24 hours of activity. | API, Dashboard, SDK |
| [Streaming](https://phaseo.app/docs/v1/guides/streaming.md) | Setting `stream: true` so the Gateway sends output as server-sent events while the model writes it. | API, SDK |
| [Tokens](https://phaseo.app/docs/v1/guides/context-and-token-budgeting.md) | The units a model reads as input and writes as output; every token adds latency and cost. | API, Dashboard, SDK |
| [Usage object](https://phaseo.app/docs/v1/guides/prompt-caching.md#usage-and-pricing-fields) | The `usage` field in a response, which reports input, output and cache token counts for the request. | API, SDK |

## Routing

| Term | Meaning | Applies to |
| - | - | - |
| [Alpha and beta provider channels](https://phaseo.app/docs/v1/guides/routing-and-fallbacks.md#choose-how-providers-are-ranked) | Routing settings toggles so preview providers get traffic only when you opt in; `provider.include_alpha` allows alpha providers per request. | API, Dashboard |
| [Auto Routing](https://phaseo.app/docs/v1/guides/auto-routing.md) | Send `phaseo/auto` and Phaseo picks a model for each request from the workload, your objective and price limits. | API, Dashboard, CLI, SDK, Slack |
| [Dynamic route](https://phaseo.app/docs/v1/guides/routing-and-fallbacks.md#attach-routing-rules-to-api-keys) | A versioned flow of rules attached to API keys that can branch, split traffic, cap usage and switch models. | API, Dashboard |
| [Free router](https://phaseo.app/docs/v1/cookbook/free-router-first-deploy.md) | Send `phaseo/free` and Phaseo runs the request on an available free model, with no credits needed. | API, SDK |
| [Model fallbacks](https://phaseo.app/docs/v1/guides/routing-and-fallbacks.md#request-level-model-fallbacks) | Models listed in `models`, tried in order when the previous model ends in `429`, `500`, `502`, `503` or `504`. | API, SDK |
| [Preset](https://phaseo.app/docs/v1/guides/presets.md) | A saved model, system prompt, parameters and provider rules that callers use by sending its name, such as `@support-triage`. | API, Dashboard, SDK |
| [Preset version label](https://phaseo.app/docs/v1/guides/prompt-templates.md#labels) | A name such as `production` that points at one published preset version; moving it rolls requests forward or back. | API, Dashboard, SDK |
| [Prompt template](https://phaseo.app/docs/v1/guides/prompt-templates.md) | Preset messages with `{{variables}}`, so each request sends only the preset reference and the variable values. | API, Dashboard, SDK |
| [Provider fallback](https://phaseo.app/docs/v1/guides/routing-and-fallbacks.md) | When the chosen provider fails, the Gateway tries the next eligible provider for the same model. | API, SDK |
| [Provider sorting](https://phaseo.app/docs/v1/guides/routing-and-fallbacks.md#choose-how-providers-are-ranked) | How providers are ranked: `balanced` (default, cost per successful answer), `price`, `latency` or `throughput`. | API, Dashboard, CLI, SDK |
| [Regional routing](https://phaseo.app/docs/v1/guides/regional-routing.md) | Sending text requests to `eu.api.phaseo.app` or `us.api.phaseo.app` to use only routes that run there. | API, SDK |
| [Retired model routing](https://phaseo.app/docs/v1/guides/model-retirement.md#route-requests-to-a-replacement-automatically) | An opt-in workspace setting that sends requests for a model no provider serves to an approved or chosen replacement. | API, Dashboard |

## Guardrails and privacy

| Term | Meaning | Applies to |
| - | - | - |
| [Guardrail](https://phaseo.app/docs/v1/cookbook/guardrails-for-api-keys.md) | A policy on API keys or members that limits providers, models and data handling, and scans prompts; it doesn't cap spend. | API, Dashboard |
| [Guardrail action](https://phaseo.app/docs/v1/cookbook/guardrails-for-api-keys.md) | What a guardrail content check does when it matches: Flag, Redact or Block. | API, Dashboard |
| [I/O logging](https://phaseo.app/docs/v1/guides/open-requests-in-chat.md#before-you-start) | A privacy setting that stores each request's prompt and response, so you can view, replay or open it in Chat. | API, Dashboard, Chat |
| [Prompt injection check](https://phaseo.app/docs/v1/cookbook/guardrails-for-api-keys.md) | A guardrail check that scans user-supplied content for common prompt injection patterns. | API, Dashboard |
| [Sensitive info check](https://phaseo.app/docs/v1/cookbook/guardrails-for-api-keys.md) | A guardrail check that finds data such as email addresses, phone numbers and card numbers before the request leaves Phaseo. | API, Dashboard |
| [ZDR](https://phaseo.app/docs/v1/cookbook/route-only-to-eu-or-zdr-providers.md) | Zero data retention: the provider doesn't keep prompts or outputs; require it per request, per guardrail or per workspace. | API, Dashboard, CLI, SDK, MCP |

## Tools and outputs

| Term | Meaning | Applies to |
| - | - | - |
| [Decisions API](https://phaseo.app/docs/v1/api-reference/endpoint/decisions.md) | `POST /v1/decisions`, which answers typed questions (`predicate`, `choice`, `score`) with probabilities, in the order asked. | API, SDK |
| [Response healing](https://phaseo.app/docs/v1/cookbook/response-healing-for-structured-json.md) | A plugin that repairs almost-valid JSON, such as JSON in a Markdown fence, before it reaches your parser. | API, SDK |
| [Server tool](https://phaseo.app/docs/v1/guides/server-tools.md) | A `phaseo:` tool Phaseo runs when the model calls it, such as `phaseo:web_search`, `phaseo:web_fetch`, `phaseo:datetime` or `phaseo:advisor`. | API, SDK, Chat |
| [Structured outputs](https://phaseo.app/docs/v1/guides/structured-outputs.md) | Sending a JSON Schema so the model returns JSON in that shape instead of free text. | API, SDK |
| [Tool calling](https://phaseo.app/docs/v1/guides/tool-calling.md) | Describing your functions in `tools` so the model returns a call your app runs, then answers with the result. | API, SDK |

## Cost, limits and billing

| Term | Meaning | Applies to |
| - | - | - |
| [Budget](https://phaseo.app/docs/v1/api-reference/limits.md#key-limits-and-budgets) | A workspace spend ceiling (daily, weekly, monthly or lifetime); requests past it get `429 key_limit_exceeded`. | API, Dashboard |
| [Credits](https://phaseo.app/docs/v1/pricing/tiers.md) | Prepaid workspace balance that paid requests spend at catalog prices; purchases carry a 5% fee (\$1 minimum), and `:free` models need none. | API, Dashboard, CLI, MCP |
| [Department budget](https://phaseo.app/docs/v1/api-reference/limits.md#department-budgets) | A daily, weekly or monthly spend ceiling on the keys and OAuth requests that count toward one department. | API, Dashboard |
| [Key limit](https://phaseo.app/docs/v1/api-reference/limits.md#key-limits-and-budgets) | A daily, weekly or monthly request or spend cap on one API key, checked on every request. | API, Dashboard, CLI |
| [Rate limit](https://phaseo.app/docs/v1/api-reference/limits.md#gateway-limits) | The requests-per-minute allowance for each user in each workspace, which rises as the workspace becomes established. | API, CLI |
| [Spend alert](https://phaseo.app/docs/v1/guides/spend-alerts.md#alert-types-and-bases) | The notification a spend rule sends when spend, a forecast, a spike or the balance crosses its threshold. | API, Dashboard |
| [Spend rule](https://phaseo.app/docs/v1/guides/spend-alerts.md) | A rule that alerts when spend for a scope crosses a threshold, and can block further requests with `429 spend_rule_blocked`. | API, Dashboard |

## Observability

| Term | Meaning | Applies to |
| - | - | - |
| [App attribution](https://phaseo.app/docs/v1/guides/app-attribution.md#headers) | Headers such as `X-App-Id`, `X-Title` and `HTTP-Referer` that group a request's usage under one app. | API, SDK |
| [Audit log](https://phaseo.app/docs/v1/guides/workspace-audit-log.md) | The record of who changed keys, members and other admin controls, which only owners and admins can read. | API, Dashboard, CLI |
| [Broadcast](https://phaseo.app/docs/v1/guides/broadcast.md) | Sends a trace of each gateway request to an observability tool, webhook, storage bucket or data warehouse, with no code changes. | API, Dashboard |
| [Open in Chat](https://phaseo.app/docs/v1/guides/open-requests-in-chat.md) | Continues a stored request or session turn as a conversation in Chat, with the same model or another. | Dashboard, Chat |
| [Request classifier](https://phaseo.app/docs/v1/guides/request-classifiers.md) | A taxonomy and a model that label each finished request, stored as request labels you can filter by. | API, Dashboard |
| [Request label](https://phaseo.app/docs/v1/guides/request-labels.md) | A key/value pair, such as `team=support`, sent in the `X-Phaseo-Metadata` header to filter spend and logs. | API, SDK |
| [Request logs](https://phaseo.app/docs/v1/api-reference/endpoint/logs-list.md) | A record for each request with its usage, latency, cost, errors and the provider that served it. | API, Dashboard, CLI, MCP |

## Async jobs

| Term | Meaning | Applies to |
| - | - | - |
| [Async job](https://phaseo.app/docs/v1/guides/async-video-and-batch.md) | A video or batch request that returns a job at once; you poll it or wait for a webhook until it finishes. | API, SDK |
| [Batch](https://phaseo.app/docs/v1/api-reference/endpoint/batches-create.md) | A Batch API job for large deferred workloads, where each row targets one model. | API, SDK |
| [Video job](https://phaseo.app/docs/v1/guides/async-video-and-batch.md) | A Video API request that returns a job; download the video once its status is `completed`. | API, SDK |
| [Webhook endpoint](https://phaseo.app/docs/v1/guides/async-video-and-batch.md#receive-updates) | A workspace URL that receives signed status events for video and batch jobs. | API, Dashboard |

## Enterprise

| Term | Meaning | Applies to |
| - | - | - |
| [Department](https://phaseo.app/docs/v1/guides/spend-alerts.md#choose-whose-spend-counts) | A group of workspace members, managed by hand or synced from your directory, that budgets, rate limits and spend rules can target. | API, Dashboard |
| [Directory](https://phaseo.app/docs/v1/api-reference/endpoint/identity-directory-get.md) | The workspace's enterprise departments and each member's effective entitlements, managed by owners and admins. | API, Dashboard |
| [Identity add-on](https://phaseo.app/docs/v1/api-reference/endpoint/identity-scim-get.md) | The workspace add-on needed to turn on SSO or SCIM, create provisioning tokens and manage the directory. | API, Dashboard |
| [SCIM](https://phaseo.app/docs/v1/api-reference/endpoint/identity-scim-get.md) | Provisioning workspace members and departments from your identity provider with a SCIM provisioning token. | API, Dashboard |
| [Self Serve Enterprise](https://phaseo.app/docs/v1/exploring/subscription-plans.md#enterprise-member-pricing) | A monthly workspace subscription for SSO, SCIM, directory management, departments and priority email support. | Dashboard |
| [SSO](https://phaseo.app/docs/v1/api-reference/endpoint/identity-sso-get.md) | Single sign-on for workspace members through SAML or a custom OIDC provider. | API, Dashboard |

## CLI, MCP, SDKs and apps

| Term | Meaning | Applies to |
| - | - | - |
| [Agent skills](https://phaseo.app/docs/v1/cookbook/coding-agents-skill-md.md) | Public Phaseo instructions for coding agents, covering the Gateway, SDKs, presets, routing and migrations. | API, CLI, SDK |
| [Client SDK](https://phaseo.app/docs/v1/sdk-reference/client/overview.md) | A Phaseo package for your language with one method per Gateway endpoint, such as `@phaseo/sdk` or `phaseo`. | SDK |
| [Docs MCP](https://phaseo.app/docs/v1/guides/integrations/docs-mcp.md) | A read-only MCP server at `https://phaseo.app/docs/mcp` that lets coding assistants search and read these docs. | MCP |
| [Phaseo CLI](https://phaseo.app/docs/v1/developers/cli-and-mcp.md#phaseo-cli) | The `phaseo` command for creating keys, changing settings and automating admin work from a shell or CI. | CLI |
| [Phaseo MCP](https://phaseo.app/docs/v1/developers/cli-and-mcp.md#phaseo-mcp) | An MCP server that gives AI clients live model, pricing, usage and workspace data, and can optionally manage your account. | MCP |
| [Slack agent](https://phaseo.app/docs/v1/guides/slack-agent.md) | The Phaseo agent in Slack, which answers mentions and direct messages with the model your workspace chose. | Dashboard, Slack |

## Feature stages

| Term | Meaning | Applies to |
| - | - | - |
| [Alpha](https://phaseo.app/docs/v1/developers/feature-maturity.md) | An early feature that may change a lot or be removed. | API, Dashboard, CLI, SDK, MCP, Chat, Slack |
| [Beta](https://phaseo.app/docs/v1/developers/feature-maturity.md) | A feature that works for its main use, though details may change; changes are announced in the changelog. | API, Dashboard, CLI, SDK, MCP, Chat, Slack |
| [Deprecated (feature)](https://phaseo.app/docs/v1/developers/feature-maturity.md) | A feature that still works but will be removed; its page gives the removal date when one is set. | API, Dashboard, CLI, SDK, MCP, Chat, Slack |
| [Feature Preview](https://phaseo.app/docs/v1/developers/feature-maturity.md#who-can-use-a-feature) | The settings page that shows whether the Video and Batch APIs are turned on for your workspace. | Dashboard |
| [On request](https://phaseo.app/docs/v1/developers/feature-maturity.md#who-can-use-a-feature) | A feature that is turned on per workspace; until it is, its settings page is hidden and its API returns an error. | API, Dashboard |
| [Generally available](https://phaseo.app/docs/v1/developers/feature-maturity.md) | A stable feature, shown with no stage badge. | API, Dashboard, CLI, SDK, MCP, Chat, Slack |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.