> ## Documentation Index > Fetch the complete documentation index at: https://docs.inquantum.ai/llms.txt > Use this file to discover all available pages before exploring further. # Planck Header Directory > Customer-facing headers supported by the Planck AI Gateway. Use these headers with the AI Gateway at: ```text theme={null} https://api.inquantum.ai ``` Most OpenAI-compatible SDKs should use `Authorization: Bearer $PLANCK_API_KEY`. Use `Planck-Auth` when you need `Authorization` to carry a provider key for BYOK. `Planck-*` headers are canonical. Existing `Bifrost-*` headers remain accepted; when both forms are present, the Planck value takes precedence. See [Bifrost compatibility](/getting-started/migrating-from-bifrost). ```bash theme={null} curl https://api.inquantum.ai/v1/chat/completions \ -H "Authorization: Bearer $PLANCK_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "gpt-4o-mini", "messages": [{ "role": "user", "content": "Hello" }] }' ``` ## Authentication Standard bearer auth. Use `Bearer ` for normal gateway requests. Planck-specific auth header. Use this when `Authorization` must contain a provider API key. Alternate API key header for Planck keys. Explicit BYOK provider key header. Use this for OpenAI, Anthropic, or custom target provider keys. Alternate explicit BYOK provider key header. ## Routing Optional request-level billing mode: `byok`, `ptb`, or `auto`. Omitted/`auto` uses stored BYOK first, then PTB. Explicit `byok` or `ptb` is strict and fails if that mode is unavailable. Base URL for an approved custom or self-hosted OpenAI-compatible target. Custom targets are BYOK-only and are only available for supported operations. Alternate OpenAI-compatible base URL override for OpenAI-compatible requests. Controls request/response body mapping for custom target routing. Supported values are `OPENAI`, `RESPONSES`, and `NO_MAPPING`. Overrides the model used for cost calculation and provider mapping when the model cannot be derived from the request. Defines an explicit fallback chain. Each item can include `target-url`, `headers`, `onCodes`, and `bodyKeyOverride`. ## Request Identity Optional request UUID. If omitted, Planck generates one. User identifier for analytics, cost attribution, sessions, and user metrics. Optional Stripe customer identifier for billing-related workflows. Optional node or deployment identifier for routing and analytics. ## Custom Properties Adds custom metadata to the request. For example, `Planck-Property-Environment: production`. Groups requests into a session. Tracks nested request paths within a session. Human-readable session name. ## Memory Opts a request into user memory when org, feature flag, and context profile settings also allow memory. If omitted or false, the request remains pass-through for memory. Advanced personalization layers, such as personalized ranking and persona hints, use this same explicit opt-in path. Optional memory namespace within an organization and user, such as an app ID, project, customer tenant, or `default`. ## Planck Context Selects an organization knowledge base by UUID. The authenticated API key or user must have read access. `x-planck-knowledge-base` remains a deprecated compatibility alias; when both are present, `Planck-Knowledge-Base` wins. Selects up to 16 comma-separated managed knowledge pack UUIDs. Every pack must be active and granted either directly to the request organization or by its tier policy. This is additive with `Planck-Knowledge-Base` and context-profile sources. Selects a workflow context. Selects an environment such as `development`, `staging`, or `production`. Selects a context profile. ## Caching Enables response caching for eligible requests. Sets cache duration, for example `max-age=3600`. Sets how many different responses can be cached for the same key. Adds a cache namespace, such as a user or tenant id. Comma-separated JSON keys to exclude from cache key generation. ## Retries Enables automatic retry behavior. Maximum retry attempts. Exponential backoff factor. Minimum retry delay in milliseconds. Maximum retry delay in milliseconds. ## Prompt And Safety Associates the request with a managed prompt. Selects prompt behavior, such as testing mode. Selects a prompt version. Selects prompt formatting behavior. Human-readable prompt name. Enables prompt security checks. Alias for prompt security checks. Advanced prompt security mode. Enables moderation checks for supported request paths. ## Streaming And Timeouts Forces OpenAI-compatible stream formatting. Requests usage data in streamed responses when supported. Requests an increased timeout for long-running operations. ## Privacy Omits request body data from logs where supported. Omits response body data from logs where supported. ## Integrations PostHog project key. PostHog host. Lytix integration key. Lytix host. Enables configured webhook side effects for the request. ## Experiments Experiment identifier. Experiment column identifier. Experiment row index. ## Manual Access Manual access key for approved manual logging or access workflows. ## Response Headers | Header | Description | | ---------------------------- | ------------------------------------------------ | | `Planck-Id` | Request id used by Planck. | | `Planck-Status` | `success` or `failed` for the gateway response. | | `Planck-Cache` | Cache status, such as `HIT` or `MISS`. | | `Planck-Cache-Bucket-Idx` | Cache bucket index used for the response. | | `Planck-Fallback-Index` | Fallback index used for the response. | | `Planck-RateLimit-Limit` | Active rate-limit quota. | | `Planck-RateLimit-Remaining` | Remaining quota in the active rate-limit window. | | `Planck-RateLimit-Policy` | Active rate-limit policy. | | `Planck-RateLimit-Reset` | Seconds until the active rate limit resets. | | `X-Planck-Error` | Machine-readable gateway error classification. | Legacy `Bifrost-*` response names are emitted alongside these headers during the compatibility period. ## Webhook Delivery Headers | Header | Description | | ------------------------- | ---------------------------------------------- | | `Planck-Signature` | HMAC signature for the webhook body. | | `Planck-Delivery-Id` | Stable identifier for a webhook delivery. | | `Planck-Delivery-Attempt` | One-based delivery attempt number as a string. | Legacy `Bifrost-*` webhook names are emitted alongside these headers during the compatibility period.