@openrouter/sdk 0.11.2 → 0.12.0

package/esm/models/operations/getgeneration.d.ts

@@ -2,6 +2,7 @@ import * as z from "zod/v4";
 import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
 export type GetGenerationGlobals = {
     /**
      * The app identifier should be your app's URL and is used as the primary identifier for rankings.
@@ -43,6 +44,9 @@ export type GetGenerationRequest = {
      * @remarks
      */
     appCategories?: string | undefined;
+    /**
+     * The generation ID
+     */
     id: string;
 };
 /**
@@ -51,276 +55,169 @@ export type GetGenerationRequest = {
 export declare const ApiType: {
     readonly Completions: "completions";
     readonly Embeddings: "embeddings";
+    readonly Rerank: "rerank";
     readonly Video: "video";
 };
 /**
  * Type of API used for the generation
  */
 export type ApiType = OpenEnum<typeof ApiType>;
-export declare const ProviderName: {
-    readonly AnyScale: "AnyScale";
-    readonly Atoma: "Atoma";
-    readonly CentML: "Cent-ML";
-    readonly CrofAI: "CrofAI";
-    readonly Enfer: "Enfer";
-    readonly GoPomelo: "GoPomelo";
-    readonly HuggingFace: "HuggingFace";
-    readonly Hyperbolic2: "Hyperbolic 2";
-    readonly InoCloud: "InoCloud";
-    readonly Kluster: "Kluster";
-    readonly Lambda: "Lambda";
-    readonly Lepton: "Lepton";
-    readonly Lynn2: "Lynn 2";
-    readonly Lynn: "Lynn";
-    readonly Mancer: "Mancer";
-    readonly Meta: "Meta";
-    readonly Modal: "Modal";
-    readonly Nineteen: "Nineteen";
-    readonly OctoAI: "OctoAI";
-    readonly Recursal: "Recursal";
-    readonly Reflection: "Reflection";
-    readonly Replicate: "Replicate";
-    readonly SambaNova2: "SambaNova 2";
-    readonly SFCompute: "SF Compute";
-    readonly Targon: "Targon";
-    readonly Together2: "Together 2";
-    readonly Ubicloud: "Ubicloud";
-    readonly OneDotAI: "01.AI";
-    readonly AkashML: "AkashML";
-    readonly Ai21: "AI21";
-    readonly AionLabs: "AionLabs";
-    readonly Alibaba: "Alibaba";
-    readonly Ambient: "Ambient";
-    readonly AmazonBedrock: "Amazon Bedrock";
-    readonly AmazonNova: "Amazon Nova";
-    readonly Anthropic: "Anthropic";
-    readonly ArceeAI: "Arcee AI";
-    readonly AtlasCloud: "AtlasCloud";
-    readonly Avian: "Avian";
-    readonly Azure: "Azure";
-    readonly BaseTen: "BaseTen";
-    readonly BytePlus: "BytePlus";
-    readonly BlackForestLabs: "Black Forest Labs";
-    readonly Cerebras: "Cerebras";
-    readonly Chutes: "Chutes";
-    readonly Cirrascale: "Cirrascale";
-    readonly Clarifai: "Clarifai";
-    readonly Cloudflare: "Cloudflare";
-    readonly Cohere: "Cohere";
-    readonly Crusoe: "Crusoe";
-    readonly DeepInfra: "DeepInfra";
-    readonly DeepSeek: "DeepSeek";
-    readonly Featherless: "Featherless";
-    readonly Fireworks: "Fireworks";
-    readonly Friendli: "Friendli";
-    readonly GMICloud: "GMICloud";
-    readonly Google: "Google";
-    readonly GoogleAIStudio: "Google AI Studio";
-    readonly Groq: "Groq";
-    readonly Hyperbolic: "Hyperbolic";
-    readonly Inception: "Inception";
-    readonly Inceptron: "Inceptron";
-    readonly InferenceNet: "InferenceNet";
-    readonly Ionstream: "Ionstream";
-    readonly Infermatic: "Infermatic";
-    readonly IoNet: "Io Net";
-    readonly Inflection: "Inflection";
-    readonly Liquid: "Liquid";
-    readonly Mara: "Mara";
-    readonly Mancer2: "Mancer 2";
-    readonly Minimax: "Minimax";
-    readonly ModelRun: "ModelRun";
-    readonly Mistral: "Mistral";
-    readonly Modular: "Modular";
-    readonly MoonshotAI: "Moonshot AI";
-    readonly Morph: "Morph";
-    readonly NCompass: "NCompass";
-    readonly Nebius: "Nebius";
-    readonly NextBit: "NextBit";
-    readonly Novita: "Novita";
-    readonly Nvidia: "Nvidia";
-    readonly OpenAI: "OpenAI";
-    readonly OpenInference: "OpenInference";
-    readonly Parasail: "Parasail";
-    readonly Perplexity: "Perplexity";
-    readonly Phala: "Phala";
-    readonly Reka: "Reka";
-    readonly Relace: "Relace";
-    readonly SambaNova: "SambaNova";
-    readonly Seed: "Seed";
-    readonly SiliconFlow: "SiliconFlow";
-    readonly Sourceful: "Sourceful";
-    readonly StepFun: "StepFun";
-    readonly Stealth: "Stealth";
-    readonly StreamLake: "StreamLake";
-    readonly Switchpoint: "Switchpoint";
-    readonly Together: "Together";
-    readonly Upstage: "Upstage";
-    readonly Venice: "Venice";
-    readonly WandB: "WandB";
-    readonly Xiaomi: "Xiaomi";
-    readonly XAI: "xAI";
-    readonly ZAi: "Z.AI";
-    readonly FakeProvider: "FakeProvider";
-};
-export type ProviderName = OpenEnum<typeof ProviderName>;
-export type ProviderResponse = {
-    id?: string | undefined;
-    endpointId?: string | undefined;
-    modelPermaslug?: string | undefined;
-    providerName?: ProviderName | undefined;
-    status: number | null;
-    latency?: number | undefined;
-    isByok?: boolean | undefined;
-};
 /**
  * Generation data
  */
 export type GetGenerationData = {
     /**
-     * Unique identifier for the generation
-     */
-    id: string;
-    /**
-     * Upstream provider's identifier for this generation
+     * Type of API used for the generation
      */
-    upstreamId: string | null;
+    apiType: ApiType | null;
     /**
-     * Total cost of the generation in USD
+     * ID of the app that made the request
      */
-    totalCost: number;
+    appId: number;
     /**
      * Discount applied due to caching
      */
-    cacheDiscount: number | null;
+    cacheDiscount: number;
     /**
-     * Cost charged by the upstream provider
+     * Whether the generation was cancelled
      */
-    upstreamInferenceCost: number | null;
+    cancelled: boolean | null;
     /**
      * ISO 8601 timestamp of when the generation was created
      */
     createdAt: string;
     /**
-     * Model used for the generation
-     */
-    model: string;
-    /**
-     * ID of the app that made the request
+     * External user identifier
      */
-    appId: number | null;
+    externalUser: string | null;
     /**
-     * Whether the response was streamed
+     * Reason the generation finished
      */
-    streamed: boolean | null;
+    finishReason: string | null;
     /**
-     * Whether the generation was cancelled
+     * Time taken for generation in milliseconds
      */
-    cancelled: boolean | null;
+    generationTime: number;
     /**
-     * Name of the provider that served the request
+     * Referer header from the request
      */
-    providerName: string | null;
+    httpReferer: string | null;
     /**
-     * Total latency in milliseconds
+     * Unique identifier for the generation
      */
-    latency: number | null;
+    id: string;
     /**
-     * Moderation latency in milliseconds
+     * Whether this used bring-your-own-key
      */
-    moderationLatency: number | null;
+    isByok: boolean;
     /**
-     * Time taken for generation in milliseconds
+     * Total latency in milliseconds
      */
-    generationTime: number | null;
+    latency: number;
     /**
-     * Reason the generation finished
+     * Model used for the generation
      */
-    finishReason: string | null;
+    model: string;
     /**
-     * Number of tokens in the prompt
+     * Moderation latency in milliseconds
      */
-    tokensPrompt: number | null;
+    moderationLatency: number;
     /**
-     * Number of tokens in the completion
+     * Native finish reason as reported by provider
      */
-    tokensCompletion: number | null;
+    nativeFinishReason: string | null;
     /**
-     * Native prompt tokens as reported by provider
+     * Native cached tokens as reported by provider
      */
-    nativeTokensPrompt: number | null;
+    nativeTokensCached: number;
     /**
      * Native completion tokens as reported by provider
      */
-    nativeTokensCompletion: number | null;
+    nativeTokensCompletion: number;
     /**
      * Native completion image tokens as reported by provider
      */
-    nativeTokensCompletionImages: number | null;
+    nativeTokensCompletionImages: number;
     /**
-     * Native reasoning tokens as reported by provider
-     */
-    nativeTokensReasoning: number | null;
-    /**
-     * Native cached tokens as reported by provider
+     * Native prompt tokens as reported by provider
      */
-    nativeTokensCached: number | null;
+    nativeTokensPrompt: number;
     /**
-     * Number of media items in the prompt
+     * Native reasoning tokens as reported by provider
      */
-    numMediaPrompt: number | null;
+    nativeTokensReasoning: number;
     /**
      * Number of audio inputs in the prompt
      */
-    numInputAudioPrompt: number | null;
+    numInputAudioPrompt: number;
     /**
      * Number of media items in the completion
      */
-    numMediaCompletion: number | null;
+    numMediaCompletion: number;
+    /**
+     * Number of media items in the prompt
+     */
+    numMediaPrompt: number;
     /**
      * Number of search results included
      */
-    numSearchResults: number | null;
+    numSearchResults: number;
     /**
      * Origin URL of the request
      */
     origin: string;
     /**
-     * Usage amount in USD
+     * Name of the provider that served the request
      */
-    usage: number;
+    providerName: string | null;
     /**
-     * Whether this used bring-your-own-key
+     * List of provider responses for this generation, including fallback attempts
      */
-    isByok: boolean;
+    providerResponses: Array<models.ProviderResponse> | null;
     /**
-     * Native finish reason as reported by provider
+     * Unique identifier grouping all generations from a single API request
      */
-    nativeFinishReason: string | null;
+    requestId?: string | null | undefined;
     /**
-     * External user identifier
+     * Router used for the request (e.g., openrouter/auto)
      */
-    externalUser: string | null;
+    router: string | null;
     /**
-     * Type of API used for the generation
+     * Session identifier grouping multiple generations in the same session
      */
-    apiType: ApiType | null;
+    sessionId?: string | null | undefined;
     /**
-     * Router used for the request (e.g., openrouter/auto)
+     * Whether the response was streamed
      */
-    router: string | null;
+    streamed: boolean | null;
     /**
-     * List of provider responses for this generation, including fallback attempts
+     * Number of tokens in the completion
      */
-    providerResponses: Array<ProviderResponse> | null;
+    tokensCompletion: number;
     /**
-     * User-Agent header from the request
+     * Number of tokens in the prompt
      */
-    userAgent: string | null;
+    tokensPrompt: number;
     /**
-     * Referer header from the request
+     * Total cost of the generation in USD
      */
-    httpReferer: string | null;
+    totalCost: number;
+    /**
+     * Upstream provider's identifier for this generation
+     */
+    upstreamId: string | null;
+    /**
+     * Cost charged by the upstream provider
+     */
+    upstreamInferenceCost: number;
+    /**
+     * Usage amount in USD
+     */
+    usage: number;
+    /**
+     * User-Agent header from the request
+     */
+    userAgent: string | null;
 };
 /**
  * Generation response
@@ -344,11 +241,6 @@ export declare function getGenerationRequestToJSON(getGenerationRequest: GetGene
 /** @internal */
 export declare const ApiType$inboundSchema: z.ZodType<ApiType, unknown>;
 /** @internal */
-export declare const ProviderName$inboundSchema: z.ZodType<ProviderName, unknown>;
-/** @internal */
-export declare const ProviderResponse$inboundSchema: z.ZodType<ProviderResponse, unknown>;
-export declare function providerResponseFromJSON(jsonString: string): SafeParseResult<ProviderResponse, SDKValidationError>;
-/** @internal */
 export declare const GetGenerationData$inboundSchema: z.ZodType<GetGenerationData, unknown>;
 export declare function getGenerationDataFromJSON(jsonString: string): SafeParseResult<GetGenerationData, SDKValidationError>;
 /** @internal */

package/esm/models/operations/getgeneration.js

@@ -6,120 +6,16 @@ import * as z from "zod/v4";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import * as openEnums from "../../types/enums.js";
+import * as models from "../index.js";
 /**
  * Type of API used for the generation
  */
 export const ApiType = {
     Completions: "completions",
     Embeddings: "embeddings",
+    Rerank: "rerank",
     Video: "video",
 };
-export const ProviderName = {
-    AnyScale: "AnyScale",
-    Atoma: "Atoma",
-    CentML: "Cent-ML",
-    CrofAI: "CrofAI",
-    Enfer: "Enfer",
-    GoPomelo: "GoPomelo",
-    HuggingFace: "HuggingFace",
-    Hyperbolic2: "Hyperbolic 2",
-    InoCloud: "InoCloud",
-    Kluster: "Kluster",
-    Lambda: "Lambda",
-    Lepton: "Lepton",
-    Lynn2: "Lynn 2",
-    Lynn: "Lynn",
-    Mancer: "Mancer",
-    Meta: "Meta",
-    Modal: "Modal",
-    Nineteen: "Nineteen",
-    OctoAI: "OctoAI",
-    Recursal: "Recursal",
-    Reflection: "Reflection",
-    Replicate: "Replicate",
-    SambaNova2: "SambaNova 2",
-    SFCompute: "SF Compute",
-    Targon: "Targon",
-    Together2: "Together 2",
-    Ubicloud: "Ubicloud",
-    OneDotAI: "01.AI",
-    AkashML: "AkashML",
-    Ai21: "AI21",
-    AionLabs: "AionLabs",
-    Alibaba: "Alibaba",
-    Ambient: "Ambient",
-    AmazonBedrock: "Amazon Bedrock",
-    AmazonNova: "Amazon Nova",
-    Anthropic: "Anthropic",
-    ArceeAI: "Arcee AI",
-    AtlasCloud: "AtlasCloud",
-    Avian: "Avian",
-    Azure: "Azure",
-    BaseTen: "BaseTen",
-    BytePlus: "BytePlus",
-    BlackForestLabs: "Black Forest Labs",
-    Cerebras: "Cerebras",
-    Chutes: "Chutes",
-    Cirrascale: "Cirrascale",
-    Clarifai: "Clarifai",
-    Cloudflare: "Cloudflare",
-    Cohere: "Cohere",
-    Crusoe: "Crusoe",
-    DeepInfra: "DeepInfra",
-    DeepSeek: "DeepSeek",
-    Featherless: "Featherless",
-    Fireworks: "Fireworks",
-    Friendli: "Friendli",
-    GMICloud: "GMICloud",
-    Google: "Google",
-    GoogleAIStudio: "Google AI Studio",
-    Groq: "Groq",
-    Hyperbolic: "Hyperbolic",
-    Inception: "Inception",
-    Inceptron: "Inceptron",
-    InferenceNet: "InferenceNet",
-    Ionstream: "Ionstream",
-    Infermatic: "Infermatic",
-    IoNet: "Io Net",
-    Inflection: "Inflection",
-    Liquid: "Liquid",
-    Mara: "Mara",
-    Mancer2: "Mancer 2",
-    Minimax: "Minimax",
-    ModelRun: "ModelRun",
-    Mistral: "Mistral",
-    Modular: "Modular",
-    MoonshotAI: "Moonshot AI",
-    Morph: "Morph",
-    NCompass: "NCompass",
-    Nebius: "Nebius",
-    NextBit: "NextBit",
-    Novita: "Novita",
-    Nvidia: "Nvidia",
-    OpenAI: "OpenAI",
-    OpenInference: "OpenInference",
-    Parasail: "Parasail",
-    Perplexity: "Perplexity",
-    Phala: "Phala",
-    Reka: "Reka",
-    Relace: "Relace",
-    SambaNova: "SambaNova",
-    Seed: "Seed",
-    SiliconFlow: "SiliconFlow",
-    Sourceful: "Sourceful",
-    StepFun: "StepFun",
-    Stealth: "Stealth",
-    StreamLake: "StreamLake",
-    Switchpoint: "Switchpoint",
-    Together: "Together",
-    Upstage: "Upstage",
-    Venice: "Venice",
-    WandB: "WandB",
-    Xiaomi: "Xiaomi",
-    XAI: "xAI",
-    ZAi: "Z.AI",
-    FakeProvider: "FakeProvider",
-};
 /** @internal */
 export const GetGenerationRequest$outboundSchema = z.object({
     httpReferer: z.string().optional(),
@@ -138,95 +34,77 @@ export function getGenerationRequestToJSON(getGenerationRequest) {
 export const ApiType$inboundSchema = openEnums
     .inboundSchema(ApiType);
 /** @internal */
-export const ProviderName$inboundSchema = openEnums.inboundSchema(ProviderName);
-/** @internal */
-export const ProviderResponse$inboundSchema = z.object({
-    id: z.string().optional(),
-    endpoint_id: z.string().optional(),
-    model_permaslug: z.string().optional(),
-    provider_name: ProviderName$inboundSchema.optional(),
-    status: z.nullable(z.number()),
-    latency: z.number().optional(),
-    is_byok: z.boolean().optional(),
-}).transform((v) => {
-    return remap$(v, {
-        "endpoint_id": "endpointId",
-        "model_permaslug": "modelPermaslug",
-        "provider_name": "providerName",
-        "is_byok": "isByok",
-    });
-});
-export function providerResponseFromJSON(jsonString) {
-    return safeParse(jsonString, (x) => ProviderResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ProviderResponse' from JSON`);
-}
-/** @internal */
 export const GetGenerationData$inboundSchema = z.object({
-    id: z.string(),
-    upstream_id: z.nullable(z.string()),
-    total_cost: z.number(),
-    cache_discount: z.nullable(z.number()),
-    upstream_inference_cost: z.nullable(z.number()),
-    created_at: z.string(),
-    model: z.string(),
-    app_id: z.nullable(z.number()),
-    streamed: z.nullable(z.boolean()),
+    api_type: z.nullable(ApiType$inboundSchema),
+    app_id: z.int(),
+    cache_discount: z.number(),
     cancelled: z.nullable(z.boolean()),
-    provider_name: z.nullable(z.string()),
-    latency: z.nullable(z.number()),
-    moderation_latency: z.nullable(z.number()),
-    generation_time: z.nullable(z.number()),
+    created_at: z.string(),
+    external_user: z.nullable(z.string()),
     finish_reason: z.nullable(z.string()),
-    tokens_prompt: z.nullable(z.number()),
-    tokens_completion: z.nullable(z.number()),
-    native_tokens_prompt: z.nullable(z.number()),
-    native_tokens_completion: z.nullable(z.number()),
-    native_tokens_completion_images: z.nullable(z.number()),
-    native_tokens_reasoning: z.nullable(z.number()),
-    native_tokens_cached: z.nullable(z.number()),
-    num_media_prompt: z.nullable(z.number()),
-    num_input_audio_prompt: z.nullable(z.number()),
-    num_media_completion: z.nullable(z.number()),
-    num_search_results: z.nullable(z.number()),
-    origin: z.string(),
-    usage: z.number(),
+    generation_time: z.number(),
+    http_referer: z.nullable(z.string()),
+    id: z.string(),
     is_byok: z.boolean(),
+    latency: z.number(),
+    model: z.string(),
+    moderation_latency: z.number(),
     native_finish_reason: z.nullable(z.string()),
-    external_user: z.nullable(z.string()),
-    api_type: z.nullable(ApiType$inboundSchema),
+    native_tokens_cached: z.int(),
+    native_tokens_completion: z.int(),
+    native_tokens_completion_images: z.int(),
+    native_tokens_prompt: z.int(),
+    native_tokens_reasoning: z.int(),
+    num_input_audio_prompt: z.int(),
+    num_media_completion: z.int(),
+    num_media_prompt: z.int(),
+    num_search_results: z.int(),
+    origin: z.string(),
+    provider_name: z.nullable(z.string()),
+    provider_responses: z.nullable(z.array(models.ProviderResponse$inboundSchema)),
+    request_id: z.nullable(z.string()).optional(),
     router: z.nullable(z.string()),
-    provider_responses: z.nullable(z.array(z.lazy(() => ProviderResponse$inboundSchema))),
+    session_id: z.nullable(z.string()).optional(),
+    streamed: z.nullable(z.boolean()),
+    tokens_completion: z.int(),
+    tokens_prompt: z.int(),
+    total_cost: z.number(),
+    upstream_id: z.nullable(z.string()),
+    upstream_inference_cost: z.number(),
+    usage: z.number(),
     user_agent: z.nullable(z.string()),
-    http_referer: z.nullable(z.string()),
 }).transform((v) => {
     return remap$(v, {
-        "upstream_id": "upstreamId",
-        "total_cost": "totalCost",
+        "api_type": "apiType",
+        "app_id": "appId",
         "cache_discount": "cacheDiscount",
-        "upstream_inference_cost": "upstreamInferenceCost",
         "created_at": "createdAt",
-        "app_id": "appId",
-        "provider_name": "providerName",
-        "moderation_latency": "moderationLatency",
-        "generation_time": "generationTime",
+        "external_user": "externalUser",
         "finish_reason": "finishReason",
-        "tokens_prompt": "tokensPrompt",
-        "tokens_completion": "tokensCompletion",
-        "native_tokens_prompt": "nativeTokensPrompt",
+        "generation_time": "generationTime",
+        "http_referer": "httpReferer",
+        "is_byok": "isByok",
+        "moderation_latency": "moderationLatency",
+        "native_finish_reason": "nativeFinishReason",
+        "native_tokens_cached": "nativeTokensCached",
         "native_tokens_completion": "nativeTokensCompletion",
         "native_tokens_completion_images": "nativeTokensCompletionImages",
+        "native_tokens_prompt": "nativeTokensPrompt",
         "native_tokens_reasoning": "nativeTokensReasoning",
-        "native_tokens_cached": "nativeTokensCached",
-        "num_media_prompt": "numMediaPrompt",
         "num_input_audio_prompt": "numInputAudioPrompt",
         "num_media_completion": "numMediaCompletion",
+        "num_media_prompt": "numMediaPrompt",
         "num_search_results": "numSearchResults",
-        "is_byok": "isByok",
-        "native_finish_reason": "nativeFinishReason",
-        "external_user": "externalUser",
-        "api_type": "apiType",
+        "provider_name": "providerName",
         "provider_responses": "providerResponses",
+        "request_id": "requestId",
+        "session_id": "sessionId",
+        "tokens_completion": "tokensCompletion",
+        "tokens_prompt": "tokensPrompt",
+        "total_cost": "totalCost",
+        "upstream_id": "upstreamId",
+        "upstream_inference_cost": "upstreamInferenceCost",
         "user_agent": "userAgent",
-        "http_referer": "httpReferer",
     });
 });
 export function getGenerationDataFromJSON(jsonString) {