@leaflow/sdk 0.0.0-dev.42.g9fdf74a → 0.0.0-dev.422.gef294af

package/dist/canopy/v1/generated/models.d.ts

@@ -0,0 +1,970 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow Canopy API
+ * Canopy model inference, API keys, model catalogue, service enablement and recorded usage.
+ *
+ * Project inference is served on this host in each provider's own protocol:
+ *
+ * - OpenAI: `/v1/chat/completions`, `/v1/responses` and `/v1/embeddings`; use
+ *   `https://canopy.leaflow.cloud/v1` as the OpenAI SDK base URL.
+ * - Anthropic: `/v1/messages`; use `https://canopy.leaflow.cloud` as the Anthropic SDK base URL.
+ * - Gemini: `/v1beta/models/{model}:generateContent` and `:streamGenerateContent`.
+ *
+ * Canopy does not convert between protocols. A request is accepted only for a model whose
+ * `supported_endpoints` lists the endpoint it was sent to, and it is forwarded unchanged except for
+ * the model name and the credentials. Reasoning settings such as `reasoning_effort` are passed
+ * through as written; a model's `capabilities` lists the values its upstream accepts.
+ *
+ * Management operations use `/api/v1`. The management model catalogue names how each model is billed in Billing;
+ * `/v1/models` returns the OpenAI model format with Canopy capabilities and parameter limits.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * Management and project inference accept the same verified IAM scoped token. The token is the
+ * sole billing project authority; `OpenAI-Project` and historical identity headers cannot
+ * override it. These endpoints do not accept a Canopy API key. The separate API-key gateway
+ * accepts Canopy API keys and serves the same endpoints.
+ *
+ * ## Conventions
+ *
+ * - **The plaintext of an API key is returned once.** The `secret` appears in the response that issues it and is returned by no other endpoint. A key that has been lost has to be revoked and reissued.
+ * - **Disabling and revoking are distinct.** A disabled key may be enabled again at any time, while a revocation is irreversible and is intended for a key that has been exposed. Neither removes the record, and the usage the key accrued remains readable.
+ * - **A usage query must carry a time range**, spanning no more than 31 days, or 400 days for the usage timeline. `from` and `to` carry a timezone offset, which the server does not infer.
+ * - **The request and response bodies do not appear in the ledger.** They are not recorded. Quote the `upstream_request_id` from the response when reporting a problem.
+ * - **Usage may be estimated.** The upstream provider does not report usage on every request. Where it does not, `usage_source` is `estimated` and the figures are derived from the character classes of the payload, to within roughly fifteen per cent.
+ * - **The service is enabled before use.** A project enables the model platform once, through `create-service`; the forwarding endpoints refuse its requests until the service is `active`. Requests are then billed under the service's subscription by the tokens they use, at the rates Billing holds for each model's `billing`.
+ * OpenAPI spec version: 1.0.0
+ */
+export type ReasoningDiagnosticsRequested = {
+    [key: string]: unknown;
+};
+export interface ReasoningDiagnostics {
+    requested: ReasoningDiagnosticsRequested;
+}
+export type ChatCompletionRequestMessagesItem = {
+    [key: string]: unknown;
+};
+export interface ChatCompletionRequest {
+    /** @minLength 1 */
+    model: string;
+    /** @minItems 1 */
+    messages: ChatCompletionRequestMessagesItem[];
+    stream?: boolean;
+    /** @minimum 1 */
+    max_tokens?: number;
+    /** @minimum 1 */
+    max_completion_tokens?: number;
+    reasoning_effort?: string;
+    [key: string]: unknown;
+}
+export interface ChatCompletion {
+    [key: string]: unknown;
+}
+export type EmbeddingRequestEncodingFormat = (typeof EmbeddingRequestEncodingFormat)[keyof typeof EmbeddingRequestEncodingFormat];
+export declare const EmbeddingRequestEncodingFormat: {
+    readonly float: "float";
+    readonly base64: "base64";
+};
+export interface EmbeddingRequest {
+    /** @minLength 1 */
+    model: string;
+    /** A nonempty string, string array, token integer array, or array of token integer arrays. */
+    input: string | unknown[];
+    encoding_format?: EmbeddingRequestEncodingFormat;
+    /** @minimum 1 */
+    dimensions?: number;
+    user?: string;
+    [key: string]: unknown;
+}
+export interface EmbeddingResponse {
+    [key: string]: unknown;
+}
+export type Modality = (typeof Modality)[keyof typeof Modality];
+export declare const Modality: {
+    readonly text: "text";
+    readonly image: "image";
+    readonly audio: "audio";
+    readonly video: "video";
+    readonly file: "file";
+    readonly embedding: "embedding";
+};
+/**
+ * @nullable
+ */
+export type ReasoningCapabilitiesBudgetTokens = {
+    /** @minimum 0 */
+    min: number;
+    /** @minimum 0 */
+    max: number;
+} | null;
+export interface ReasoningCapabilities {
+    supported: boolean;
+    /**
+     * The effort values the upstream accepts, sent through unchanged. Agents send low, medium or high. Null means unknown; an empty array means effort is not configurable.
+     * @nullable
+     */
+    effort_levels: string[] | null;
+    /** @nullable */
+    default_effort: string | null;
+    /** @nullable */
+    modes: string[] | null;
+    /** @nullable */
+    budget_tokens: ReasoningCapabilitiesBudgetTokens;
+    /** @nullable */
+    summary: string[] | null;
+}
+export interface EndpointCapabilities {
+    /** @nullable */
+    function_calling: boolean | null;
+    /** @nullable */
+    structured_output: boolean | null;
+    reasoning: ReasoningCapabilities | null;
+}
+/**
+ * Verified capabilities keyed by API endpoint, for example /v1/chat/completions or /v1/responses. Missing keys and null values mean unknown. Current route availability is separate.
+ */
+export interface ModelCapabilities {
+    [key: string]: EndpointCapabilities;
+}
+export type ModelEndpoint = (typeof ModelEndpoint)[keyof typeof ModelEndpoint];
+export declare const ModelEndpoint: {
+    readonly "/v1/chat/completions": "/v1/chat/completions";
+    readonly "/v1/responses": "/v1/responses";
+    readonly "/v1/embeddings": "/v1/embeddings";
+    readonly "/v1/messages": "/v1/messages";
+    readonly "/v1beta/models/{model}:generateContent": "/v1beta/models/{model}:generateContent";
+    readonly "/v1/images/generations": "/v1/images/generations";
+    readonly "/v1/images/edits": "/v1/images/edits";
+    readonly "/v1/audio/transcriptions": "/v1/audio/transcriptions";
+    readonly "/v1/audio/translations": "/v1/audio/translations";
+    readonly "/v1/audio/speech": "/v1/audio/speech";
+    readonly "/v1/realtime": "/v1/realtime";
+};
+export interface Model {
+    id: string;
+    object: "model";
+    created: number;
+    owned_by: string;
+    display_name: string;
+    context_length: number;
+    max_output_tokens: number;
+    /** The model developer; not the upstream provider or model family. */
+    developer: string;
+    description: string;
+    /**
+     * Accepted input modalities. Null means unknown.
+     * @nullable
+     */
+    input_modalities: Modality[] | null;
+    /**
+     * Produced output modalities. Image input does not imply image generation.
+     * @nullable
+     */
+    output_modalities: Modality[] | null;
+    capabilities: ModelCapabilities;
+    /** Explicitly supported API endpoints. Requests to any other endpoint are rejected before upstream admission. */
+    supported_endpoints: ModelEndpoint[];
+}
+export interface ModelList {
+    object: "list";
+    data: Model[];
+}
+export type InferenceErrorError = {
+    message: string;
+    type: string;
+    /** @nullable */
+    param?: string | null;
+    /** @nullable */
+    code?: string | null;
+    [key: string]: unknown;
+};
+export interface InferenceError {
+    error: InferenceErrorError;
+}
+export interface FieldViolation {
+    /** The path to the rejected field in the request body, such as `items[2].price_id`. */
+    field: string;
+    /** Why the field was rejected, such as `REQUIRED` or `OUT_OF_RANGE`. */
+    reason?: string;
+}
+/**
+ * Values that belong to `reason`, one set per reason. Clients use them to fill in
+ * localized text and never parse `message` to obtain them. Keys are documented per
+ * reason; a key that has appeared once keeps appearing.
+ */
+export type ErrorStatusMetadata = {
+    [key: string]: string;
+};
+export interface ErrorStatus {
+    /** The HTTP status code of the response. */
+    code: number;
+    /** The canonical name of the status, such as `INVALID_ARGUMENT` or `UNAVAILABLE`. */
+    status: string;
+    /**
+     * A description of the failure for developers. It is always English and is not meant
+     * to be shown to end users as is.
+     */
+    message: string;
+    /**
+     * A stable machine-readable code identifying the failure. Clients branch on this value
+     * and render their own text; it does not change once published.
+     */
+    reason?: string;
+    /**
+     * Values that belong to `reason`, one set per reason. Clients use them to fill in
+     * localized text and never parse `message` to obtain them. Keys are documented per
+     * reason; a key that has appeared once keeps appearing.
+     */
+    metadata?: ErrorStatusMetadata;
+    /**
+     * Request fields rejected by the request's constraints. Present on validation
+     * failures; one request may violate several fields.
+     */
+    field_violations?: FieldViolation[];
+    /**
+     * How long the client should wait before retrying, as a duration string such as
+     * `30s`. Present only when waiting can succeed.
+     */
+    retry_delay?: string;
+    /**
+     * The identifier of the request in the service's logs. Quote it when reporting a
+     * failure.
+     */
+    request_id?: string;
+}
+/**
+ * A failed request. The envelope follows the Google REST error format: `code` is the HTTP
+ * status, `status` is its canonical name, and `reason` is the stable machine-readable code
+ * that identifies the failure.
+ */
+export interface Error {
+    error: ErrorStatus;
+}
+export type APIKeyResourceStatus = (typeof APIKeyResourceStatus)[keyof typeof APIKeyResourceStatus];
+export declare const APIKeyResourceStatus: {
+    readonly active: "active";
+    readonly disabled: "disabled";
+    readonly revoked: "revoked";
+};
+export interface APIKeyResource {
+    /** Carries no meaning while `restrict_models` is false */
+    allowed_models: string[];
+    created_at: string;
+    /** Who created the key */
+    created_by: string;
+    /**
+     * When the key expires. Null means it never expires
+     * @nullable
+     */
+    expires_at: string | null;
+    id: string;
+    /** The last four characters of the plaintext */
+    last_four: string;
+    /**
+     * When the key was last used to forward a request successfully, accurate to about a minute
+     * @nullable
+     */
+    last_used_at: string | null;
+    name: string;
+    /** The leading characters of the plaintext, by which a key is recognised in a list */
+    prefix: string;
+    /** While true, only the models listed in `allowed_models` are permitted */
+    restrict_models: boolean;
+    status: APIKeyResourceStatus;
+    /** True indicates that the key was disabled because its project is suspended, and that the project has to be restored before the key can be used again */
+    suspended: boolean;
+}
+export interface LengthAwarePageAPIKeyResource {
+    /** The items in this page */
+    items: APIKeyResource[];
+    /** Maximum number of items in this page, echoing the request */
+    limit: number;
+    /** Number of items skipped, echoing the request */
+    offset: number;
+    /** Total number of matches, not only this page */
+    total: number;
+}
+export interface CreateAPIKeyRequestBody {
+    /**
+     * Ignored while `restrict_models` is false
+     * @nullable
+     */
+    allowed_models?: string[] | null;
+    /**
+     * When the key expires. Omitted means it never expires
+     * @nullable
+     */
+    expires_at?: string | null;
+    /**
+     * A name for the holder's own use, such as CI or Production
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    /** While true, only the models listed in `allowed_models` are permitted */
+    restrict_models?: boolean;
+}
+export type IssuedAPIKeyResourceStatus = (typeof IssuedAPIKeyResourceStatus)[keyof typeof IssuedAPIKeyResourceStatus];
+export declare const IssuedAPIKeyResourceStatus: {
+    readonly active: "active";
+    readonly disabled: "disabled";
+    readonly revoked: "revoked";
+};
+export interface IssuedAPIKeyResource {
+    /** Carries no meaning while `restrict_models` is false */
+    allowed_models: string[];
+    created_at: string;
+    /** Who created the key */
+    created_by: string;
+    /**
+     * When the key expires. Null means it never expires
+     * @nullable
+     */
+    expires_at: string | null;
+    id: string;
+    /** The last four characters of the plaintext */
+    last_four: string;
+    /**
+     * When the key was last used to forward a request successfully, accurate to about a minute
+     * @nullable
+     */
+    last_used_at: string | null;
+    name: string;
+    /** The leading characters of the plaintext, by which a key is recognised in a list */
+    prefix: string;
+    /** While true, only the models listed in `allowed_models` are permitted */
+    restrict_models: boolean;
+    /** The complete key, **returned in this response only**. Store it immediately */
+    secret: string;
+    status: IssuedAPIKeyResourceStatus;
+    /** True indicates that the key was disabled because its project is suspended, and that the project has to be restored before the key can be used again */
+    suspended: boolean;
+}
+export interface UpdateAPIKeyRequestBody {
+    /** @nullable */
+    allowed_models?: string[] | null;
+    /** True removes the expiry */
+    clear_expiry?: boolean;
+    /**
+     * Sets the expiry. To remove it, use `clear_expiry`
+     * @nullable
+     */
+    expires_at?: string | null;
+    /**
+     * @maxLength 128
+     * @nullable
+     */
+    name?: string | null;
+    /** @nullable */
+    restrict_models?: boolean | null;
+}
+export type ModelResourceStatus = (typeof ModelResourceStatus)[keyof typeof ModelResourceStatus];
+export declare const ModelResourceStatus: {
+    readonly available: "available";
+    readonly draining: "draining";
+    readonly retired: "retired";
+};
+export type ModelMeterTokenKind = (typeof ModelMeterTokenKind)[keyof typeof ModelMeterTokenKind];
+export declare const ModelMeterTokenKind: {
+    readonly input: "input";
+    readonly output: "output";
+    readonly cache_read: "cache_read";
+    readonly cache_write: "cache_write";
+    readonly reasoning: "reasoning";
+};
+/**
+ * The dimension values the usage of this token kind carries, and the rate is matched at.
+ */
+export type ModelMeterDimensions = {
+    [key: string]: string;
+};
+export interface ModelMeter {
+    token_kind: ModelMeterTokenKind;
+    meter_lookup_key: string;
+    /** The dimension values the usage of this token kind carries, and the rate is matched at. */
+    dimensions: ModelMeterDimensions;
+}
+/**
+ * How requests to a model are billed: under the service's subscription, on the Billing plan `plan_id`, one rate for each token kind. Read the rates from Billing with `search-prices` for the plan, narrowing each price's `rates` with each meter's `dimensions`.
+ *
+ * Each token kind is priced on its own. `input` excludes cached input, which is `cache_read`, and `output` excludes reasoning the provider reports separately, which is `reasoning`; a request is billed for each kind it used.
+ *
+ * Rates are set per currency, and a currency may not offer a model at all. A model is offered in the currency of the project's billing account when at least one of its token kinds has a rate there; a token kind without a rate in that currency is not charged. Requests to a model with no rate in that currency are refused with 403 `BILLING_MODEL_NOT_OFFERED`.
+ */
+export interface ModelBilling {
+    /**
+     * The Billing plan of the service; null where the service is not sold.
+     * @nullable
+     */
+    plan_id: string | null;
+    /** One entry for each of the five token kinds, in the order input, output, cache_read, cache_write, reasoning. */
+    meters: ModelMeter[];
+}
+export interface ModelResource {
+    /** The context window. Advisory only; the server does not truncate on its basis */
+    context_length: number;
+    display_name: string;
+    /** Groups the models of one family together, such as claude, gpt or gemini */
+    family: string;
+    /** The string to send in the `model` field of the request body */
+    id: string;
+    /** The maximum output length. Advisory only */
+    max_output_tokens: number;
+    billing: ModelBilling;
+    status: ModelResourceStatus;
+    /** The model developer; not the upstream provider or model family. */
+    developer: string;
+    description: string;
+    /**
+     * Accepted input modalities. Null means unknown.
+     * @nullable
+     */
+    input_modalities: Modality[] | null;
+    /**
+     * Produced output modalities. Image input does not imply image generation.
+     * @nullable
+     */
+    output_modalities: Modality[] | null;
+    capabilities: ModelCapabilities;
+    /** Explicitly supported API endpoints. Requests to any other endpoint are rejected before upstream admission. */
+    supported_endpoints: ModelEndpoint[];
+}
+export interface ModelListResponseBody {
+    items: ModelResource[];
+}
+export type RequestResourceStatus = (typeof RequestResourceStatus)[keyof typeof RequestResourceStatus];
+export declare const RequestResourceStatus: {
+    readonly in_flight: "in_flight";
+    readonly succeeded: "succeeded";
+    readonly refused: "refused";
+    readonly upstream_failed: "upstream_failed";
+    readonly client_aborted: "client_aborted";
+};
+/**
+ * upstream means the figures were reported by the provider; estimated means they were derived from the character classes of the payload
+ */
+export type RequestResourceUsageSource = (typeof RequestResourceUsageSource)[keyof typeof RequestResourceUsageSource];
+export declare const RequestResourceUsageSource: {
+    readonly none: "none";
+    readonly upstream: "upstream";
+    readonly estimated: "estimated";
+};
+export interface RequestResource {
+    /**
+     * Null for a request that did not come through one of the project's API keys.
+     * @nullable
+     */
+    api_key_id: string | null;
+    /** The portion served from the upstream prefix cache, which costs an order of magnitude less than ordinary input */
+    cache_read_tokens: number;
+    cache_write_tokens: number;
+    /** The error code on failure. Empty on success */
+    error_code: string;
+    /** @nullable */
+    finished_at: string | null;
+    /** @nullable */
+    first_token_at: string | null;
+    id: string;
+    input_tokens: number;
+    /** The model named in the request */
+    model_id: string;
+    output_tokens: number;
+    reasoning_tokens: number;
+    retries: number;
+    /**
+     * Who made the request. `api_key` means one of the project's API keys and `project_token` a project access token on the OpenAI-compatible endpoints; any other value names the Leaflow service that made it on the project's behalf, such as `assistant`, and more services may appear. Null for requests recorded before sources were tracked
+     * @maxLength 64
+     * @nullable
+     */
+    source: string | null;
+    started_at: string;
+    status: RequestResourceStatus;
+    stream: boolean;
+    /** The id of the request on the upstream side. Quote it when reporting a problem */
+    upstream_request_id: string;
+    /** The HTTP status returned upstream. 0 indicates that the request never reached it */
+    upstream_status: number;
+    /** upstream means the figures were reported by the provider; estimated means they were derived from the character classes of the payload */
+    usage_source: RequestResourceUsageSource;
+    reasoning: ReasoningDiagnostics | null;
+}
+export interface CursorPageRequestResource {
+    /** The items in this page */
+    items: RequestResource[];
+    /** The cursor for the next page. Empty on the last page */
+    next_cursor: string;
+}
+export interface APIKeyUsageResource {
+    api_key_id: string;
+    cache_read_tokens: number;
+    cache_write_tokens: number;
+    input_tokens: number;
+    output_tokens: number;
+    reasoning_tokens: number;
+    requests: number;
+}
+export interface APIKeyUsageListResponseBody {
+    items: APIKeyUsageResource[];
+}
+export interface ModelUsageResource {
+    cache_read_tokens: number;
+    cache_write_tokens: number;
+    input_tokens: number;
+    model_id: string;
+    output_tokens: number;
+    reasoning_tokens: number;
+    requests: number;
+}
+export interface ModelUsageListResponseBody {
+    items: ModelUsageResource[];
+}
+export interface TotalsResource {
+    cache_read_tokens: number;
+    cache_write_tokens: number;
+    input_tokens: number;
+    output_tokens: number;
+    reasoning_tokens: number;
+    requests: number;
+}
+export interface UsageBucketResource {
+    cache_read_tokens: number;
+    cache_write_tokens: number;
+    /** Start of the bucket, inclusive */
+    from: string;
+    input_tokens: number;
+    output_tokens: number;
+    reasoning_tokens: number;
+    requests: number;
+    /** End of the bucket, exclusive */
+    to: string;
+}
+export interface UsageTimelineResponseBody {
+    items: UsageBucketResource[];
+}
+/**
+ * `inactive` has never been enabled or its subscription has ended; `pending` awaits completion of its checkout and acceptance of its order; `active` accepts requests on the forwarding endpoints; `failed` means the enablement failed, as `failure_reason` states. An `inactive` or `failed` service can be enabled again.
+ */
+export type ServiceResourceStatus = (typeof ServiceResourceStatus)[keyof typeof ServiceResourceStatus];
+export declare const ServiceResourceStatus: {
+    readonly inactive: "inactive";
+    readonly pending: "pending";
+    readonly active: "active";
+    readonly failed: "failed";
+};
+/**
+ * Why the enablement failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired; `order_declined` means Billing did not accept the order, for example because the billing account is suspended; `order_canceled` means the order was withdrawn; `order_expired` means it was not paid in time.
+ * @nullable
+ */
+export type ServiceResourceFailureReason = (typeof ServiceResourceFailureReason)[keyof typeof ServiceResourceFailureReason] | null;
+export declare const ServiceResourceFailureReason: {
+    readonly checkout_expired: "checkout_expired";
+    readonly order_declined: "order_declined";
+    readonly order_canceled: "order_canceled";
+    readonly order_expired: "order_expired";
+};
+/**
+ * The model platform service of a project.
+ */
+export interface ServiceResource {
+    /** `inactive` has never been enabled or its subscription has ended; `pending` awaits completion of its checkout and acceptance of its order; `active` accepts requests on the forwarding endpoints; `failed` means the enablement failed, as `failure_reason` states. An `inactive` or `failed` service can be enabled again. */
+    status: ServiceResourceStatus;
+    /**
+     * Why the enablement failed; null unless `status` is `failed`. `checkout_expired` means checkout was not completed before its Checkout Session expired; `order_declined` means Billing did not accept the order, for example because the billing account is suspended; `order_canceled` means the order was withdrawn; `order_expired` means it was not paid in time.
+     * @nullable
+     */
+    failure_reason: ServiceResourceFailureReason;
+    /**
+     * The Checkout Session of the latest enablement; null before any enablement.
+     * @nullable
+     */
+    checkout_session_id: string | null;
+    /**
+     * The order that enabled the service, or that the latest enablement's checkout created; null before checkout completes.
+     * @nullable
+     */
+    order_id: string | null;
+    /**
+     * The Billing plan the service is sold under; null where the service is not sold. Price enabling it with Billing's quote, giving this plan with the `recurring` price type, the `metered` usage type and a quantity of 1; token usage is priced per model, at the rates Billing holds for each model's `billing`.
+     * @nullable
+     */
+    plan_id: string | null;
+    /**
+     * The Billing subscription that requests are billed under; null until an enablement's checkout completes.
+     * @nullable
+     */
+    subscription_id: string | null;
+    /**
+     * When the service became active and billing began; null until then.
+     * @nullable
+     */
+    activated_at: string | null;
+    /**
+     * When the subscription ended; null unless it has.
+     * @nullable
+     */
+    ended_at: string | null;
+}
+/**
+ * automatic completes checkout with the purchase: the best applicable account discount is applied, and the
+ * order is created with its invoice issued and paid from eligible credit grants and available balance.
+ * Insufficient funds fail the purchase with HTTP 422 BILLING_INSUFFICIENT_FUNDS; no Billing order, charge or
+ * discount redemption is committed.
+ * deferred creates an open Billing Checkout Session and charges nothing, even for a zero total. The customer
+ * completes it through Billing, where a promotion code can be applied, and then pays the issued invoice; a
+ * session not completed by its deadline expires.
+ */
+export type CheckoutMode = (typeof CheckoutMode)[keyof typeof CheckoutMode];
+export declare const CheckoutMode: {
+    readonly automatic: "automatic";
+    readonly deferred: "deferred";
+};
+/**
+ * A decimal string, in the currency stated alongside it.
+ *
+ * **The currency is not part of this type.** It is carried by a `currency` field next to the
+ * amount, or by the account the amount belongs to. Reading an amount without that field is
+ * reading a number with no unit.
+ *
+ * It is a string rather than a JSON number because a JSON number is a float in most parsers,
+ * and a float loses precision on the first arithmetic. Nothing on this platform puts an amount
+ * through a float.
+ */
+export type Money = string;
+/**
+ * Shared checkout choices for a product purchase. The service may set them or forward its client's
+ * choices unchanged; it does not need to read them, and Billing validates them. Omitting this object or
+ * mode selects automatic checkout. Each purchase creates its own Checkout Session. Promotion codes are supplied
+ * only to Billing. A service may retain a failed creation record when Billing refuses a purchase; no
+ * infrastructure is created for that refusal.
+ */
+export interface CheckoutOptions {
+    mode?: CheckoutMode;
+    /**
+     * Expected invoice total after discounts and tax, before applying credit grants or balance.
+     * A different total fails with BILLING_AMOUNT_CHANGED without charging or reserving a discount.
+     * Accepted only in automatic mode; with deferred it is refused with HTTP 400. For deferred
+     * checkout, give the expected amount when completing it through Billing.
+     */
+    expected_amount?: Money & string;
+    /**
+     * Where the client goes after the customer finishes a deferred checkout. Any absolute URI with a
+     * scheme, including mobile and desktop application schemes. Billing stores it without checking the
+     * target; each client validates its own.
+     * @maxLength 2048
+     */
+    return_url?: string;
+}
+export interface CreateServiceRequestBody {
+    checkout?: CheckoutOptions;
+}
+/**
+ * The service, `pending` until its order is accepted, and its Checkout Session.
+ */
+export interface CreateServiceResponseBody {
+    service: ServiceResource;
+    /** The Billing Checkout Session of this enablement. With deferred checkout, the customer completes it in Billing. */
+    checkout_session_id: string;
+    /**
+     * The order created when checkout completes, at once for automatic checkout; null until then.
+     * @nullable
+     */
+    order_id: string | null;
+}
+export type ResponseCreateReasoning = {
+    [key: string]: unknown;
+};
+export type ResponseCreateToolsItem = {
+    [key: string]: unknown;
+};
+/**
+ * Native Responses request. model may be omitted when continuing a project-owned stored response. store defaults to false. Only caller-executed function and custom tools are supported. background, conversation and WebSocket-only fields are rejected over HTTP.
+ */
+export interface ResponseCreate {
+    model?: string;
+    input?: unknown;
+    /** @nullable */
+    instructions?: string | null;
+    store?: boolean;
+    stream?: boolean;
+    /** @nullable */
+    previous_response_id?: string | null;
+    reasoning?: ResponseCreateReasoning;
+    tools?: ResponseCreateToolsItem[];
+    /** @minimum 1 */
+    max_output_tokens?: number;
+    [key: string]: unknown;
+}
+export interface ResponseResource {
+    [key: string]: unknown;
+}
+export interface ResponseDeleted {
+    id: string;
+    object: string;
+    deleted: boolean;
+}
+/**
+ * A request body in the endpoint's own protocol. Canopy reads only the model name and forwards the rest unchanged.
+ */
+export interface NativeRequest {
+    [key: string]: unknown;
+}
+/**
+ * A response body in the endpoint's own protocol, as the upstream returned it.
+ */
+export interface NativeResponse {
+    [key: string]: unknown;
+}
+/**
+ * Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.
+ */
+export interface OffsetPagination {
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+    /** @minimum 0 */
+    total_count?: number;
+}
+/**
+ * Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
+ */
+export interface CursorPagination {
+    /** @minimum 1 */
+    page_size: number;
+    /** @nullable */
+    next_cursor?: string | null;
+}
+/**
+ * The request conflicts with the current state of the service. The codes are described where they apply.
+ */
+export type ConflictResponse = Error;
+export type StreamGenerateContentParams = {
+    alt?: StreamGenerateContentAlt;
+};
+export type StreamGenerateContentAlt = (typeof StreamGenerateContentAlt)[keyof typeof StreamGenerateContentAlt];
+export declare const StreamGenerateContentAlt: {
+    readonly sse: "sse";
+};
+export type ListApiKeysParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+    /**
+     * Restricts the result to the specified status. Every status is returned while this is absent
+     */
+    status?: ListApiKeysStatus;
+};
+export type ListApiKeysStatus = (typeof ListApiKeysStatus)[keyof typeof ListApiKeysStatus];
+export declare const ListApiKeysStatus: {
+    readonly active: "active";
+    readonly disabled: "disabled";
+    readonly revoked: "revoked";
+};
+export type ListRequestsParams = {
+    /**
+     * Start of the range, inclusive. RFC 3339, carrying a timezone offset
+     */
+    from: string;
+    /**
+     * End of the range, exclusive. RFC 3339, carrying a timezone offset
+     */
+    to: string;
+    /**
+     * Restricts the result to the specified model
+     * @maxLength 128
+     */
+    model_id?: string;
+    /**
+     * Restricts the result to the specified API key
+     */
+    api_key_id?: string;
+    /**
+     * Restricts the result to the specified status
+     */
+    status?: ListRequestsStatus;
+    /**
+     * Restricts the result to requests from the specified source, as reported in a request's `source`. Requests recorded before sources were tracked have none and are excluded
+     * @minLength 1
+     * @maxLength 64
+     */
+    source?: string;
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * The next_cursor returned by the previous page. Omit it for the first page.
+     * @minLength 1
+     * @maxLength 1024
+     */
+    cursor?: string;
+};
+export type ListRequestsStatus = (typeof ListRequestsStatus)[keyof typeof ListRequestsStatus];
+export declare const ListRequestsStatus: {
+    readonly in_flight: "in_flight";
+    readonly succeeded: "succeeded";
+    readonly refused: "refused";
+    readonly upstream_failed: "upstream_failed";
+    readonly client_aborted: "client_aborted";
+};
+export type ListUsageByApiKeyParams = {
+    /**
+     * Start of the range, inclusive. RFC 3339, carrying a timezone offset
+     */
+    from: string;
+    /**
+     * End of the range, exclusive. RFC 3339, carrying a timezone offset
+     */
+    to: string;
+    /**
+     * Restricts the result to the specified model
+     * @maxLength 128
+     */
+    model_id?: string;
+    /**
+     * Restricts the result to the specified API key
+     */
+    api_key_id?: string;
+    /**
+     * Restricts the result to the specified status
+     */
+    status?: ListUsageByApiKeyStatus;
+};
+export type ListUsageByApiKeyStatus = (typeof ListUsageByApiKeyStatus)[keyof typeof ListUsageByApiKeyStatus];
+export declare const ListUsageByApiKeyStatus: {
+    readonly in_flight: "in_flight";
+    readonly succeeded: "succeeded";
+    readonly refused: "refused";
+    readonly upstream_failed: "upstream_failed";
+    readonly client_aborted: "client_aborted";
+};
+export type ListUsageByModelParams = {
+    /**
+     * Start of the range, inclusive. RFC 3339, carrying a timezone offset
+     */
+    from: string;
+    /**
+     * End of the range, exclusive. RFC 3339, carrying a timezone offset
+     */
+    to: string;
+    /**
+     * Restricts the result to the specified model
+     * @maxLength 128
+     */
+    model_id?: string;
+    /**
+     * Restricts the result to the specified API key
+     */
+    api_key_id?: string;
+    /**
+     * Restricts the result to the specified status
+     */
+    status?: ListUsageByModelStatus;
+    /**
+     * Restricts the result to requests from the specified source, as reported in a request's `source`. Requests recorded before sources were tracked have none and are excluded
+     * @minLength 1
+     * @maxLength 64
+     */
+    source?: string;
+};
+export type ListUsageByModelStatus = (typeof ListUsageByModelStatus)[keyof typeof ListUsageByModelStatus];
+export declare const ListUsageByModelStatus: {
+    readonly in_flight: "in_flight";
+    readonly succeeded: "succeeded";
+    readonly refused: "refused";
+    readonly upstream_failed: "upstream_failed";
+    readonly client_aborted: "client_aborted";
+};
+export type GetUsageSummaryParams = {
+    /**
+     * Start of the range, inclusive. RFC 3339, carrying a timezone offset
+     */
+    from: string;
+    /**
+     * End of the range, exclusive. RFC 3339, carrying a timezone offset
+     */
+    to: string;
+    /**
+     * Restricts the result to the specified model
+     * @maxLength 128
+     */
+    model_id?: string;
+    /**
+     * Restricts the result to the specified API key
+     */
+    api_key_id?: string;
+    /**
+     * Restricts the result to the specified status
+     */
+    status?: GetUsageSummaryStatus;
+    /**
+     * Restricts the result to requests from the specified source, as reported in a request's `source`. Requests recorded before sources were tracked have none and are excluded
+     * @minLength 1
+     * @maxLength 64
+     */
+    source?: string;
+};
+export type GetUsageSummaryStatus = (typeof GetUsageSummaryStatus)[keyof typeof GetUsageSummaryStatus];
+export declare const GetUsageSummaryStatus: {
+    readonly in_flight: "in_flight";
+    readonly succeeded: "succeeded";
+    readonly refused: "refused";
+    readonly upstream_failed: "upstream_failed";
+    readonly client_aborted: "client_aborted";
+};
+export type GetUsageTimelineParams = {
+    /**
+     * Start of the range, inclusive. RFC 3339, carrying a timezone offset
+     */
+    from: string;
+    /**
+     * End of the range, exclusive. RFC 3339, carrying a timezone offset
+     */
+    to: string;
+    /**
+     * Restricts the result to the specified model
+     * @maxLength 128
+     */
+    model_id?: string;
+    /**
+     * Restricts the result to the specified API key
+     */
+    api_key_id?: string;
+    /**
+     * Restricts the result to the specified status
+     */
+    status?: GetUsageTimelineStatus;
+    /**
+     * Restricts the result to requests from the specified source, as reported in a request's `source`. Requests recorded before sources were tracked have none and are excluded
+     * @minLength 1
+     * @maxLength 64
+     */
+    source?: string;
+    /**
+     * The length of each bucket, written as a duration such as 1h or 24h. The number of buckets is limited to 400
+     * @maxLength 16
+     */
+    bucket?: string;
+};
+export type GetUsageTimelineStatus = (typeof GetUsageTimelineStatus)[keyof typeof GetUsageTimelineStatus];
+export declare const GetUsageTimelineStatus: {
+    readonly in_flight: "in_flight";
+    readonly succeeded: "succeeded";
+    readonly refused: "refused";
+    readonly upstream_failed: "upstream_failed";
+    readonly client_aborted: "client_aborted";
+};