@openrouter/sdk 0.12.79 → 0.13.13

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

@@ -23,14 +23,31 @@ export type CreateRerankGlobals = {
      */
     appCategories?: string | undefined;
 };
+/**
+ * A structured document with optional text and/or image content. At least one of `text` or `image` must be provided.
+ */
+export type DocumentRequest = {
+    /**
+     * An image associated with the document, as a remote URL (http/https) or a base64-encoded data URI (data:image/...).
+     */
+    image?: string | undefined;
+    /**
+     * The document text
+     */
+    text?: string | undefined;
+};
+/**
+ * A document to rerank. Either a plain string, or a structured object with optional `text` and/or `image`.
+ */
+export type Document = string | DocumentRequest;
 /**
  * Rerank request input
  */
 export type CreateRerankRequestBody = {
     /**
-     * The list of documents to rerank
+     * The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models.
      */
-    documents: Array<string>;
+    documents: Array<string | DocumentRequest>;
     /**
      * The rerank model to use
      */
@@ -68,22 +85,26 @@ export type CreateRerankRequest = {
     requestBody: CreateRerankRequestBody;
 };
 /**
- * The document object containing the original text
+ * The document object echoing the original input (text and/or image)
  */
-export type Document = {
+export type DocumentResponse = {
+    /**
+     * The image (URL or data URI) from the original document
+     */
+    image?: string | undefined;
     /**
      * The document text
      */
-    text: string;
+    text?: string | undefined;
 };
 /**
  * A single rerank result
  */
 export type Result = {
     /**
-     * The document object containing the original text
+     * The document object echoing the original input (text and/or image)
      */
-    document: Document;
+    document: DocumentResponse;
     /**
      * Index of the document in the original input list
      */
@@ -137,8 +158,21 @@ export type CreateRerankResponseBody = {
 };
 export type CreateRerankResponse = CreateRerankResponseBody | string;
 /** @internal */
+export type DocumentRequest$Outbound = {
+    image?: string | undefined;
+    text?: string | undefined;
+};
+/** @internal */
+export declare const DocumentRequest$outboundSchema: z.ZodType<DocumentRequest$Outbound, DocumentRequest>;
+export declare function documentRequestToJSON(documentRequest: DocumentRequest): string;
+/** @internal */
+export type Document$Outbound = string | DocumentRequest$Outbound;
+/** @internal */
+export declare const Document$outboundSchema: z.ZodType<Document$Outbound, Document>;
+export declare function documentToJSON(document: Document): string;
+/** @internal */
 export type CreateRerankRequestBody$Outbound = {
-    documents: Array<string>;
+    documents: Array<string | DocumentRequest$Outbound>;
     model: string;
     provider?: models.ProviderPreferences$Outbound | null | undefined;
     query: string;
@@ -158,8 +192,8 @@ export type CreateRerankRequest$Outbound = {
 export declare const CreateRerankRequest$outboundSchema: z.ZodType<CreateRerankRequest$Outbound, CreateRerankRequest>;
 export declare function createRerankRequestToJSON(createRerankRequest: CreateRerankRequest): string;
 /** @internal */
-export declare const Document$inboundSchema: z.ZodType<Document, unknown>;
-export declare function documentFromJSON(jsonString: string): SafeParseResult<Document, SDKValidationError>;
+export declare const DocumentResponse$inboundSchema: z.ZodType<DocumentResponse, unknown>;
+export declare function documentResponseFromJSON(jsonString: string): SafeParseResult<DocumentResponse, SDKValidationError>;
 /** @internal */
 export declare const Result$inboundSchema: z.ZodType<Result, unknown>;
 export declare function resultFromJSON(jsonString: string): SafeParseResult<Result, SDKValidationError>;

package/esm/models/operations/creatererank.js

@@ -7,8 +7,22 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import * as models from "../index.js";
 /** @internal */
+export const DocumentRequest$outboundSchema = z.object({
+    image: z.string().optional(),
+    text: z.string().optional(),
+});
+export function documentRequestToJSON(documentRequest) {
+    return JSON.stringify(DocumentRequest$outboundSchema.parse(documentRequest));
+}
+/** @internal */
+export const Document$outboundSchema = z
+    .union([z.string(), z.lazy(() => DocumentRequest$outboundSchema)]);
+export function documentToJSON(document) {
+    return JSON.stringify(Document$outboundSchema.parse(document));
+}
+/** @internal */
 export const CreateRerankRequestBody$outboundSchema = z.object({
-    documents: z.array(z.string()),
+    documents: z.array(z.union([z.string(), z.lazy(() => DocumentRequest$outboundSchema)])),
     model: z.string(),
     provider: z.nullable(models.ProviderPreferences$outboundSchema).optional(),
     query: z.string(),
@@ -37,15 +51,16 @@ export function createRerankRequestToJSON(createRerankRequest) {
     return JSON.stringify(CreateRerankRequest$outboundSchema.parse(createRerankRequest));
 }
 /** @internal */
-export const Document$inboundSchema = z.object({
-    text: z.string(),
+export const DocumentResponse$inboundSchema = z.object({
+    image: z.string().optional(),
+    text: z.string().optional(),
 });
-export function documentFromJSON(jsonString) {
-    return safeParse(jsonString, (x) => Document$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Document' from JSON`);
+export function documentResponseFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => DocumentResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'DocumentResponse' from JSON`);
 }
 /** @internal */
 export const Result$inboundSchema = z.object({
-    document: z.lazy(() => Document$inboundSchema),
+    document: z.lazy(() => DocumentResponse$inboundSchema),
     index: z.int(),
     relevance_score: z.number(),
 }).transform((v) => {

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

@@ -45,9 +45,9 @@ export type CreateResponsesRequest = {
      */
     appCategories?: string | undefined;
     /**
-     * Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`.
+     * Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility.
      */
-    xOpenRouterExperimentalMetadata?: models.MetadataLevel | undefined;
+    xOpenRouterMetadata?: models.MetadataLevel | undefined;
     responsesRequest: models.ResponsesRequest;
 };
 export type CreateResponsesResponse = models.OpenResponsesResult | EventStream<models.StreamEvents>;
@@ -56,7 +56,7 @@ export type CreateResponsesRequest$Outbound = {
     "HTTP-Referer"?: string | undefined;
     appTitle?: string | undefined;
     appCategories?: string | undefined;
-    "X-OpenRouter-Experimental-Metadata"?: string | undefined;
+    "X-OpenRouter-Metadata"?: string | undefined;
     ResponsesRequest: models.ResponsesRequest$Outbound;
 };
 /** @internal */

package/esm/models/operations/createresponses.js

@@ -12,13 +12,12 @@ export const CreateResponsesRequest$outboundSchema = z.object({
     httpReferer: z.string().optional(),
     appTitle: z.string().optional(),
     appCategories: z.string().optional(),
-    xOpenRouterExperimentalMetadata: models.MetadataLevel$outboundSchema
-        .optional(),
+    xOpenRouterMetadata: models.MetadataLevel$outboundSchema.optional(),
     responsesRequest: models.ResponsesRequest$outboundSchema,
 }).transform((v) => {
     return remap$(v, {
         httpReferer: "HTTP-Referer",
-        xOpenRouterExperimentalMetadata: "X-OpenRouter-Experimental-Metadata",
+        xOpenRouterMetadata: "X-OpenRouter-Metadata",
         responsesRequest: "ResponsesRequest",
     });
 });

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

@@ -0,0 +1,60 @@
+import * as z from "zod/v4";
+export type DeleteFileGlobals = {
+    /**
+     * 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
+     */
+    appTitle?: string | undefined;
+    /**
+     * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
+     *
+     * @remarks
+     */
+    appCategories?: string | undefined;
+};
+export type DeleteFileRequest = {
+    /**
+     * 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
+     */
+    appTitle?: string | undefined;
+    /**
+     * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
+     *
+     * @remarks
+     */
+    appCategories?: string | undefined;
+    fileId: string;
+    /**
+     * Workspace to scope the request to. Defaults to the caller’s default workspace.
+     */
+    workspaceId?: string | undefined;
+};
+/** @internal */
+export type DeleteFileRequest$Outbound = {
+    "HTTP-Referer"?: string | undefined;
+    appTitle?: string | undefined;
+    appCategories?: string | undefined;
+    file_id: string;
+    workspace_id?: string | undefined;
+};
+/** @internal */
+export declare const DeleteFileRequest$outboundSchema: z.ZodType<DeleteFileRequest$Outbound, DeleteFileRequest>;
+export declare function deleteFileRequestToJSON(deleteFileRequest: DeleteFileRequest): string;
+//# sourceMappingURL=deletefile.d.ts.map

package/esm/models/operations/deletefile.js

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4b741f4bc99e
+ */
+import * as z from "zod/v4";
+import { remap as remap$ } from "../../lib/primitives.js";
+/** @internal */
+export const DeleteFileRequest$outboundSchema = z.object({
+    httpReferer: z.string().optional(),
+    appTitle: z.string().optional(),
+    appCategories: z.string().optional(),
+    fileId: z.string(),
+    workspaceId: z.string().optional(),
+}).transform((v) => {
+    return remap$(v, {
+        httpReferer: "HTTP-Referer",
+        fileId: "file_id",
+        workspaceId: "workspace_id",
+    });
+});
+export function deleteFileRequestToJSON(deleteFileRequest) {
+    return JSON.stringify(DeleteFileRequest$outboundSchema.parse(deleteFileRequest));
+}
+//# sourceMappingURL=deletefile.js.map

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

@@ -0,0 +1,64 @@
+import * as z from "zod/v4";
+import * as models from "../index.js";
+export type DeleteWorkspaceBudgetGlobals = {
+    /**
+     * 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
+     */
+    appTitle?: string | undefined;
+    /**
+     * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
+     *
+     * @remarks
+     */
+    appCategories?: string | undefined;
+};
+export type DeleteWorkspaceBudgetRequest = {
+    /**
+     * 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
+     */
+    appTitle?: string | undefined;
+    /**
+     * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
+     *
+     * @remarks
+     */
+    appCategories?: string | undefined;
+    /**
+     * The workspace ID (UUID) or slug
+     */
+    id: string;
+    /**
+     * Budget reset interval. Use "lifetime" for a one-time budget that never resets.
+     */
+    interval: models.WorkspaceBudgetInterval;
+};
+/** @internal */
+export type DeleteWorkspaceBudgetRequest$Outbound = {
+    "HTTP-Referer"?: string | undefined;
+    appTitle?: string | undefined;
+    appCategories?: string | undefined;
+    id: string;
+    interval: string;
+};
+/** @internal */
+export declare const DeleteWorkspaceBudgetRequest$outboundSchema: z.ZodType<DeleteWorkspaceBudgetRequest$Outbound, DeleteWorkspaceBudgetRequest>;
+export declare function deleteWorkspaceBudgetRequestToJSON(deleteWorkspaceBudgetRequest: DeleteWorkspaceBudgetRequest): string;
+//# sourceMappingURL=deleteworkspacebudget.d.ts.map

package/esm/models/operations/deleteworkspacebudget.js

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f9fd25ea4948
+ */
+import * as z from "zod/v4";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as models from "../index.js";
+/** @internal */
+export const DeleteWorkspaceBudgetRequest$outboundSchema = z.object({
+    httpReferer: z.string().optional(),
+    appTitle: z.string().optional(),
+    appCategories: z.string().optional(),
+    id: z.string(),
+    interval: models.WorkspaceBudgetInterval$outboundSchema,
+}).transform((v) => {
+    return remap$(v, {
+        httpReferer: "HTTP-Referer",
+    });
+});
+export function deleteWorkspaceBudgetRequestToJSON(deleteWorkspaceBudgetRequest) {
+    return JSON.stringify(DeleteWorkspaceBudgetRequest$outboundSchema.parse(deleteWorkspaceBudgetRequest));
+}
+//# sourceMappingURL=deleteworkspacebudget.js.map

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

@@ -0,0 +1,60 @@
+import * as z from "zod/v4";
+export type DownloadFileContentGlobals = {
+    /**
+     * 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
+     */
+    appTitle?: string | undefined;
+    /**
+     * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
+     *
+     * @remarks
+     */
+    appCategories?: string | undefined;
+};
+export type DownloadFileContentRequest = {
+    /**
+     * 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
+     */
+    appTitle?: string | undefined;
+    /**
+     * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
+     *
+     * @remarks
+     */
+    appCategories?: string | undefined;
+    fileId: string;
+    /**
+     * Workspace to scope the request to. Defaults to the caller’s default workspace.
+     */
+    workspaceId?: string | undefined;
+};
+/** @internal */
+export type DownloadFileContentRequest$Outbound = {
+    "HTTP-Referer"?: string | undefined;
+    appTitle?: string | undefined;
+    appCategories?: string | undefined;
+    file_id: string;
+    workspace_id?: string | undefined;
+};
+/** @internal */
+export declare const DownloadFileContentRequest$outboundSchema: z.ZodType<DownloadFileContentRequest$Outbound, DownloadFileContentRequest>;
+export declare function downloadFileContentRequestToJSON(downloadFileContentRequest: DownloadFileContentRequest): string;
+//# sourceMappingURL=downloadfilecontent.d.ts.map

package/esm/models/operations/downloadfilecontent.js

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1c7f08d2fedf
+ */
+import * as z from "zod/v4";
+import { remap as remap$ } from "../../lib/primitives.js";
+/** @internal */
+export const DownloadFileContentRequest$outboundSchema = z.object({
+    httpReferer: z.string().optional(),
+    appTitle: z.string().optional(),
+    appCategories: z.string().optional(),
+    fileId: z.string(),
+    workspaceId: z.string().optional(),
+}).transform((v) => {
+    return remap$(v, {
+        httpReferer: "HTTP-Referer",
+        fileId: "file_id",
+        workspaceId: "workspace_id",
+    });
+});
+export function downloadFileContentRequestToJSON(downloadFileContentRequest) {
+    return JSON.stringify(DownloadFileContentRequest$outboundSchema.parse(downloadFileContentRequest));
+}
+//# sourceMappingURL=downloadfilecontent.js.map

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

@@ -0,0 +1,198 @@
+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 GetAnalyticsMetaGlobals = {
+    /**
+     * 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
+     */
+    appTitle?: string | undefined;
+    /**
+     * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
+     *
+     * @remarks
+     */
+    appCategories?: string | undefined;
+};
+export type GetAnalyticsMetaRequest = {
+    /**
+     * 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
+     */
+    appTitle?: string | undefined;
+    /**
+     * Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
+     *
+     * @remarks
+     */
+    appCategories?: string | undefined;
+};
+export type Dimension = {
+    /**
+     * Human-readable label
+     */
+    displayLabel: string;
+    /**
+     * Dimension identifier used in query requests
+     */
+    name: string;
+};
+/**
+ * Granularity identifier
+ */
+export declare const GranularityName: {
+    readonly Minute: "minute";
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+/**
+ * Granularity identifier
+ */
+export type GranularityName = OpenEnum<typeof GranularityName>;
+export type Granularity = {
+    /**
+     * Human-readable label
+     */
+    displayLabel: string;
+    /**
+     * Granularity identifier
+     */
+    name: GranularityName;
+};
+/**
+ * How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $)
+ */
+export declare const DisplayFormat: {
+    readonly Number: "number";
+    readonly Currency: "currency";
+    readonly Percent: "percent";
+    readonly Latency: "latency";
+    readonly Throughput: "throughput";
+};
+/**
+ * How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $)
+ */
+export type DisplayFormat = OpenEnum<typeof DisplayFormat>;
+export type Metric = {
+    /**
+     * How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $)
+     */
+    displayFormat: DisplayFormat;
+    /**
+     * Human-readable label
+     */
+    displayLabel: string;
+    /**
+     * Whether this metric is a rate/ratio (averaged, not summed)
+     */
+    isRate: boolean;
+    /**
+     * Metric identifier used in query requests
+     */
+    name: string;
+};
+/**
+ * Operator identifier used in filter definitions
+ */
+export declare const OperatorName: {
+    readonly Eq: "eq";
+    readonly Neq: "neq";
+    readonly In: "in";
+    readonly NotIn: "not_in";
+    readonly Gt: "gt";
+    readonly Gte: "gte";
+    readonly Lt: "lt";
+    readonly Lte: "lte";
+};
+/**
+ * Operator identifier used in filter definitions
+ */
+export type OperatorName = OpenEnum<typeof OperatorName>;
+/**
+ * Whether the operator expects a single value or an array
+ */
+export declare const ValueType: {
+    readonly Scalar: "scalar";
+    readonly Array: "array";
+};
+/**
+ * Whether the operator expects a single value or an array
+ */
+export type ValueType = OpenEnum<typeof ValueType>;
+export type Operator = {
+    /**
+     * Operator identifier used in filter definitions
+     */
+    name: OperatorName;
+    /**
+     * Whether the operator expects a single value or an array
+     */
+    valueType: ValueType;
+};
+export type GetAnalyticsMetaData = {
+    dimensions: Array<Dimension>;
+    granularities: Array<Granularity>;
+    metrics: Array<Metric>;
+    operators: Array<Operator>;
+};
+/**
+ * Returns analytics query metadata
+ */
+export type GetAnalyticsMetaResponse = {
+    data: GetAnalyticsMetaData;
+};
+/** @internal */
+export type GetAnalyticsMetaRequest$Outbound = {
+    "HTTP-Referer"?: string | undefined;
+    appTitle?: string | undefined;
+    appCategories?: string | undefined;
+};
+/** @internal */
+export declare const GetAnalyticsMetaRequest$outboundSchema: z.ZodType<GetAnalyticsMetaRequest$Outbound, GetAnalyticsMetaRequest>;
+export declare function getAnalyticsMetaRequestToJSON(getAnalyticsMetaRequest: GetAnalyticsMetaRequest): string;
+/** @internal */
+export declare const Dimension$inboundSchema: z.ZodType<Dimension, unknown>;
+export declare function dimensionFromJSON(jsonString: string): SafeParseResult<Dimension, SDKValidationError>;
+/** @internal */
+export declare const GranularityName$inboundSchema: z.ZodType<GranularityName, unknown>;
+/** @internal */
+export declare const Granularity$inboundSchema: z.ZodType<Granularity, unknown>;
+export declare function granularityFromJSON(jsonString: string): SafeParseResult<Granularity, SDKValidationError>;
+/** @internal */
+export declare const DisplayFormat$inboundSchema: z.ZodType<DisplayFormat, unknown>;
+/** @internal */
+export declare const Metric$inboundSchema: z.ZodType<Metric, unknown>;
+export declare function metricFromJSON(jsonString: string): SafeParseResult<Metric, SDKValidationError>;
+/** @internal */
+export declare const OperatorName$inboundSchema: z.ZodType<OperatorName, unknown>;
+/** @internal */
+export declare const ValueType$inboundSchema: z.ZodType<ValueType, unknown>;
+/** @internal */
+export declare const Operator$inboundSchema: z.ZodType<Operator, unknown>;
+export declare function operatorFromJSON(jsonString: string): SafeParseResult<Operator, SDKValidationError>;
+/** @internal */
+export declare const GetAnalyticsMetaData$inboundSchema: z.ZodType<GetAnalyticsMetaData, unknown>;
+export declare function getAnalyticsMetaDataFromJSON(jsonString: string): SafeParseResult<GetAnalyticsMetaData, SDKValidationError>;
+/** @internal */
+export declare const GetAnalyticsMetaResponse$inboundSchema: z.ZodType<GetAnalyticsMetaResponse, unknown>;
+export declare function getAnalyticsMetaResponseFromJSON(jsonString: string): SafeParseResult<GetAnalyticsMetaResponse, SDKValidationError>;
+//# sourceMappingURL=getanalyticsmeta.d.ts.map