Generates an image from a text prompt via the image generation router
Example Usage
import { OpenRouter } from "@openrouter/sdk";const openRouter = new OpenRouter({ httpReferer: "<value>", appTitle: "<value>", appCategories: "<value>", apiKey: process.env["OPENROUTER_API_KEY"] ?? "",});async function run() { const result = await openRouter.images.generate({ imageGenerationRequest: { model: "bytedance-seed/seedream-4.5", prompt: "a red panda astronaut floating in space, studio lighting", }, }); console.log(result);}run();
Standalone function
The standalone function version of this method:
import { OpenRouterCore } from "@openrouter/sdk/core.js";import { imagesGenerate } from "@openrouter/sdk/funcs/imagesGenerate.js";// Use `OpenRouterCore` for best tree-shaking performance.// You can create one instance of it to use across an application.const openRouter = new OpenRouterCore({ httpReferer: "<value>", appTitle: "<value>", appCategories: "<value>", apiKey: process.env["OPENROUTER_API_KEY"] ?? "",});async function run() { const res = await imagesGenerate(openRouter, { imageGenerationRequest: { model: "bytedance-seed/seedream-4.5", prompt: "a red panda astronaut floating in space, studio lighting", }, }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("imagesGenerate failed:", res.error); }}run();
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Lists every image generation model with its top-level supported-parameter superset and a URL to its full per-endpoint records.
Example Usage
import { OpenRouter } from "@openrouter/sdk";const openRouter = new OpenRouter({ httpReferer: "<value>", appTitle: "<value>", appCategories: "<value>", apiKey: process.env["OPENROUTER_API_KEY"] ?? "",});async function run() { const result = await openRouter.images.listModels(); console.log(result);}run();
Standalone function
The standalone function version of this method:
import { OpenRouterCore } from "@openrouter/sdk/core.js";import { imagesListModels } from "@openrouter/sdk/funcs/imagesListModels.js";// Use `OpenRouterCore` for best tree-shaking performance.// You can create one instance of it to use across an application.const openRouter = new OpenRouterCore({ httpReferer: "<value>", appTitle: "<value>", appCategories: "<value>", apiKey: process.env["OPENROUTER_API_KEY"] ?? "",});async function run() { const res = await imagesListModels(openRouter); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("imagesListModels failed:", res.error); }}run();
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Returns the full per-endpoint records for an image model: each endpoint’s definitive supported parameters, pricing, and passthrough allowlist.
Example Usage
import { OpenRouter } from "@openrouter/sdk";const openRouter = new OpenRouter({ httpReferer: "<value>", appTitle: "<value>", appCategories: "<value>", apiKey: process.env["OPENROUTER_API_KEY"] ?? "",});async function run() { const result = await openRouter.images.listModelEndpoints({ author: "bytedance-seed", slug: "seedream-4.5", }); console.log(result);}run();
Standalone function
The standalone function version of this method:
import { OpenRouterCore } from "@openrouter/sdk/core.js";import { imagesListModelEndpoints } from "@openrouter/sdk/funcs/imagesListModelEndpoints.js";// Use `OpenRouterCore` for best tree-shaking performance.// You can create one instance of it to use across an application.const openRouter = new OpenRouterCore({ httpReferer: "<value>", appTitle: "<value>", appCategories: "<value>", apiKey: process.env["OPENROUTER_API_KEY"] ?? "",});async function run() { const res = await imagesListModelEndpoints(openRouter, { author: "bytedance-seed", slug: "seedream-4.5", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("imagesListModelEndpoints failed:", res.error); }}run();
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.