@openrouter/sdk 0.5.1 → 0.8.0

package/esm/models/operations/sendchatcompletionrequest.js

@@ -4,9 +4,25 @@
  */
 import * as z from "zod/v4";
 import { EventStream } from "../../lib/event-streams.js";
+import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import * as models from "../index.js";
 /** @internal */
+export const SendChatCompletionRequestRequest$outboundSchema = z.object({
+    httpReferer: z.string().optional(),
+    xTitle: z.string().optional(),
+    chatGenerationParams: models.ChatGenerationParams$outboundSchema,
+}).transform((v) => {
+    return remap$(v, {
+        httpReferer: "HTTP-Referer",
+        xTitle: "X-Title",
+        chatGenerationParams: "ChatGenerationParams",
+    });
+});
+export function sendChatCompletionRequestRequestToJSON(sendChatCompletionRequestRequest) {
+    return JSON.stringify(SendChatCompletionRequestRequest$outboundSchema.parse(sendChatCompletionRequestRequest));
+}
+/** @internal */
 export const SendChatCompletionRequestResponse$inboundSchema = z.union([
     models.ChatResponse$inboundSchema,
     z.custom(x => x instanceof ReadableStream)

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

@@ -2,6 +2,21 @@ 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";
+export type UpdateGuardrailGlobals = {
+    /**
+     * The app identifier should be your app's URL and is used as the primary identifier for rankings.
+     *
+     * @remarks
+     * This is used to track API usage per application.
+     */
+    httpReferer?: string | undefined;
+    /**
+     * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+     *
+     * @remarks
+     */
+    xTitle?: string | undefined;
+};
 /**
  * Interval at which the limit resets (daily, weekly, monthly)
  */
@@ -45,6 +60,19 @@ export type UpdateGuardrailRequestBody = {
     enforceZdr?: boolean | null | undefined;
 };
 export type UpdateGuardrailRequest = {
+    /**
+     * The app identifier should be your app's URL and is used as the primary identifier for rankings.
+     *
+     * @remarks
+     * This is used to track API usage per application.
+     */
+    httpReferer?: string | undefined;
+    /**
+     * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+     *
+     * @remarks
+     */
+    xTitle?: string | undefined;
     /**
      * The unique identifier of the guardrail to update
      */
@@ -134,6 +162,8 @@ export declare const UpdateGuardrailRequestBody$outboundSchema: z.ZodType<Update
 export declare function updateGuardrailRequestBodyToJSON(updateGuardrailRequestBody: UpdateGuardrailRequestBody): string;
 /** @internal */
 export type UpdateGuardrailRequest$Outbound = {
+    "HTTP-Referer"?: string | undefined;
+    "X-Title"?: string | undefined;
     id: string;
     RequestBody: UpdateGuardrailRequestBody$Outbound;
 };

package/esm/models/operations/updateguardrail.js

@@ -48,10 +48,14 @@ export function updateGuardrailRequestBodyToJSON(updateGuardrailRequestBody) {
 }
 /** @internal */
 export const UpdateGuardrailRequest$outboundSchema = z.object({
+    httpReferer: z.string().optional(),
+    xTitle: z.string().optional(),
     id: z.string(),
     requestBody: z.lazy(() => UpdateGuardrailRequestBody$outboundSchema),
 }).transform((v) => {
     return remap$(v, {
+        httpReferer: "HTTP-Referer",
+        xTitle: "X-Title",
         requestBody: "RequestBody",
     });
 });

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

@@ -2,6 +2,21 @@ 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";
+export type UpdateKeysGlobals = {
+    /**
+     * The app identifier should be your app's URL and is used as the primary identifier for rankings.
+     *
+     * @remarks
+     * This is used to track API usage per application.
+     */
+    httpReferer?: string | undefined;
+    /**
+     * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+     *
+     * @remarks
+     */
+    xTitle?: string | undefined;
+};
 /**
  * New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.
  */
@@ -37,6 +52,19 @@ export type UpdateKeysRequestBody = {
     includeByokInLimit?: boolean | undefined;
 };
 export type UpdateKeysRequest = {
+    /**
+     * The app identifier should be your app's URL and is used as the primary identifier for rankings.
+     *
+     * @remarks
+     * This is used to track API usage per application.
+     */
+    httpReferer?: string | undefined;
+    /**
+     * The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+     *
+     * @remarks
+     */
+    xTitle?: string | undefined;
     /**
      * The hash identifier of the API key to update
      */
@@ -148,6 +176,8 @@ export declare const UpdateKeysRequestBody$outboundSchema: z.ZodType<UpdateKeysR
 export declare function updateKeysRequestBodyToJSON(updateKeysRequestBody: UpdateKeysRequestBody): string;
 /** @internal */
 export type UpdateKeysRequest$Outbound = {
+    "HTTP-Referer"?: string | undefined;
+    "X-Title"?: string | undefined;
     hash: string;
     RequestBody: UpdateKeysRequestBody$Outbound;
 };

package/esm/models/operations/updatekeys.js

@@ -34,10 +34,14 @@ export function updateKeysRequestBodyToJSON(updateKeysRequestBody) {
 }
 /** @internal */
 export const UpdateKeysRequest$outboundSchema = z.object({
+    httpReferer: z.string().optional(),
+    xTitle: z.string().optional(),
     hash: z.string(),
     requestBody: z.lazy(() => UpdateKeysRequestBody$outboundSchema),
 }).transform((v) => {
     return remap$(v, {
+        httpReferer: "HTTP-Referer",
+        xTitle: "X-Title",
         requestBody: "RequestBody",
     });
 });

package/esm/models/providername.d.ts

@@ -4,6 +4,7 @@ export declare const ProviderName: {
     readonly Ai21: "AI21";
     readonly AionLabs: "AionLabs";
     readonly Alibaba: "Alibaba";
+    readonly Ambient: "Ambient";
     readonly AmazonBedrock: "Amazon Bedrock";
     readonly AmazonNova: "Amazon Nova";
     readonly Anthropic: "Anthropic";
@@ -60,6 +61,7 @@ export declare const ProviderName: {
     readonly Seed: "Seed";
     readonly SiliconFlow: "SiliconFlow";
     readonly Sourceful: "Sourceful";
+    readonly StepFun: "StepFun";
     readonly Stealth: "Stealth";
     readonly StreamLake: "StreamLake";
     readonly Switchpoint: "Switchpoint";

package/esm/models/providername.js

@@ -7,6 +7,7 @@ export const ProviderName = {
     Ai21: "AI21",
     AionLabs: "AionLabs",
     Alibaba: "Alibaba",
+    Ambient: "Ambient",
     AmazonBedrock: "Amazon Bedrock",
     AmazonNova: "Amazon Nova",
     Anthropic: "Anthropic",
@@ -63,6 +64,7 @@ export const ProviderName = {
     Seed: "Seed",
     SiliconFlow: "SiliconFlow",
     Sourceful: "Sourceful",
+    StepFun: "StepFun",
     Stealth: "Stealth",
     StreamLake: "StreamLake",
     Switchpoint: "Switchpoint",

package/esm/models/providerpreferences.d.ts

@@ -46,24 +46,12 @@ export type ProviderPreferencesSortUnion = ProviderPreferencesProviderSort | Pro
  */
 export type ProviderPreferencesMaxPrice = {
     /**
-     * A value in string format that is a large number
+     * Price per million prompt tokens
      */
     prompt?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     completion?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     image?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     audio?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     request?: string | undefined;
 };
 /**

package/esm/models/publicendpoint.d.ts

@@ -7,57 +7,18 @@ import { Parameter } from "./parameter.js";
 import { PercentileStats } from "./percentilestats.js";
 import { ProviderName } from "./providername.js";
 export type Pricing = {
-    /**
-     * A value in string format that is a large number
-     */
     prompt: string;
-    /**
-     * A value in string format that is a large number
-     */
     completion: string;
-    /**
-     * A value in string format that is a large number
-     */
     request?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     image?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     imageToken?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     imageOutput?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     audio?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     audioOutput?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     inputAudioCache?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     webSearch?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     internalReasoning?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     inputCacheRead?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     inputCacheWrite?: string | undefined;
     discount?: number | undefined;
 };

package/esm/models/publicpricing.d.ts

@@ -5,57 +5,18 @@ import { SDKValidationError } from "./errors/sdkvalidationerror.js";
  * Pricing information for the model
  */
 export type PublicPricing = {
-    /**
-     * A value in string format that is a large number
-     */
     prompt: string;
-    /**
-     * A value in string format that is a large number
-     */
     completion: string;
-    /**
-     * A value in string format that is a large number
-     */
     request?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     image?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     imageToken?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     imageOutput?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     audio?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     audioOutput?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     inputAudioCache?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     webSearch?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     internalReasoning?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     inputCacheRead?: string | undefined;
-    /**
-     * A value in string format that is a large number
-     */
     inputCacheWrite?: string | undefined;
     discount?: number | undefined;
 };

package/esm/models/schema10.d.ts

@@ -0,0 +1,33 @@
+import * as z from "zod/v4";
+import { Schema14, Schema14$Outbound } from "./schema14.js";
+export type Prompt = number | string | any;
+export type Completion = number | string | any;
+export type Schema10 = {
+    prompt?: number | string | any | undefined;
+    completion?: number | string | any | undefined;
+    image?: Schema14 | undefined;
+    audio?: Schema14 | undefined;
+    request?: Schema14 | undefined;
+};
+/** @internal */
+export type Prompt$Outbound = number | string | any;
+/** @internal */
+export declare const Prompt$outboundSchema: z.ZodType<Prompt$Outbound, Prompt>;
+export declare function promptToJSON(prompt: Prompt): string;
+/** @internal */
+export type Completion$Outbound = number | string | any;
+/** @internal */
+export declare const Completion$outboundSchema: z.ZodType<Completion$Outbound, Completion>;
+export declare function completionToJSON(completion: Completion): string;
+/** @internal */
+export type Schema10$Outbound = {
+    prompt?: number | string | any | undefined;
+    completion?: number | string | any | undefined;
+    image?: Schema14$Outbound | undefined;
+    audio?: Schema14$Outbound | undefined;
+    request?: Schema14$Outbound | undefined;
+};
+/** @internal */
+export declare const Schema10$outboundSchema: z.ZodType<Schema10$Outbound, Schema10>;
+export declare function schema10ToJSON(schema10: Schema10): string;
+//# sourceMappingURL=schema10.d.ts.map

package/esm/models/schema10.js

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3a361cbac0f8
+ */
+import * as z from "zod/v4";
+import { Schema14$outboundSchema, } from "./schema14.js";
+/** @internal */
+export const Prompt$outboundSchema = z
+    .union([z.number(), z.string(), z.any()]);
+export function promptToJSON(prompt) {
+    return JSON.stringify(Prompt$outboundSchema.parse(prompt));
+}
+/** @internal */
+export const Completion$outboundSchema = z.union([z.number(), z.string(), z.any()]);
+export function completionToJSON(completion) {
+    return JSON.stringify(Completion$outboundSchema.parse(completion));
+}
+/** @internal */
+export const Schema10$outboundSchema = z
+    .object({
+    prompt: z.union([z.number(), z.string(), z.any()]).optional(),
+    completion: z.union([z.number(), z.string(), z.any()]).optional(),
+    image: Schema14$outboundSchema.optional(),
+    audio: Schema14$outboundSchema.optional(),
+    request: Schema14$outboundSchema.optional(),
+});
+export function schema10ToJSON(schema10) {
+    return JSON.stringify(Schema10$outboundSchema.parse(schema10));
+}
+//# sourceMappingURL=schema10.js.map

package/esm/models/schema14.d.ts

@@ -0,0 +1,8 @@
+import * as z from "zod/v4";
+export type Schema14 = number | string | any;
+/** @internal */
+export type Schema14$Outbound = number | string | any;
+/** @internal */
+export declare const Schema14$outboundSchema: z.ZodType<Schema14$Outbound, Schema14>;
+export declare function schema14ToJSON(schema14: Schema14): string;
+//# sourceMappingURL=schema14.d.ts.map

package/esm/models/schema14.js

@@ -0,0 +1,12 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 197e0ddbcace
+ */
+import * as z from "zod/v4";
+/** @internal */
+export const Schema14$outboundSchema = z
+    .union([z.number(), z.string(), z.any()]);
+export function schema14ToJSON(schema14) {
+    return JSON.stringify(Schema14$outboundSchema.parse(schema14));
+}
+//# sourceMappingURL=schema14.js.map

package/esm/models/schema17.d.ts

@@ -0,0 +1,102 @@
+import * as z from "zod/v4";
+import { OpenEnum } from "../types/enums.js";
+export type Schema17ResponseHealing = {
+    id: "response-healing";
+    enabled?: boolean | undefined;
+};
+export declare const PdfEngine: {
+    readonly MistralOcr: "mistral-ocr";
+    readonly PdfText: "pdf-text";
+    readonly Native: "native";
+};
+export type PdfEngine = OpenEnum<typeof PdfEngine>;
+export type Pdf = {
+    engine?: PdfEngine | undefined;
+};
+export type Schema17FileParser = {
+    id: "file-parser";
+    enabled?: boolean | undefined;
+    pdf?: Pdf | undefined;
+};
+export declare const Engine: {
+    readonly Native: "native";
+    readonly Exa: "exa";
+};
+export type Engine = OpenEnum<typeof Engine>;
+export type Schema17Web = {
+    id: "web";
+    enabled?: boolean | undefined;
+    maxResults?: number | undefined;
+    searchPrompt?: string | undefined;
+    engine?: Engine | undefined;
+};
+export type Schema17Moderation = {
+    id: "moderation";
+};
+export type Schema17AutoRouter = {
+    id: "auto-router";
+    enabled?: boolean | undefined;
+    allowedModels?: Array<string> | undefined;
+};
+export type Schema17 = Schema17AutoRouter | Schema17Moderation | Schema17Web | Schema17FileParser | Schema17ResponseHealing;
+/** @internal */
+export type Schema17ResponseHealing$Outbound = {
+    id: "response-healing";
+    enabled?: boolean | undefined;
+};
+/** @internal */
+export declare const Schema17ResponseHealing$outboundSchema: z.ZodType<Schema17ResponseHealing$Outbound, Schema17ResponseHealing>;
+export declare function schema17ResponseHealingToJSON(schema17ResponseHealing: Schema17ResponseHealing): string;
+/** @internal */
+export declare const PdfEngine$outboundSchema: z.ZodType<string, PdfEngine>;
+/** @internal */
+export type Pdf$Outbound = {
+    engine?: string | undefined;
+};
+/** @internal */
+export declare const Pdf$outboundSchema: z.ZodType<Pdf$Outbound, Pdf>;
+export declare function pdfToJSON(pdf: Pdf): string;
+/** @internal */
+export type Schema17FileParser$Outbound = {
+    id: "file-parser";
+    enabled?: boolean | undefined;
+    pdf?: Pdf$Outbound | undefined;
+};
+/** @internal */
+export declare const Schema17FileParser$outboundSchema: z.ZodType<Schema17FileParser$Outbound, Schema17FileParser>;
+export declare function schema17FileParserToJSON(schema17FileParser: Schema17FileParser): string;
+/** @internal */
+export declare const Engine$outboundSchema: z.ZodType<string, Engine>;
+/** @internal */
+export type Schema17Web$Outbound = {
+    id: "web";
+    enabled?: boolean | undefined;
+    max_results?: number | undefined;
+    search_prompt?: string | undefined;
+    engine?: string | undefined;
+};
+/** @internal */
+export declare const Schema17Web$outboundSchema: z.ZodType<Schema17Web$Outbound, Schema17Web>;
+export declare function schema17WebToJSON(schema17Web: Schema17Web): string;
+/** @internal */
+export type Schema17Moderation$Outbound = {
+    id: "moderation";
+};
+/** @internal */
+export declare const Schema17Moderation$outboundSchema: z.ZodType<Schema17Moderation$Outbound, Schema17Moderation>;
+export declare function schema17ModerationToJSON(schema17Moderation: Schema17Moderation): string;
+/** @internal */
+export type Schema17AutoRouter$Outbound = {
+    id: "auto-router";
+    enabled?: boolean | undefined;
+    allowed_models?: Array<string> | undefined;
+};
+/** @internal */
+export declare const Schema17AutoRouter$outboundSchema: z.ZodType<Schema17AutoRouter$Outbound, Schema17AutoRouter>;
+export declare function schema17AutoRouterToJSON(schema17AutoRouter: Schema17AutoRouter): string;
+/** @internal */
+export type Schema17$Outbound = Schema17AutoRouter$Outbound | Schema17Moderation$Outbound | Schema17Web$Outbound | Schema17FileParser$Outbound | Schema17ResponseHealing$Outbound;
+/** @internal */
+export declare const Schema17$outboundSchema: z.ZodType<Schema17$Outbound, Schema17>;
+export declare function schema17ToJSON(schema17: Schema17): string;
+//# sourceMappingURL=schema17.d.ts.map

package/esm/models/schema17.js

@@ -0,0 +1,95 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f882e1dc50da
+ */
+import * as z from "zod/v4";
+import { remap as remap$ } from "../lib/primitives.js";
+import * as openEnums from "../types/enums.js";
+export const PdfEngine = {
+    MistralOcr: "mistral-ocr",
+    PdfText: "pdf-text",
+    Native: "native",
+};
+export const Engine = {
+    Native: "native",
+    Exa: "exa",
+};
+/** @internal */
+export const Schema17ResponseHealing$outboundSchema = z.object({
+    id: z.literal("response-healing"),
+    enabled: z.boolean().optional(),
+});
+export function schema17ResponseHealingToJSON(schema17ResponseHealing) {
+    return JSON.stringify(Schema17ResponseHealing$outboundSchema.parse(schema17ResponseHealing));
+}
+/** @internal */
+export const PdfEngine$outboundSchema = openEnums
+    .outboundSchema(PdfEngine);
+/** @internal */
+export const Pdf$outboundSchema = z.object({
+    engine: PdfEngine$outboundSchema.optional(),
+});
+export function pdfToJSON(pdf) {
+    return JSON.stringify(Pdf$outboundSchema.parse(pdf));
+}
+/** @internal */
+export const Schema17FileParser$outboundSchema = z.object({
+    id: z.literal("file-parser"),
+    enabled: z.boolean().optional(),
+    pdf: z.lazy(() => Pdf$outboundSchema).optional(),
+});
+export function schema17FileParserToJSON(schema17FileParser) {
+    return JSON.stringify(Schema17FileParser$outboundSchema.parse(schema17FileParser));
+}
+/** @internal */
+export const Engine$outboundSchema = openEnums
+    .outboundSchema(Engine);
+/** @internal */
+export const Schema17Web$outboundSchema = z.object({
+    id: z.literal("web"),
+    enabled: z.boolean().optional(),
+    maxResults: z.number().optional(),
+    searchPrompt: z.string().optional(),
+    engine: Engine$outboundSchema.optional(),
+}).transform((v) => {
+    return remap$(v, {
+        maxResults: "max_results",
+        searchPrompt: "search_prompt",
+    });
+});
+export function schema17WebToJSON(schema17Web) {
+    return JSON.stringify(Schema17Web$outboundSchema.parse(schema17Web));
+}
+/** @internal */
+export const Schema17Moderation$outboundSchema = z.object({
+    id: z.literal("moderation"),
+});
+export function schema17ModerationToJSON(schema17Moderation) {
+    return JSON.stringify(Schema17Moderation$outboundSchema.parse(schema17Moderation));
+}
+/** @internal */
+export const Schema17AutoRouter$outboundSchema = z.object({
+    id: z.literal("auto-router"),
+    enabled: z.boolean().optional(),
+    allowedModels: z.array(z.string()).optional(),
+}).transform((v) => {
+    return remap$(v, {
+        allowedModels: "allowed_models",
+    });
+});
+export function schema17AutoRouterToJSON(schema17AutoRouter) {
+    return JSON.stringify(Schema17AutoRouter$outboundSchema.parse(schema17AutoRouter));
+}
+/** @internal */
+export const Schema17$outboundSchema = z
+    .union([
+    z.lazy(() => Schema17AutoRouter$outboundSchema),
+    z.lazy(() => Schema17Moderation$outboundSchema),
+    z.lazy(() => Schema17Web$outboundSchema),
+    z.lazy(() => Schema17FileParser$outboundSchema),
+    z.lazy(() => Schema17ResponseHealing$outboundSchema),
+]);
+export function schema17ToJSON(schema17) {
+    return JSON.stringify(Schema17$outboundSchema.parse(schema17));
+}
+//# sourceMappingURL=schema17.js.map