@runapi.ai/seedream 0.2.1 → 0.2.6

package/README.md

@@ -1,6 +1,6 @@
 # Seedream API JavaScript SDK for RunAPI
 
-The seedream api JavaScript SDK is the language-specific package for Seedream on RunAPI. Use this seedream api package for text-to-image, image-to-image, edit, and creative production flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in JavaScript.
+The seedream api JavaScript SDK is the language-specific package for Seedream on RunAPI. Use this seedream api package for text-to-image, image editing, and creative production flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in JavaScript.
 
 This seedream api README is the JavaScript package guide inside the public `seedream-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/seedream; for API reference, use https://runapi.ai/docs#seedream; for SDK docs, use https://runapi.ai/docs#sdk-seedream.
 
@@ -16,25 +16,28 @@ npm install @runapi.ai/seedream
 import { SeedreamClient } from '@runapi.ai/seedream';
 
 const client = new SeedreamClient();
-const task = await client.generations.create({
-  // Pass the Seedream JSON request body from https://runapi.ai/docs#seedream.
+const task = await client.textToImage.create({
+  model: 'seedream-v4-text-to-image',
+  prompt: 'A precise product render of a glass teapot on white marble',
+  aspect_ratio: '16:9',
+  output_resolution: '2k',
+  output_count: 3,
 });
-const status = await client.generations.get(task.id);
+const status = await client.textToImage.get(task.id);
 ```
 
 Use `create` when you want to submit a task and return quickly, `get` when you need the latest task state, and `run` when a script should create and poll until completion. In web request handlers, prefer `create` plus webhook or later `get` polling so a worker is not held open.
 
 ## Language notes
 
-Use the TypeScript types in `src/types.ts` and the resource classes under `src/resources` when building image applications. The available resources include generations. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
+Use the TypeScript types in `src/types.ts` and the resource classes under `src/resources` when building image applications. The package exposes `textToImage` for text models and `editImage` for editing models. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 
 - Model page: https://runapi.ai/models/seedream
 - SDK docs: https://runapi.ai/docs#sdk-seedream
 - Product docs: https://runapi.ai/docs#seedream
-- Pricing and rate limits: https://runapi.ai/models/seedream/4.5-text-to-image
-- Provider comparison: https://runapi.ai/providers/bytedance
+- Pricing and rate limits: https://runapi.ai/models/seedream/v4-text-to-image
 - Full catalog: https://runapi.ai/models
 - Repository: https://github.com/runapi-ai/seedream-sdk
 

package/dist/index.d.mts

@@ -1,32 +1,51 @@
 import { AsyncTaskStatus, HttpClient, RequestOptions, PollingOptions, ClientOptions } from '@runapi.ai/core';
 export { AuthenticationError, InsufficientCreditsError, NetworkError, NotFoundError, RateLimitError, RunApiError, ServiceUnavailableError, TaskFailedError, TaskTimeoutError, TimeoutError, ValidationError } from '@runapi.ai/core';
 
-type SeedreamModel = 'seedream-4.5-text-to-image' | 'seedream-4.5-edit' | 'seedream-5-lite-text-to-image' | 'seedream-5-lite-image-to-image';
+type SeedreamModel = 'seedream-4.5-text-to-image' | 'seedream-4.5-edit' | 'seedream-5-lite-text-to-image' | 'seedream-5-lite-edit' | 'seedream-v4-text-to-image' | 'seedream-v4-edit';
+type TextToImageModel = 'seedream-4.5-text-to-image' | 'seedream-5-lite-text-to-image' | 'seedream-v4-text-to-image';
+type EditImageModel = 'seedream-4.5-edit' | 'seedream-5-lite-edit' | 'seedream-v4-edit';
 type AspectRatio = '1:1' | '4:3' | '3:4' | '16:9' | '9:16' | '2:3' | '3:2' | '21:9';
-type Quality = 'basic' | 'high';
-interface GenerationBaseParams {
+type OutputQuality = 'basic' | 'high';
+type V4OutputResolution = '1k' | '2k' | '4k';
+interface ImageGenerationBaseParams {
     prompt: string;
     aspect_ratio: AspectRatio;
-    quality: Quality;
+    output_quality: OutputQuality;
+    enable_safety_checker?: boolean;
     callback_url?: string;
 }
-interface Generation45TextParams extends GenerationBaseParams {
+interface V4GenerationBaseParams {
+    prompt: string;
+    aspect_ratio?: AspectRatio;
+    output_resolution?: V4OutputResolution;
+    output_count?: number;
+    seed?: number;
+    enable_safety_checker?: boolean;
+    callback_url?: string;
+}
+interface Generation45TextParams extends ImageGenerationBaseParams {
     model: 'seedream-4.5-text-to-image';
 }
-interface Generation45EditImageParams extends GenerationBaseParams {
+interface Generation45EditImageParams extends ImageGenerationBaseParams {
     model: 'seedream-4.5-edit';
-    image_urls: string[];
+    source_image_urls: string[];
 }
-interface Generation5LiteTextParams extends GenerationBaseParams {
+interface Generation5LiteTextParams extends ImageGenerationBaseParams {
     model: 'seedream-5-lite-text-to-image';
-    nsfw_checker?: boolean;
 }
-interface Generation5LiteImageParams extends GenerationBaseParams {
-    model: 'seedream-5-lite-image-to-image';
-    image_urls: string[];
-    nsfw_checker?: boolean;
+interface Generation5LiteEditParams extends ImageGenerationBaseParams {
+    model: 'seedream-5-lite-edit';
+    source_image_urls: string[];
 }
-type TextToImageParams = Generation45TextParams | Generation45EditImageParams | Generation5LiteTextParams | Generation5LiteImageParams;
+interface GenerationV4TextParams extends V4GenerationBaseParams {
+    model: 'seedream-v4-text-to-image';
+}
+interface GenerationV4EditParams extends V4GenerationBaseParams {
+    model: 'seedream-v4-edit';
+    source_image_urls: string[];
+}
+type TextToImageParams = Generation45TextParams | Generation5LiteTextParams | GenerationV4TextParams;
+type EditImageParams = Generation45EditImageParams | Generation5LiteEditParams | GenerationV4EditParams;
 interface TaskCreateResponse {
     id: string;
 }
@@ -40,6 +59,7 @@ interface TextToImageResponse {
     error?: string;
     [key: string]: unknown;
 }
+type EditImageResponse = TextToImageResponse;
 /**
  * Resolved response returned by the `run()` method after polling sees
  * `status: 'completed'`. Narrows the base response so `images` is
@@ -49,6 +69,10 @@ type CompletedTextToImageResponse = TextToImageResponse & {
     status: 'completed';
     images: Image[];
 };
+type CompletedEditImageResponse = EditImageResponse & {
+    status: 'completed';
+    images: Image[];
+};
 
 declare class TextToImage {
     private readonly http;
@@ -58,9 +82,18 @@ declare class TextToImage {
     get(id: string, options?: RequestOptions): Promise<TextToImageResponse>;
 }
 
+declare class EditImage {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: EditImageParams, options?: RequestOptions & PollingOptions): Promise<CompletedEditImageResponse>;
+    create(params: EditImageParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<EditImageResponse>;
+}
+
 declare class SeedreamClient {
     readonly textToImage: TextToImage;
+    readonly editImage: EditImage;
     constructor(options?: ClientOptions);
 }
 
-export { type AspectRatio, type CompletedTextToImageResponse, type Generation45EditImageParams, type Generation45TextParams, type Generation5LiteImageParams, type Generation5LiteTextParams, type Image, type Quality, SeedreamClient, type SeedreamModel, type TaskCreateResponse, type TextToImageParams, type TextToImageResponse };
+export { type AspectRatio, type CompletedEditImageResponse, type CompletedTextToImageResponse, type EditImageModel, type EditImageParams, type EditImageResponse, type Generation45EditImageParams, type Generation45TextParams, type Generation5LiteEditParams, type Generation5LiteTextParams, type GenerationV4EditParams, type GenerationV4TextParams, type Image, type OutputQuality, SeedreamClient, type SeedreamModel, type TaskCreateResponse, type TextToImageModel, type TextToImageParams, type TextToImageResponse, type V4OutputResolution };

package/dist/index.d.ts

@@ -1,32 +1,51 @@
 import { AsyncTaskStatus, HttpClient, RequestOptions, PollingOptions, ClientOptions } from '@runapi.ai/core';
 export { AuthenticationError, InsufficientCreditsError, NetworkError, NotFoundError, RateLimitError, RunApiError, ServiceUnavailableError, TaskFailedError, TaskTimeoutError, TimeoutError, ValidationError } from '@runapi.ai/core';
 
-type SeedreamModel = 'seedream-4.5-text-to-image' | 'seedream-4.5-edit' | 'seedream-5-lite-text-to-image' | 'seedream-5-lite-image-to-image';
+type SeedreamModel = 'seedream-4.5-text-to-image' | 'seedream-4.5-edit' | 'seedream-5-lite-text-to-image' | 'seedream-5-lite-edit' | 'seedream-v4-text-to-image' | 'seedream-v4-edit';
+type TextToImageModel = 'seedream-4.5-text-to-image' | 'seedream-5-lite-text-to-image' | 'seedream-v4-text-to-image';
+type EditImageModel = 'seedream-4.5-edit' | 'seedream-5-lite-edit' | 'seedream-v4-edit';
 type AspectRatio = '1:1' | '4:3' | '3:4' | '16:9' | '9:16' | '2:3' | '3:2' | '21:9';
-type Quality = 'basic' | 'high';
-interface GenerationBaseParams {
+type OutputQuality = 'basic' | 'high';
+type V4OutputResolution = '1k' | '2k' | '4k';
+interface ImageGenerationBaseParams {
     prompt: string;
     aspect_ratio: AspectRatio;
-    quality: Quality;
+    output_quality: OutputQuality;
+    enable_safety_checker?: boolean;
     callback_url?: string;
 }
-interface Generation45TextParams extends GenerationBaseParams {
+interface V4GenerationBaseParams {
+    prompt: string;
+    aspect_ratio?: AspectRatio;
+    output_resolution?: V4OutputResolution;
+    output_count?: number;
+    seed?: number;
+    enable_safety_checker?: boolean;
+    callback_url?: string;
+}
+interface Generation45TextParams extends ImageGenerationBaseParams {
     model: 'seedream-4.5-text-to-image';
 }
-interface Generation45EditImageParams extends GenerationBaseParams {
+interface Generation45EditImageParams extends ImageGenerationBaseParams {
     model: 'seedream-4.5-edit';
-    image_urls: string[];
+    source_image_urls: string[];
 }
-interface Generation5LiteTextParams extends GenerationBaseParams {
+interface Generation5LiteTextParams extends ImageGenerationBaseParams {
     model: 'seedream-5-lite-text-to-image';
-    nsfw_checker?: boolean;
 }
-interface Generation5LiteImageParams extends GenerationBaseParams {
-    model: 'seedream-5-lite-image-to-image';
-    image_urls: string[];
-    nsfw_checker?: boolean;
+interface Generation5LiteEditParams extends ImageGenerationBaseParams {
+    model: 'seedream-5-lite-edit';
+    source_image_urls: string[];
 }
-type TextToImageParams = Generation45TextParams | Generation45EditImageParams | Generation5LiteTextParams | Generation5LiteImageParams;
+interface GenerationV4TextParams extends V4GenerationBaseParams {
+    model: 'seedream-v4-text-to-image';
+}
+interface GenerationV4EditParams extends V4GenerationBaseParams {
+    model: 'seedream-v4-edit';
+    source_image_urls: string[];
+}
+type TextToImageParams = Generation45TextParams | Generation5LiteTextParams | GenerationV4TextParams;
+type EditImageParams = Generation45EditImageParams | Generation5LiteEditParams | GenerationV4EditParams;
 interface TaskCreateResponse {
     id: string;
 }
@@ -40,6 +59,7 @@ interface TextToImageResponse {
     error?: string;
     [key: string]: unknown;
 }
+type EditImageResponse = TextToImageResponse;
 /**
  * Resolved response returned by the `run()` method after polling sees
  * `status: 'completed'`. Narrows the base response so `images` is
@@ -49,6 +69,10 @@ type CompletedTextToImageResponse = TextToImageResponse & {
     status: 'completed';
     images: Image[];
 };
+type CompletedEditImageResponse = EditImageResponse & {
+    status: 'completed';
+    images: Image[];
+};
 
 declare class TextToImage {
     private readonly http;
@@ -58,9 +82,18 @@ declare class TextToImage {
     get(id: string, options?: RequestOptions): Promise<TextToImageResponse>;
 }
 
+declare class EditImage {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: EditImageParams, options?: RequestOptions & PollingOptions): Promise<CompletedEditImageResponse>;
+    create(params: EditImageParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<EditImageResponse>;
+}
+
 declare class SeedreamClient {
     readonly textToImage: TextToImage;
+    readonly editImage: EditImage;
     constructor(options?: ClientOptions);
 }
 
-export { type AspectRatio, type CompletedTextToImageResponse, type Generation45EditImageParams, type Generation45TextParams, type Generation5LiteImageParams, type Generation5LiteTextParams, type Image, type Quality, SeedreamClient, type SeedreamModel, type TaskCreateResponse, type TextToImageParams, type TextToImageResponse };
+export { type AspectRatio, type CompletedEditImageResponse, type CompletedTextToImageResponse, type EditImageModel, type EditImageParams, type EditImageResponse, type Generation45EditImageParams, type Generation45TextParams, type Generation5LiteEditParams, type Generation5LiteTextParams, type GenerationV4EditParams, type GenerationV4TextParams, type Image, type OutputQuality, SeedreamClient, type SeedreamModel, type TaskCreateResponse, type TextToImageModel, type TextToImageParams, type TextToImageResponse, type V4OutputResolution };

package/dist/index.js

@@ -20,23 +20,23 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  AuthenticationError: () => import_core3.AuthenticationError,
-  InsufficientCreditsError: () => import_core3.InsufficientCreditsError,
-  NetworkError: () => import_core3.NetworkError,
-  NotFoundError: () => import_core3.NotFoundError,
-  RateLimitError: () => import_core3.RateLimitError,
-  RunApiError: () => import_core3.RunApiError,
+  AuthenticationError: () => import_core4.AuthenticationError,
+  InsufficientCreditsError: () => import_core4.InsufficientCreditsError,
+  NetworkError: () => import_core4.NetworkError,
+  NotFoundError: () => import_core4.NotFoundError,
+  RateLimitError: () => import_core4.RateLimitError,
+  RunApiError: () => import_core4.RunApiError,
   SeedreamClient: () => SeedreamClient,
-  ServiceUnavailableError: () => import_core3.ServiceUnavailableError,
-  TaskFailedError: () => import_core3.TaskFailedError,
-  TaskTimeoutError: () => import_core3.TaskTimeoutError,
-  TimeoutError: () => import_core3.TimeoutError,
-  ValidationError: () => import_core3.ValidationError
+  ServiceUnavailableError: () => import_core4.ServiceUnavailableError,
+  TaskFailedError: () => import_core4.TaskFailedError,
+  TaskTimeoutError: () => import_core4.TaskTimeoutError,
+  TimeoutError: () => import_core4.TimeoutError,
+  ValidationError: () => import_core4.ValidationError
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/client.ts
-var import_core2 = require("@runapi.ai/core");
+var import_core3 = require("@runapi.ai/core");
 
 // src/resources/text-to-image.ts
 var import_core = require("@runapi.ai/core");
@@ -68,17 +68,49 @@ var TextToImage = class {
   }
 };
 
+// src/resources/edit-image.ts
+var import_core2 = require("@runapi.ai/core");
+var import_internal2 = require("@runapi.ai/core/internal");
+var ENDPOINT2 = "/api/v1/seedream/edit_image";
+var EditImage = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  async run(params, options) {
+    const { id } = await this.create(params, options);
+    const response = await (0, import_internal2.pollUntilComplete)(() => this.get(id, options), {
+      maxWaitMs: options?.maxWaitMs,
+      pollIntervalMs: options?.pollIntervalMs
+    });
+    return response;
+  }
+  async create(params, options) {
+    return this.http.request("POST", ENDPOINT2, {
+      body: (0, import_core2.compactParams)(params),
+      ...options
+    });
+  }
+  async get(id, options) {
+    return this.http.request("GET", `${ENDPOINT2}/${id}`, {
+      ...options
+    });
+  }
+};
+
 // src/client.ts
 var SeedreamClient = class {
   textToImage;
+  editImage;
   constructor(options = {}) {
-    const http = (0, import_core2.createHttpClient)(options);
+    const http = (0, import_core3.createHttpClient)(options);
     this.textToImage = new TextToImage(http);
+    this.editImage = new EditImage(http);
   }
 };
 
 // src/index.ts
-var import_core3 = require("@runapi.ai/core");
+var import_core4 = require("@runapi.ai/core");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AuthenticationError,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/client.ts","../src/resources/text-to-image.ts"],"sourcesContent":["export { SeedreamClient } from './client';\nexport * from './types';\n\nexport {\n  RunApiError,\n  AuthenticationError,\n  InsufficientCreditsError,\n  NotFoundError,\n  ValidationError,\n  RateLimitError,\n  ServiceUnavailableError,\n  NetworkError,\n  TimeoutError,\n  TaskTimeoutError,\n  TaskFailedError,\n} from '@runapi.ai/core';\n","import { createHttpClient, type ClientOptions } from '@runapi.ai/core';\nimport { TextToImage } from './resources/text-to-image';\n\nexport class SeedreamClient {\n  public readonly textToImage: TextToImage;\n\n  constructor(options: ClientOptions = {}) {\n    const http = createHttpClient(options);\n    this.textToImage = new TextToImage(http);\n  }\n}\n","import type { HttpClient, RequestOptions, PollingOptions } from '@runapi.ai/core';\nimport { compactParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport type {\n  CompletedTextToImageResponse,\n  TextToImageParams,\n  TextToImageResponse,\n  TaskCreateResponse,\n} from '../types';\n\nconst ENDPOINT = '/api/v1/seedream/text_to_image';\n\nexport class TextToImage {\n  constructor(private readonly http: HttpClient) {}\n\n  async run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<CompletedTextToImageResponse> {\n    const { id } = await this.create(params, options);\n    const response = await pollUntilComplete<TextToImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\n    return response as CompletedTextToImageResponse;\n  }\n\n  async create(params: TextToImageParams, options?: RequestOptions): Promise<TaskCreateResponse> {\n    return this.http.request<TaskCreateResponse>('POST', ENDPOINT, {\n      body: compactParams(params),\n      ...options,\n    });\n  }\n\n  async get(id: string, options?: RequestOptions): Promise<TextToImageResponse> {\n    return this.http.request<TextToImageResponse>('GET', `${ENDPOINT}/${id}`, {\n      ...options,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,eAAqD;;;ACCrD,kBAA8B;AAC9B,sBAAkC;AAQlC,IAAM,WAAW;AAEV,IAAM,cAAN,MAAkB;AAAA,EACvB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA,EAE7B,MAAM,IAAI,QAA2B,SAAkF;AACrH,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,UAAM,WAAW,UAAM,mCAAuC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACzF,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,OAAO,QAA2B,SAAuD;AAC7F,WAAO,KAAK,KAAK,QAA4B,QAAQ,UAAU;AAAA,MAC7D,UAAM,2BAAc,MAAM;AAAA,MAC1B,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,IAAY,SAAwD;AAC5E,WAAO,KAAK,KAAK,QAA6B,OAAO,GAAG,QAAQ,IAAI,EAAE,IAAI;AAAA,MACxE,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;;;ADjCO,IAAM,iBAAN,MAAqB;AAAA,EACV;AAAA,EAEhB,YAAY,UAAyB,CAAC,GAAG;AACvC,UAAM,WAAO,+BAAiB,OAAO;AACrC,SAAK,cAAc,IAAI,YAAY,IAAI;AAAA,EACzC;AACF;;;ADPA,IAAAC,eAYO;","names":["import_core","import_core"]}
+{"version":3,"sources":["../src/index.ts","../src/client.ts","../src/resources/text-to-image.ts","../src/resources/edit-image.ts"],"sourcesContent":["export { SeedreamClient } from './client';\nexport * from './types';\n\nexport {\n  RunApiError,\n  AuthenticationError,\n  InsufficientCreditsError,\n  NotFoundError,\n  ValidationError,\n  RateLimitError,\n  ServiceUnavailableError,\n  NetworkError,\n  TimeoutError,\n  TaskTimeoutError,\n  TaskFailedError,\n} from '@runapi.ai/core';\n","import { createHttpClient, type ClientOptions } from '@runapi.ai/core';\nimport { TextToImage } from './resources/text-to-image';\nimport { EditImage } from './resources/edit-image';\n\nexport class SeedreamClient {\n  public readonly textToImage: TextToImage;\n  public readonly editImage: EditImage;\n\n  constructor(options: ClientOptions = {}) {\n    const http = createHttpClient(options);\n    this.textToImage = new TextToImage(http);\n    this.editImage = new EditImage(http);\n  }\n}\n","import type { HttpClient, RequestOptions, PollingOptions } from '@runapi.ai/core';\nimport { compactParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport type {\n  CompletedTextToImageResponse,\n  TextToImageParams,\n  TextToImageResponse,\n  TaskCreateResponse,\n} from '../types';\n\nconst ENDPOINT = '/api/v1/seedream/text_to_image';\n\nexport class TextToImage {\n  constructor(private readonly http: HttpClient) {}\n\n  async run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<CompletedTextToImageResponse> {\n    const { id } = await this.create(params, options);\n    const response = await pollUntilComplete<TextToImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\n    return response as CompletedTextToImageResponse;\n  }\n\n  async create(params: TextToImageParams, options?: RequestOptions): Promise<TaskCreateResponse> {\n    return this.http.request<TaskCreateResponse>('POST', ENDPOINT, {\n      body: compactParams(params),\n      ...options,\n    });\n  }\n\n  async get(id: string, options?: RequestOptions): Promise<TextToImageResponse> {\n    return this.http.request<TextToImageResponse>('GET', `${ENDPOINT}/${id}`, {\n      ...options,\n    });\n  }\n}\n","import type { HttpClient, RequestOptions, PollingOptions } from '@runapi.ai/core';\nimport { compactParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport type {\n  CompletedEditImageResponse,\n  EditImageParams,\n  EditImageResponse,\n  TaskCreateResponse,\n} from '../types';\n\nconst ENDPOINT = '/api/v1/seedream/edit_image';\n\nexport class EditImage {\n  constructor(private readonly http: HttpClient) {}\n\n  async run(params: EditImageParams, options?: RequestOptions & PollingOptions): Promise<CompletedEditImageResponse> {\n    const { id } = await this.create(params, options);\n    const response = await pollUntilComplete<EditImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\n    return response as CompletedEditImageResponse;\n  }\n\n  async create(params: EditImageParams, options?: RequestOptions): Promise<TaskCreateResponse> {\n    return this.http.request<TaskCreateResponse>('POST', ENDPOINT, {\n      body: compactParams(params),\n      ...options,\n    });\n  }\n\n  async get(id: string, options?: RequestOptions): Promise<EditImageResponse> {\n    return this.http.request<EditImageResponse>('GET', `${ENDPOINT}/${id}`, {\n      ...options,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,eAAqD;;;ACCrD,kBAA8B;AAC9B,sBAAkC;AAQlC,IAAM,WAAW;AAEV,IAAM,cAAN,MAAkB;AAAA,EACvB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA,EAE7B,MAAM,IAAI,QAA2B,SAAkF;AACrH,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,UAAM,WAAW,UAAM,mCAAuC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACzF,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,OAAO,QAA2B,SAAuD;AAC7F,WAAO,KAAK,KAAK,QAA4B,QAAQ,UAAU;AAAA,MAC7D,UAAM,2BAAc,MAAM;AAAA,MAC1B,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,IAAY,SAAwD;AAC5E,WAAO,KAAK,KAAK,QAA6B,OAAO,GAAG,QAAQ,IAAI,EAAE,IAAI;AAAA,MACxE,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;;;ACnCA,IAAAC,eAA8B;AAC9B,IAAAC,mBAAkC;AAQlC,IAAMC,YAAW;AAEV,IAAM,YAAN,MAAgB;AAAA,EACrB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA,EAE7B,MAAM,IAAI,QAAyB,SAAgF;AACjH,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,UAAM,WAAW,UAAM,oCAAqC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACvF,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,OAAO,QAAyB,SAAuD;AAC3F,WAAO,KAAK,KAAK,QAA4B,QAAQA,WAAU;AAAA,MAC7D,UAAM,4BAAc,MAAM;AAAA,MAC1B,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,IAAY,SAAsD;AAC1E,WAAO,KAAK,KAAK,QAA2B,OAAO,GAAGA,SAAQ,IAAI,EAAE,IAAI;AAAA,MACtE,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;;;AFhCO,IAAM,iBAAN,MAAqB;AAAA,EACV;AAAA,EACA;AAAA,EAEhB,YAAY,UAAyB,CAAC,GAAG;AACvC,UAAM,WAAO,+BAAiB,OAAO;AACrC,SAAK,cAAc,IAAI,YAAY,IAAI;AACvC,SAAK,YAAY,IAAI,UAAU,IAAI;AAAA,EACrC;AACF;;;ADVA,IAAAC,eAYO;","names":["import_core","import_core","import_internal","ENDPOINT","import_core"]}

package/dist/index.mjs

@@ -31,12 +31,44 @@ var TextToImage = class {
   }
 };
 
+// src/resources/edit-image.ts
+import { compactParams as compactParams2 } from "@runapi.ai/core";
+import { pollUntilComplete as pollUntilComplete2 } from "@runapi.ai/core/internal";
+var ENDPOINT2 = "/api/v1/seedream/edit_image";
+var EditImage = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  async run(params, options) {
+    const { id } = await this.create(params, options);
+    const response = await pollUntilComplete2(() => this.get(id, options), {
+      maxWaitMs: options?.maxWaitMs,
+      pollIntervalMs: options?.pollIntervalMs
+    });
+    return response;
+  }
+  async create(params, options) {
+    return this.http.request("POST", ENDPOINT2, {
+      body: compactParams2(params),
+      ...options
+    });
+  }
+  async get(id, options) {
+    return this.http.request("GET", `${ENDPOINT2}/${id}`, {
+      ...options
+    });
+  }
+};
+
 // src/client.ts
 var SeedreamClient = class {
   textToImage;
+  editImage;
   constructor(options = {}) {
     const http = createHttpClient(options);
     this.textToImage = new TextToImage(http);
+    this.editImage = new EditImage(http);
   }
 };
 

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/client.ts","../src/resources/text-to-image.ts","../src/index.ts"],"sourcesContent":["import { createHttpClient, type ClientOptions } from '@runapi.ai/core';\nimport { TextToImage } from './resources/text-to-image';\n\nexport class SeedreamClient {\n  public readonly textToImage: TextToImage;\n\n  constructor(options: ClientOptions = {}) {\n    const http = createHttpClient(options);\n    this.textToImage = new TextToImage(http);\n  }\n}\n","import type { HttpClient, RequestOptions, PollingOptions } from '@runapi.ai/core';\nimport { compactParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport type {\n  CompletedTextToImageResponse,\n  TextToImageParams,\n  TextToImageResponse,\n  TaskCreateResponse,\n} from '../types';\n\nconst ENDPOINT = '/api/v1/seedream/text_to_image';\n\nexport class TextToImage {\n  constructor(private readonly http: HttpClient) {}\n\n  async run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<CompletedTextToImageResponse> {\n    const { id } = await this.create(params, options);\n    const response = await pollUntilComplete<TextToImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\n    return response as CompletedTextToImageResponse;\n  }\n\n  async create(params: TextToImageParams, options?: RequestOptions): Promise<TaskCreateResponse> {\n    return this.http.request<TaskCreateResponse>('POST', ENDPOINT, {\n      body: compactParams(params),\n      ...options,\n    });\n  }\n\n  async get(id: string, options?: RequestOptions): Promise<TextToImageResponse> {\n    return this.http.request<TextToImageResponse>('GET', `${ENDPOINT}/${id}`, {\n      ...options,\n    });\n  }\n}\n","export { SeedreamClient } from './client';\nexport * from './types';\n\nexport {\n  RunApiError,\n  AuthenticationError,\n  InsufficientCreditsError,\n  NotFoundError,\n  ValidationError,\n  RateLimitError,\n  ServiceUnavailableError,\n  NetworkError,\n  TimeoutError,\n  TaskTimeoutError,\n  TaskFailedError,\n} from '@runapi.ai/core';\n"],"mappings":";AAAA,SAAS,wBAA4C;;;ACCrD,SAAS,qBAAqB;AAC9B,SAAS,yBAAyB;AAQlC,IAAM,WAAW;AAEV,IAAM,cAAN,MAAkB;AAAA,EACvB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA,EAE7B,MAAM,IAAI,QAA2B,SAAkF;AACrH,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,UAAM,WAAW,MAAM,kBAAuC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACzF,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,OAAO,QAA2B,SAAuD;AAC7F,WAAO,KAAK,KAAK,QAA4B,QAAQ,UAAU;AAAA,MAC7D,MAAM,cAAc,MAAM;AAAA,MAC1B,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,IAAY,SAAwD;AAC5E,WAAO,KAAK,KAAK,QAA6B,OAAO,GAAG,QAAQ,IAAI,EAAE,IAAI;AAAA,MACxE,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;;;ADjCO,IAAM,iBAAN,MAAqB;AAAA,EACV;AAAA,EAEhB,YAAY,UAAyB,CAAC,GAAG;AACvC,UAAM,OAAO,iBAAiB,OAAO;AACrC,SAAK,cAAc,IAAI,YAAY,IAAI;AAAA,EACzC;AACF;;;AEPA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;","names":[]}
+{"version":3,"sources":["../src/client.ts","../src/resources/text-to-image.ts","../src/resources/edit-image.ts","../src/index.ts"],"sourcesContent":["import { createHttpClient, type ClientOptions } from '@runapi.ai/core';\nimport { TextToImage } from './resources/text-to-image';\nimport { EditImage } from './resources/edit-image';\n\nexport class SeedreamClient {\n  public readonly textToImage: TextToImage;\n  public readonly editImage: EditImage;\n\n  constructor(options: ClientOptions = {}) {\n    const http = createHttpClient(options);\n    this.textToImage = new TextToImage(http);\n    this.editImage = new EditImage(http);\n  }\n}\n","import type { HttpClient, RequestOptions, PollingOptions } from '@runapi.ai/core';\nimport { compactParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport type {\n  CompletedTextToImageResponse,\n  TextToImageParams,\n  TextToImageResponse,\n  TaskCreateResponse,\n} from '../types';\n\nconst ENDPOINT = '/api/v1/seedream/text_to_image';\n\nexport class TextToImage {\n  constructor(private readonly http: HttpClient) {}\n\n  async run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<CompletedTextToImageResponse> {\n    const { id } = await this.create(params, options);\n    const response = await pollUntilComplete<TextToImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\n    return response as CompletedTextToImageResponse;\n  }\n\n  async create(params: TextToImageParams, options?: RequestOptions): Promise<TaskCreateResponse> {\n    return this.http.request<TaskCreateResponse>('POST', ENDPOINT, {\n      body: compactParams(params),\n      ...options,\n    });\n  }\n\n  async get(id: string, options?: RequestOptions): Promise<TextToImageResponse> {\n    return this.http.request<TextToImageResponse>('GET', `${ENDPOINT}/${id}`, {\n      ...options,\n    });\n  }\n}\n","import type { HttpClient, RequestOptions, PollingOptions } from '@runapi.ai/core';\nimport { compactParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport type {\n  CompletedEditImageResponse,\n  EditImageParams,\n  EditImageResponse,\n  TaskCreateResponse,\n} from '../types';\n\nconst ENDPOINT = '/api/v1/seedream/edit_image';\n\nexport class EditImage {\n  constructor(private readonly http: HttpClient) {}\n\n  async run(params: EditImageParams, options?: RequestOptions & PollingOptions): Promise<CompletedEditImageResponse> {\n    const { id } = await this.create(params, options);\n    const response = await pollUntilComplete<EditImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\n    return response as CompletedEditImageResponse;\n  }\n\n  async create(params: EditImageParams, options?: RequestOptions): Promise<TaskCreateResponse> {\n    return this.http.request<TaskCreateResponse>('POST', ENDPOINT, {\n      body: compactParams(params),\n      ...options,\n    });\n  }\n\n  async get(id: string, options?: RequestOptions): Promise<EditImageResponse> {\n    return this.http.request<EditImageResponse>('GET', `${ENDPOINT}/${id}`, {\n      ...options,\n    });\n  }\n}\n","export { SeedreamClient } from './client';\nexport * from './types';\n\nexport {\n  RunApiError,\n  AuthenticationError,\n  InsufficientCreditsError,\n  NotFoundError,\n  ValidationError,\n  RateLimitError,\n  ServiceUnavailableError,\n  NetworkError,\n  TimeoutError,\n  TaskTimeoutError,\n  TaskFailedError,\n} from '@runapi.ai/core';\n"],"mappings":";AAAA,SAAS,wBAA4C;;;ACCrD,SAAS,qBAAqB;AAC9B,SAAS,yBAAyB;AAQlC,IAAM,WAAW;AAEV,IAAM,cAAN,MAAkB;AAAA,EACvB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA,EAE7B,MAAM,IAAI,QAA2B,SAAkF;AACrH,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,UAAM,WAAW,MAAM,kBAAuC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACzF,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,OAAO,QAA2B,SAAuD;AAC7F,WAAO,KAAK,KAAK,QAA4B,QAAQ,UAAU;AAAA,MAC7D,MAAM,cAAc,MAAM;AAAA,MAC1B,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,IAAY,SAAwD;AAC5E,WAAO,KAAK,KAAK,QAA6B,OAAO,GAAG,QAAQ,IAAI,EAAE,IAAI;AAAA,MACxE,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;;;ACnCA,SAAS,iBAAAA,sBAAqB;AAC9B,SAAS,qBAAAC,0BAAyB;AAQlC,IAAMC,YAAW;AAEV,IAAM,YAAN,MAAgB;AAAA,EACrB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA,EAE7B,MAAM,IAAI,QAAyB,SAAgF;AACjH,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,UAAM,WAAW,MAAMD,mBAAqC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACvF,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AACD,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,OAAO,QAAyB,SAAuD;AAC3F,WAAO,KAAK,KAAK,QAA4B,QAAQC,WAAU;AAAA,MAC7D,MAAMF,eAAc,MAAM;AAAA,MAC1B,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,IAAY,SAAsD;AAC1E,WAAO,KAAK,KAAK,QAA2B,OAAO,GAAGE,SAAQ,IAAI,EAAE,IAAI;AAAA,MACtE,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;;;AFhCO,IAAM,iBAAN,MAAqB;AAAA,EACV;AAAA,EACA;AAAA,EAEhB,YAAY,UAAyB,CAAC,GAAG;AACvC,UAAM,OAAO,iBAAiB,OAAO;AACrC,SAAK,cAAc,IAAI,YAAY,IAAI;AACvC,SAAK,YAAY,IAAI,UAAU,IAAI;AAAA,EACrC;AACF;;;AGVA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;","names":["compactParams","pollUntilComplete","ENDPOINT"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runapi.ai/seedream",
-  "version": "0.2.1",
+  "version": "0.2.6",
   "description": "RunAPI Seedream SDK for JavaScript, Ruby, and Go",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -28,7 +28,7 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@runapi.ai/core": "^0.2.1"
+    "@runapi.ai/core": "^0.2.5"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",

package/skills/seedream/README.md

@@ -1,6 +1,27 @@
-# Seedream API Skill for RunAPI
+<p align="center">
+  <a href="https://github.com/runapi-ai/seedream">
+    <h3 align="center">Seedream API Skill for RunAPI</h3>
+  </a>
+</p>
 
-Generate and edit images with Seedream 4.5 and 5-lite text-to-image, image-to-image, and image editing. This skill helps Claude Code, Codex, Gemini CLI, Cursor, and 50+ agents integrate Seedream through RunAPI.
+<p align="center">
+  Install this agent skill, inspect Seedream fields, then run jobs through the RunAPI CLI.
+</p>
+
+<p align="center">
+  <a href="https://runapi.ai/models/seedream"><strong>Model Reference</strong></a> · <a href="https://github.com/runapi-ai/cli"><strong>CLI</strong></a> · <a href="https://github.com/runapi-ai/seedream-sdk"><strong>SDK</strong></a>
+</p>
+
+<div align="center">
+
+[![skills.sh](https://www.skills.sh/b/runapi-ai/seedream)](https://www.skills.sh/runapi-ai/seedream/seedream)
+[![ClawHub](https://img.shields.io/badge/ClawHub-runapi--seedream-111827)](https://clawhub.ai/runapi-ai/runapi-seedream)
+[![License](https://img.shields.io/github/license/runapi-ai/seedream)](https://github.com/runapi-ai/seedream/blob/main/LICENSE)
+
+</div>
+<br/>
+
+Generate and edit images with Seedream v4, 4.5, and 5-lite text-to-image and image editing. This skill helps Claude Code, Codex, Gemini CLI, Cursor, and 50+ agents integrate Seedream through RunAPI.
 
 The canonical agent file is `skills/seedream/SKILL.md`.
 
@@ -10,7 +31,18 @@ The canonical agent file is `skills/seedream/SKILL.md`.
 npx skills add runapi-ai/seedream -g
 ```
 
-Or manually: clone this repo and copy `skills/seedream/` into your agent's skills directory.
+Or paste this prompt to your AI agent:
+
+```text
+Install the seedream skill for me:
+
+1. Clone https://github.com/runapi-ai/seedream
+2. Copy the skills/seedream/ directory into your
+   user-level skills directory (e.g. ~/.claude/skills/
+   for Claude Code, ~/.codex/skills/ for Codex).
+3. Verify that SKILL.md is present.
+4. Confirm the install path when done.
+```
 
 ## Quick example
 
@@ -19,9 +51,11 @@ import { SeedreamClient } from '@runapi.ai/seedream';
 
 const client = new SeedreamClient();
 const result = await client.textToImage.run({
-  model: 'seedream-4.5-text-to-image',
-  prompt: 'A cinematic portrait of a traveler in the rain',
+  model: 'seedream-v4-text-to-image',
+  prompt: 'A precise product render of a glass teapot on white marble',
   aspect_ratio: '16:9',
+  output_resolution: '2k',
+  output_count: 3,
 });
 const url = result.images[0].url;
 ```
@@ -33,7 +67,6 @@ const url = result.images[0].url;
 - SDK docs: https://runapi.ai/docs#sdk-seedream
 - SDK repository: https://github.com/runapi-ai/seedream-sdk
 - Pricing and rate limits: https://runapi.ai/models/seedream/4.5-text-to-image
-- Provider comparison: https://runapi.ai/providers/bytedance
 - Browse all RunAPI models and skills: https://runapi.ai/models
 
 ## Variants
@@ -41,7 +74,9 @@ const url = result.images[0].url;
 - [4.5 text to image](https://runapi.ai/models/seedream/4.5-text-to-image)
 - [4.5 edit](https://runapi.ai/models/seedream/4.5-edit)
 - [5 lite text to image](https://runapi.ai/models/seedream/5-lite-text-to-image)
-- [5 lite image to image](https://runapi.ai/models/seedream/5-lite-image-to-image)
+- [5 lite edit](https://runapi.ai/models/seedream/5-lite-edit)
+- [v4 text to image](https://runapi.ai/models/seedream/v4-text-to-image)
+- [v4 edit](https://runapi.ai/models/seedream/v4-edit)
 
 ## Agent rules
 

package/skills/seedream/SKILL.md

@@ -1,202 +1,104 @@
 ---
 name: seedream
-description: Generate and edit images (Seedream 4.5 text-to-image / edit, Seedream 5-lite text/image-to-image) through RunAPI.ai using the @runapi.ai/seedream Node/TypeScript SDK. Use when the user asks to add Seedream image generation, or writes against @runapi.ai/seedream. Triggers on "seedream", "即梦", "image generation", "生成图片", "@runapi.ai/seedream".
-documentation: https://runapi.ai/models/seedream
-provider_page: https://runapi.ai/providers/bytedance
-catalog: https://runapi.ai/models
+description: Generate and edit images with Seedream through RunAPI. Use when the user asks an agent to create, edit, or transform images with Seedream. Default to the RunAPI CLI for one-off generation; use SDKs only when the user is integrating RunAPI into an app or backend.
+documentation: https://runapi.ai/models/seedream.md
+provider_page: https://runapi.ai/providers/bytedance.md
+catalog: https://runapi.ai/models.md
+metadata:
+  openclaw:
+    homepage: https://runapi.ai/models/seedream
+    requires:
+      bins:
+      - runapi
+    install:
+    - kind: brew
+      formula: runapi-ai/tap/runapi
+      bins:
+      - runapi
+    envVars:
+    - name: RUNAPI_API_KEY
+      required: false
+      description: Optional RunAPI API key; agents should prefer environment auth or saved CLI config. Browser login is interactive fallback only.
 ---
-# @runapi.ai/seedream — RunAPI.ai Seedream image generation
 
-Build Node / TypeScript integrations that generate and edit images through RunAPI.ai.
+# Seedream on RunAPI
 
-## Setup
+Generate and edit images with Seedream through RunAPI. The default path for one-off agent tasks is the `runapi` CLI; SDKs are for application integration.
 
-Requires **Node 18+** (global `fetch`).
+## Routing decision
 
-```bash
-npm install @runapi.ai/seedream
-```
-
-Set your API key in the environment:
-
-```dotenv
-# .env
-RUNAPI_API_KEY=runapi_xxx   # get one at https://runapi.ai/settings/api_keys
-```
-
-```ts
-import { SeedreamClient } from '@runapi.ai/seedream';
-
-// The SDK reads RUNAPI_API_KEY from the environment automatically.
-const client = new SeedreamClient();
-```
-
-Pass `{ apiKey }` explicitly if you manage secrets differently. `baseUrl` defaults to `https://runapi.ai`; override only for local development.
-
-## Core recipe — text to image
-
-```ts
-const result = await client.textToImage.run({
-  model: 'seedream-4.5-text-to-image',
-  prompt: 'A cinematic portrait of a traveler in the rain',
-  aspect_ratio: '16:9',
-  quality: 'basic',
-});
-
-const url = result.images[0].url;
-```
-
-`run()` creates the task, auto-polls, and resolves only when the task completes — `images[0].url` is guaranteed on the resolved value. On failure it throws `TaskFailedError`; on polling timeout it throws `TaskTimeoutError`. Use `run()` for scripts and short-lived processes. For request handlers, split it:
-
-```ts
-const { id } = await client.textToImage.create({
-  model: 'seedream-4.5-text-to-image',
-  prompt: '...',
-  aspect_ratio: '1:1',
-  quality: 'basic',
-});
-// return 202 immediately; fetch later:
-const status = await client.textToImage.get(id);
-if (status.status === 'completed') { /* ... */ }
-```
+- One-off generation, editing, or transformation for the user → use the **CLI path** with the `runapi` binary.
+- Building an app, backend, worker, library, or production codebase → use the **SDK integration path**.
 
-Do not hold a web worker open waiting on `run()`. Split + webhook is the production pattern.
+## CLI path
 
-`run()` polls every 2 s for up to 15 min by default. Tune when needed:
+The `runapi` binary is the runtime dependency. Run `runapi auth status` first. For agents and headless runs, prefer `RUNAPI_API_KEY` or import it into saved config with `printf '%s' "$RUNAPI_API_KEY" | runapi auth import-token --token -`. Use `runapi login` only when the user explicitly wants interactive browser auth.
 
-```ts
-await client.textToImage.run(params, { maxWaitMs: 5 * 60_000, pollIntervalMs: 2_000 });
-```
+Inspect the available commands and request fields with CLI help:
 
-If `TaskTimeoutError` fires, the task is still running server-side — resume with `textToImage.get(id)` or finish via webhook.
-
-## Edit and image-to-image
-
-Provide one or more `image_urls` with the matching model:
-
-```ts
-// 4.5 edit — in-place editImage guided by a prompt
-await client.textToImage.run({
-  model: 'seedream-4.5-edit',
-  prompt: 'Change the background to a sunset beach',
-  image_urls: ['https://cdn.example.com/source.jpg'],
-  aspect_ratio: '16:9',
-  quality: 'high',
-});
-
-// 5-lite image-to-image — style/content transfer from a reference
-await client.textToImage.run({
-  model: 'seedream-5-lite-image-to-image',
-  prompt: 'In the style of a traditional ink painting',
-  image_urls: ['https://cdn.example.com/portrait.jpg'],
-  aspect_ratio: '3:4',
-  quality: 'basic',
-});
+```shell
+runapi seedream --help
+runapi seedream text-to-image --help
+runapi seedream edit-image --help
 ```
 
-## Models
-
-| `model` | Use case |
-|---|---|
-| `seedream-4.5-text-to-image` | High-quality text-to-image. |
-| `seedream-4.5-edit` | Prompt-guided editImage on one or more source images. |
-| `seedream-5-lite-text-to-image` | Faster, cheaper text-to-image. |
-| `seedream-5-lite-image-to-image` | Faster image-to-image transfer. |
-
-`aspect_ratio` values: `1:1`, `4:3`, `3:4`, `16:9`, `9:16`, `2:3`, `3:2`, `21:9`. `quality`: `basic` or `high`.
+Run a one-off task (synchronous — polls until the task completes):
 
-Exact credit costs per model are shown at https://runapi.ai/pricing and in the dashboard — do not hardcode prices in application code.
-
-## Callbacks (webhooks)
-
-Pass `callback_url` on `create()` (or any `run()` call) and RunAPI will POST the final payload to you:
-
-```ts
-await client.textToImage.create({
-  model: 'seedream-4.5-text-to-image',
-  prompt: '...',
-  aspect_ratio: '1:1',
-  quality: 'basic',
-  callback_url: 'https://your.app/webhooks/runapi/seedream',
-});
+```shell
+runapi seedream text-to-image --input-file request.json
+runapi seedream edit-image --input-file request.json
 ```
 
-Payload shape:
+Submit asynchronously and poll separately:
 
-```ts
-{ id: string; status: 'completed' | 'failed'; images?: { url: string }[]; error?: string }
+```shell
+runapi seedream text-to-image --async --input-file request.json
+runapi seedream edit-image --async --input-file request.json
+runapi wait <task-id> --service seedream --action text-to-image
 ```
 
-**Always verify the signature before trusting the body.** RunAPI signs every callback with your account's Callback Secret (rotate at `/accounts/callback_secret`). Headers:
+Available commands: `text-to-image`, `edit-image`.
 
-- `X-Callback-Id` — UUID, store to make handler idempotent
-- `X-Callback-Timestamp` — unix seconds, reject if `|now - ts| > 300`
-- `X-Callback-Signature` — base64 HMAC-SHA256 over `` `${id}.${ts}.${rawBody}` `` using the base64-decoded secret
+Common request shapes:
 
-```ts
-import crypto from 'node:crypto';
-
-function verify(raw: string, id: string, ts: string, sig: string, secret: string) {
-  const key = Buffer.from(secret, 'base64');
-  const mac = crypto.createHmac('sha256', key)
-    .update(`${id}.${ts}.${raw}`)
-    .digest('base64');
-  return crypto.timingSafeEqual(Buffer.from(mac), Buffer.from(sig));
+```json
+{
+  "model": "seedream-v4-text-to-image",
+  "prompt": "A precise product render of a glass teapot on white marble",
+  "aspect_ratio": "16:9",
+  "output_resolution": "2k",
+  "output_count": 3
 }
 ```
 
-Reply `2xx` within 10s; any non-2xx triggers retries.
-
-## Errors
-
-All errors are re-exported from `@runapi.ai/core`. Always `instanceof` — never string-match messages.
-
-| Error | Status | Action |
-|---|---|---|
-| `AuthenticationError` | 401 | abort; surface "reconnect your API key" |
-| `InsufficientCreditsError` | 402 | prompt user to top up at runapi.ai/billing |
-| `ValidationError` | 400 / 422 | fix params; do not retry |
-| `RateLimitError` | 429 | sleep `err.retryAfterMs`, then retry |
-| `ServiceUnavailableError` | 503 / 455 | retry with backoff; transient service issue |
-| `TaskFailedError` | — | show `err.details` to user; do not auto-retry |
-| `TaskTimeoutError` | — | re-poll with `textToImage.get(id)` |
-
-```ts
-import { InsufficientCreditsError, TaskFailedError } from '@runapi.ai/seedream';
-
-try {
-  await client.textToImage.run({
-    model: 'seedream-4.5-text-to-image',
-    prompt: '...',
-    aspect_ratio: '1:1',
-    quality: 'basic',
-  });
-} catch (err) {
-  if (err instanceof InsufficientCreditsError) { /* surface top-up CTA */ }
-  else if (err instanceof TaskFailedError)       { /* show err.details */ }
-  else throw err;
+```json
+{
+  "model": "seedream-v4-edit",
+  "prompt": "Place the logo on a blue outdoor cap",
+  "source_image_urls": ["https://cdn.runapi.ai/public/samples/image.jpg"],
+  "aspect_ratio": "1:1",
+  "output_resolution": "4k"
 }
 ```
 
-## Gotchas
-
-- `model`, `prompt`, `aspect_ratio`, and `quality` are all required. `aspect_ratio` is not optional even for square output.
-- Edit and image-to-image models require `image_urls` (an array, even for a single image).
-- `nsfw_checker` only applies to `seedream-5-lite-*` models.
-- `callback_url` must be reachable from the public internet. `localhost` / `127.0.0.1` URLs will never fire — use a tunnel (cloudflared, ngrok, tailscale funnel) when developing locally.
+## SDK integration path
 
-## Dig deeper
+When integrating Seedream into an app, backend, worker, or library — not for one-off tasks — use a RunAPI SDK package:
 
-Package README (full API surface, all params): `node_modules/@runapi.ai/seedream/README.md`. Types: `@runapi.ai/seedream/dist/types.d.ts`. Product docs: https://runapi.ai/docs.
+- JavaScript / TypeScript: `@runapi.ai/seedream`
+- Ruby: `runapi-seedream`
+- Go: `github.com/runapi-ai/seedream-sdk/go`
 
-## RunAPI public routing
+## References
 
-seedream api public links use the API-379 catalog route map. The main seedream api page is https://runapi.ai/models/seedream. SDK docs live at https://runapi.ai/docs#sdk-seedream and product docs live at https://runapi.ai/docs#seedream.
+- Model overview, pricing, and rate limits: https://runapi.ai/models/seedream.md
+- Full model catalog: https://runapi.ai/models.md
 
-Pricing, rate limits, and commercial usage for seedream api should point to the most specific variant page:
-- [4.5 text to image](https://runapi.ai/models/seedream/4.5-text-to-image)
-- [4.5 edit](https://runapi.ai/models/seedream/4.5-edit)
-- [5 lite text to image](https://runapi.ai/models/seedream/5-lite-text-to-image)
-- [5 lite image to image](https://runapi.ai/models/seedream/5-lite-image-to-image)
+## Variants
 
-Compare Seedream with other Bytedance models at https://runapi.ai/providers/bytedance. Browse every RunAPI model and skill at https://runapi.ai/models. SDK repository: https://github.com/runapi-ai/seedream-sdk. Skill repository: https://github.com/runapi-ai/seedream.
+- [4.5 text to image](https://runapi.ai/models/seedream/4.5-text-to-image.md)
+- [4.5 edit](https://runapi.ai/models/seedream/4.5-edit.md)
+- [5 lite text to image](https://runapi.ai/models/seedream/5-lite-text-to-image.md)
+- [5 lite edit](https://runapi.ai/models/seedream/5-lite-edit.md)
+- [v4 text to image](https://runapi.ai/models/seedream/v4-text-to-image.md)
+- [v4 edit](https://runapi.ai/models/seedream/v4-edit.md)