@leaflow/sdk 0.0.0-dev.42.g9fdf74a → 0.0.0-dev.425.g316080d

package/dist/canopy/v1/generated/models.js

@@ -0,0 +1,118 @@
+export const EmbeddingRequestEncodingFormat = {
+    float: "float",
+    base64: "base64",
+};
+export const Modality = {
+    text: "text",
+    image: "image",
+    audio: "audio",
+    video: "video",
+    file: "file",
+    embedding: "embedding",
+};
+export const ModelEndpoint = {
+    "/v1/chat/completions": "/v1/chat/completions",
+    "/v1/responses": "/v1/responses",
+    "/v1/embeddings": "/v1/embeddings",
+    "/v1/messages": "/v1/messages",
+    "/v1beta/models/{model}:generateContent": "/v1beta/models/{model}:generateContent",
+    "/v1/images/generations": "/v1/images/generations",
+    "/v1/images/edits": "/v1/images/edits",
+    "/v1/audio/transcriptions": "/v1/audio/transcriptions",
+    "/v1/audio/translations": "/v1/audio/translations",
+    "/v1/audio/speech": "/v1/audio/speech",
+    "/v1/realtime": "/v1/realtime",
+};
+export const APIKeyResourceStatus = {
+    active: "active",
+    disabled: "disabled",
+    revoked: "revoked",
+};
+export const IssuedAPIKeyResourceStatus = {
+    active: "active",
+    disabled: "disabled",
+    revoked: "revoked",
+};
+export const ModelResourceStatus = {
+    available: "available",
+    draining: "draining",
+    retired: "retired",
+};
+export const ModelMeterTokenKind = {
+    input: "input",
+    output: "output",
+    cache_read: "cache_read",
+    cache_write: "cache_write",
+    reasoning: "reasoning",
+};
+export const RequestResourceStatus = {
+    in_flight: "in_flight",
+    succeeded: "succeeded",
+    refused: "refused",
+    upstream_failed: "upstream_failed",
+    client_aborted: "client_aborted",
+};
+export const RequestResourceUsageSource = {
+    none: "none",
+    upstream: "upstream",
+    estimated: "estimated",
+};
+export const ServiceResourceStatus = {
+    inactive: "inactive",
+    pending: "pending",
+    active: "active",
+    failed: "failed",
+};
+export const ServiceResourceFailureReason = {
+    checkout_expired: "checkout_expired",
+    order_declined: "order_declined",
+    order_canceled: "order_canceled",
+    order_expired: "order_expired",
+};
+export const CheckoutMode = {
+    automatic: "automatic",
+    deferred: "deferred",
+};
+export const StreamGenerateContentAlt = {
+    sse: "sse",
+};
+export const ListApiKeysStatus = {
+    active: "active",
+    disabled: "disabled",
+    revoked: "revoked",
+};
+export const ListRequestsStatus = {
+    in_flight: "in_flight",
+    succeeded: "succeeded",
+    refused: "refused",
+    upstream_failed: "upstream_failed",
+    client_aborted: "client_aborted",
+};
+export const ListUsageByApiKeyStatus = {
+    in_flight: "in_flight",
+    succeeded: "succeeded",
+    refused: "refused",
+    upstream_failed: "upstream_failed",
+    client_aborted: "client_aborted",
+};
+export const ListUsageByModelStatus = {
+    in_flight: "in_flight",
+    succeeded: "succeeded",
+    refused: "refused",
+    upstream_failed: "upstream_failed",
+    client_aborted: "client_aborted",
+};
+export const GetUsageSummaryStatus = {
+    in_flight: "in_flight",
+    succeeded: "succeeded",
+    refused: "refused",
+    upstream_failed: "upstream_failed",
+    client_aborted: "client_aborted",
+};
+export const GetUsageTimelineStatus = {
+    in_flight: "in_flight",
+    succeeded: "succeeded",
+    refused: "refused",
+    upstream_failed: "upstream_failed",
+    client_aborted: "client_aborted",
+};

package/dist/canopy/v1/generated/schemas.zod.d.ts

@@ -0,0 +1,349 @@
+/**
+ * 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
+ */
+import * as zod from "zod";
+/**
+ * Supports JSON, SSE and native upstream response storage. Stored continuation is restricted to the current project and original provider credential. WebSocket clients connect with GET /v1/responses and send response.create events; one response may be active on a connection at a time. The connection stays on its initial model and provider credential.
+ * @summary Create a model response
+ */
+export declare const CreateResponseBody: zod.ZodObject<{
+    model: zod.ZodOptional<zod.ZodString>;
+    input: zod.ZodOptional<zod.ZodUnknown>;
+    instructions: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+    store: zod.ZodDefault<zod.ZodBoolean>;
+    stream: zod.ZodDefault<zod.ZodBoolean>;
+    previous_response_id: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+    reasoning: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+    tools: zod.ZodOptional<zod.ZodArray<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>>;
+    max_output_tokens: zod.ZodOptional<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get a stored response
+ */
+export declare const GetResponseParams: zod.ZodObject<{
+    response: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * @summary Delete a stored response
+ */
+export declare const DeleteResponseParams: zod.ZodObject<{
+    response: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * Authenticated project inference in the OpenAI Chat Completions protocol, forwarded unchanged to an upstream that speaks it. Billing ownership comes only from the verified project token.
+ * @summary Create a chat completion
+ */
+export declare const CreateChatCompletionBody: zod.ZodObject<{
+    model: zod.ZodString;
+    messages: zod.ZodArray<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+    stream: zod.ZodOptional<zod.ZodBoolean>;
+    max_tokens: zod.ZodOptional<zod.ZodInt>;
+    max_completion_tokens: zod.ZodOptional<zod.ZodInt>;
+    reasoning_effort: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * Authenticated project inference. Billing ownership comes only from the verified project token; no Canopy API key or project header is required.
+ * @summary Create embeddings
+ */
+export declare const CreateEmbeddingsBody: zod.ZodObject<{
+    model: zod.ZodString;
+    input: zod.ZodUnion<readonly [zod.ZodString, zod.ZodArray<zod.ZodUnknown>]>;
+    encoding_format: zod.ZodOptional<zod.ZodEnum<{
+        base64: "base64";
+        float: "float";
+    }>>;
+    dimensions: zod.ZodOptional<zod.ZodInt>;
+    user: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * Authenticated project inference in the Anthropic Messages protocol, forwarded unchanged to an upstream that speaks it. Accepts the `x-api-key` header as well as Authorization. Streams Anthropic SSE events when `stream` is true.
+ * @summary Create a message
+ */
+export declare const CreateMessageBody: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
+/**
+ * Authenticated project inference in the Gemini protocol, forwarded unchanged to an upstream that speaks it. Accepts the `x-goog-api-key` header as well as Authorization.
+ * @summary Generate content
+ */
+export declare const GenerateContentParams: zod.ZodObject<{
+    model: zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const GenerateContentBody: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
+/**
+ * The streaming form of generate-content. Use `alt=sse` for server-sent events.
+ * @summary Stream generated content
+ */
+export declare const StreamGenerateContentParams: zod.ZodObject<{
+    model: zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const StreamGenerateContentQueryParams: zod.ZodObject<{
+    alt: zod.ZodOptional<zod.ZodEnum<{
+        sse: "sse";
+    }>>;
+}, zod.z.core.$strict>;
+export declare const StreamGenerateContentBody: zod.ZodRecord<zod.ZodString, zod.ZodUnknown>;
+/**
+ * @summary Get a callable model with capabilities and parameter limits
+ */
+export declare const GetInferenceModelParams: zod.ZodObject<{
+    model: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * @summary List API keys
+ */
+export declare const listApiKeysQueryLimitDefault = 50;
+export declare const listApiKeysQueryLimitMax = 200;
+export declare const listApiKeysQueryOffsetDefault = 0;
+export declare const listApiKeysQueryOffsetMin = 0;
+export declare const listApiKeysQueryOffsetMax = 10000;
+export declare const ListApiKeysQueryParams: zod.ZodObject<{
+    limit: zod.ZodDefault<zod.ZodInt>;
+    offset: zod.ZodDefault<zod.ZodInt>;
+    status: zod.ZodOptional<zod.ZodEnum<{
+        active: "active";
+        revoked: "revoked";
+        disabled: "disabled";
+    }>>;
+}, zod.z.core.$strict>;
+/**
+ * The `secret` in the response is the complete key and **appears in this response only**. It is returned by no other endpoint, and a key that has been lost has to be revoked and reissued.
+ *
+ * Supply it wherever a value such as `OPENAI_API_KEY` is expected. The forwarding endpoints accept the OpenAI, Anthropic and Gemini request formats alike.
+ * @summary Issue an API key
+ */
+export declare const CreateApiKeyBody: zod.ZodObject<{
+    allowed_models: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodString>>>;
+    expires_at: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
+    name: zod.ZodString;
+    restrict_models: zod.ZodOptional<zod.ZodBoolean>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get an API key
+ */
+export declare const GetApiKeyParams: zod.ZodObject<{
+    keyId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Attributes only. Enabling, disabling and revoking each have their own endpoint.
+ *
+ * A field that is not supplied is left unchanged. To remove an expiry, send `clear_expiry` as true rather than a null `expires_at`.
+ *
+ * A revoked key accepts no modification.
+ * @summary Update an API key
+ */
+export declare const UpdateApiKeyParams: zod.ZodObject<{
+    keyId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const UpdateApiKeyBody: zod.ZodObject<{
+    allowed_models: zod.ZodOptional<zod.ZodNullable<zod.ZodArray<zod.ZodString>>>;
+    clear_expiry: zod.ZodOptional<zod.ZodBoolean>;
+    expires_at: zod.ZodOptional<zod.ZodNullable<zod.z.ZodISODateTime>>;
+    name: zod.ZodOptional<zod.ZodNullable<zod.ZodString>>;
+    restrict_models: zod.ZodOptional<zod.ZodNullable<zod.ZodBoolean>>;
+}, zod.z.core.$strict>;
+/**
+ * A temporary measure; the key may be enabled again at any time. Use revocation to invalidate it permanently.
+ * @summary Disable an API key
+ */
+export declare const DisableApiKeyParams: zod.ZodObject<{
+    keyId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Two cases cannot be enabled again. A revoked key answers `API_KEY_REVOKED`, and a key disabled because its project is suspended answers `API_KEY_PROJECT_SUSPENDED` with `suspended` set to true; the latter requires the project to be restored first.
+ * @summary Enable an API key
+ */
+export declare const EnableApiKeyParams: zod.ZodObject<{
+    keyId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * **Irreversible.** It is intended for a key that has been exposed, such as one committed to a repository.
+ *
+ * The record is retained, so the requests the key issued before it was revoked remain readable.
+ *
+ * Use disabling for a temporary measure.
+ * @summary Revoke an API key
+ */
+export declare const RevokeApiKeyParams: zod.ZodObject<{
+    keyId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * A model that has been retired remains readable here, while forwarding to it is refused with `MODEL_RETIRED`. That is distinct from a model that does not exist.
+ * @summary Get a model
+ */
+export declare const getModelPathModelIdMax = 128;
+export declare const GetModelParams: zod.ZodObject<{
+    modelId: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * Cursor-paged, most recent first. An empty `next_cursor` indicates the last page.
+ *
+ * **The request and response bodies are not returned**; they are not recorded. Quote the `upstream_request_id` when reporting a problem.
+ *
+ * A `usage_source` of `estimated` indicates that the upstream provider reported no usage for that request, and that the figures are derived from the character classes of the payload.
+ *
+ * Omit cursor on the first page. Stop when next_cursor is empty; do not send an empty cursor.
+ * @summary List request records
+ */
+export declare const listRequestsQueryModelIdMax = 128;
+export declare const listRequestsQuerySourceMax = 64;
+export declare const listRequestsQueryLimitDefault = 50;
+export declare const listRequestsQueryLimitMax = 200;
+export declare const listRequestsQueryCursorMax = 1024;
+export declare const ListRequestsQueryParams: zod.ZodObject<{
+    from: zod.z.ZodISODateTime;
+    to: zod.z.ZodISODateTime;
+    model_id: zod.ZodOptional<zod.ZodString>;
+    api_key_id: zod.ZodOptional<zod.ZodString>;
+    status: zod.ZodOptional<zod.ZodEnum<{
+        succeeded: "succeeded";
+        in_flight: "in_flight";
+        refused: "refused";
+        upstream_failed: "upstream_failed";
+        client_aborted: "client_aborted";
+    }>>;
+    source: zod.ZodOptional<zod.ZodString>;
+    limit: zod.ZodDefault<zod.ZodInt>;
+    cursor: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get a single request record
+ */
+export declare const GetRequestParams: zod.ZodObject<{
+    requestId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Purchases the model platform service for this project. The service itself has no charge; requests are metered under it by the tokens they use. It takes no billing choice. Returns the service as `pending` with its Checkout Session; it becomes `active` once the order is accepted, which with automatic checkout and nothing to pay happens without further action.
+ *
+ * Refused with 409 `SERVICE_ALREADY_ENABLED` while an enablement is pending or the service is active. A refusal of the order by Billing is returned with Billing's code, such as `BILLING_PRICE_UNAVAILABLE` when the service has no price in the currency of the project's billing account.
+ * @summary Enable the model platform service
+ */
+export declare const CreateServiceBody: zod.ZodObject<{
+    checkout: zod.ZodOptional<zod.ZodObject<{
+        mode: zod.ZodDefault<zod.ZodEnum<{
+            automatic: "automatic";
+            deferred: "deferred";
+        }>>;
+        expected_amount: zod.ZodOptional<zod.ZodIntersection<zod.ZodString, zod.ZodString>>;
+        return_url: zod.ZodOptional<zod.ZodURL>;
+    }, zod.z.core.$strict>>;
+}, zod.z.core.$strict>;
+/**
+ * Answers which key is consuming the budget. A key that has been revoked still appears, since the usage it accrued beforehand is part of that answer.
+ * @summary Get usage by API key
+ */
+export declare const listUsageByApiKeyQueryModelIdMax = 128;
+export declare const ListUsageByApiKeyQueryParams: zod.ZodObject<{
+    from: zod.z.ZodISODateTime;
+    to: zod.z.ZodISODateTime;
+    model_id: zod.ZodOptional<zod.ZodString>;
+    api_key_id: zod.ZodOptional<zod.ZodString>;
+    status: zod.ZodOptional<zod.ZodEnum<{
+        succeeded: "succeeded";
+        in_flight: "in_flight";
+        refused: "refused";
+        upstream_failed: "upstream_failed";
+        client_aborted: "client_aborted";
+    }>>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get usage by model
+ */
+export declare const listUsageByModelQueryModelIdMax = 128;
+export declare const listUsageByModelQuerySourceMax = 64;
+export declare const ListUsageByModelQueryParams: zod.ZodObject<{
+    from: zod.z.ZodISODateTime;
+    to: zod.z.ZodISODateTime;
+    model_id: zod.ZodOptional<zod.ZodString>;
+    api_key_id: zod.ZodOptional<zod.ZodString>;
+    status: zod.ZodOptional<zod.ZodEnum<{
+        succeeded: "succeeded";
+        in_flight: "in_flight";
+        refused: "refused";
+        upstream_failed: "upstream_failed";
+        client_aborted: "client_aborted";
+    }>>;
+    source: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * `from` and `to` are required and may span no more than 31 days. Both carry a timezone offset, so `2026-08-01T00:00:00+08:00` starts at that instant in UTC+8.
+ *
+ * The five token classes are reported separately. A cache read costs an order of magnitude less than ordinary input, and a single total cannot be decomposed again.
+ * @summary Get total usage
+ */
+export declare const getUsageSummaryQueryModelIdMax = 128;
+export declare const getUsageSummaryQuerySourceMax = 64;
+export declare const GetUsageSummaryQueryParams: zod.ZodObject<{
+    from: zod.z.ZodISODateTime;
+    to: zod.z.ZodISODateTime;
+    model_id: zod.ZodOptional<zod.ZodString>;
+    api_key_id: zod.ZodOptional<zod.ZodString>;
+    status: zod.ZodOptional<zod.ZodEnum<{
+        succeeded: "succeeded";
+        in_flight: "in_flight";
+        refused: "refused";
+        upstream_failed: "upstream_failed";
+        client_aborted: "client_aborted";
+    }>>;
+    source: zod.ZodOptional<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * Divided into buckets of `bucket`, starting at `from`. The final bucket may be partial. The range may span up to 400 days, and the number of buckets is limited to 400.
+ *
+ * To divide by local day, send `from` as midnight in local time with its offset and `bucket` as `24h`. The server does not infer a timezone.
+ * @summary Get a usage series
+ */
+export declare const getUsageTimelineQueryModelIdMax = 128;
+export declare const getUsageTimelineQuerySourceMax = 64;
+export declare const getUsageTimelineQueryBucketDefault = "1h";
+export declare const getUsageTimelineQueryBucketMax = 16;
+export declare const GetUsageTimelineQueryParams: zod.ZodObject<{
+    from: zod.z.ZodISODateTime;
+    to: zod.z.ZodISODateTime;
+    model_id: zod.ZodOptional<zod.ZodString>;
+    api_key_id: zod.ZodOptional<zod.ZodString>;
+    status: zod.ZodOptional<zod.ZodEnum<{
+        succeeded: "succeeded";
+        in_flight: "in_flight";
+        refused: "refused";
+        upstream_failed: "upstream_failed";
+        client_aborted: "client_aborted";
+    }>>;
+    source: zod.ZodOptional<zod.ZodString>;
+    bucket: zod.ZodDefault<zod.ZodString>;
+}, zod.z.core.$strict>;