@runapi.ai/gpt-4o-image 0.2.5 → 0.2.7

package/README.md

@@ -1,32 +1,34 @@
-# GPT-4o Image API JavaScript SDK for RunAPI
+# GPT-4o Image JavaScript SDK for RunAPI
 
-The gpt-4o image api JavaScript SDK is the language-specific package for GPT-4o Image on RunAPI. Use this gpt-4o image 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.
+The GPT-4o Image JavaScript SDK is the language-specific package for GPT-4o Image on RunAPI. Use this package for image generation, image editing, and creative production workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in JavaScript.
 
-This gpt-4o image api README is the JavaScript package guide inside the public `gpt4o-image-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/gpt-4o-image; for API reference, use https://runapi.ai/docs#gpt-4o-image; for SDK docs, use https://runapi.ai/docs#sdk-gpt-4o-image.
+This README is the JavaScript package guide inside the public `gpt-4o-image-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/gpt-4o-image; for API reference, use https://runapi.ai/docs#gpt-4o-image; for SDK docs, use https://runapi.ai/docs#sdk-gpt-4o-image.
 
 ## Install
 
 ```bash
-npm install @runapi.ai/gpt4o-image
+npm install @runapi.ai/gpt-4o-image
 ```
 
 ## Quick start
 
 ```typescript
-import { Gpt4oImageClient } from '@runapi.ai/gpt4o-image';
+import { Gpt4oImageClient } from '@runapi.ai/gpt-4o-image';
 
 const client = new Gpt4oImageClient();
-const task = await client.generations.create({
+const task = await client.textToImage.create({
   // Pass the GPT-4o Image JSON request body from https://runapi.ai/docs#gpt-4o-image.
 });
-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.
 
+RunAPI-generated file URLs are temporary. Download and store generated images, videos, audio, or other files in your own durable storage within 7 days; do not treat returned URLs as long-term assets.
+
 ## 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 available resources are `textToImage`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 

package/dist/index.d.mts

@@ -1,23 +1,39 @@
-import { AsyncTaskStatus, HttpClient, RequestOptions, PollingOptions, ClientOptions } from '@runapi.ai/core';
+import { AsyncTaskStatus, HttpClient, RequestOptions, PollingOptions, BaseClient, ClientOptions } from '@runapi.ai/core';
 export { AuthenticationError, InsufficientCreditsError, NetworkError, NotFoundError, RateLimitError, RunApiError, ServiceUnavailableError, TaskFailedError, TaskTimeoutError, TimeoutError, ValidationError } from '@runapi.ai/core';
 
 type Gpt4oImageModel = 'gpt-4o-image';
+/** Required output aspect ratio. */
 type AspectRatio = '1:1' | '3:2' | '2:3';
+/** Batch output size: 1, 2, or 4 images per request. */
 type OutputCount = 1 | 2 | 4;
+/**
+ * Parameters for GPT-4o image generation and editing.
+ *
+ * - For pure generation, provide `prompt` (required) and `aspect_ratio`.
+ * - For editing, provide `source_image_urls` (up to 5); `prompt` becomes
+ *   optional since the model can generate variants without one.
+ * - For inpainting, also provide `mask_url` to indicate which regions of
+ *   the source image to regenerate.
+ */
 interface TextToImageParams {
     model: Gpt4oImageModel;
+    /** Text prompt; required when source_image_urls is not provided. */
     prompt?: string;
     aspect_ratio: AspectRatio;
+    /** Up to 5 source image URLs for edits or variants. */
     source_image_urls?: string[];
+    /** Mask image URL marking regions to regenerate (inpainting); only meaningful with source_image_urls. */
     mask_url?: string;
     output_count?: OutputCount;
     callback_url?: string;
+    /** Let the model expand short prompts with additional detail. */
     enable_prompt_expansion?: boolean;
 }
 interface TaskCreateResponse {
     id: string;
     status: string;
 }
+/** A generated image with its CDN URL. */
 interface Image {
     url: string;
 }
@@ -25,23 +41,72 @@ interface TextToImageResponse {
     id: string;
     status: AsyncTaskStatus;
     images?: Image[];
+    /** Intermediate status string while the task is running. */
     progress?: string;
     error?: string;
     [key: string]: unknown;
 }
 
+/**
+ * Generates images from a text prompt, optionally guided by source images and a mask.
+ * For pure generation, provide a prompt. For editing, provide source_image_urls
+ * (and optionally mask_url) to modify specific regions of the source.
+ */
 declare class TextToImage {
     private readonly http;
     constructor(http: HttpClient);
+    /**
+     * Generate an image and wait until complete.
+     * @param params Text-to-image parameters.
+     * @param options Per-request and polling overrides.
+     * @returns The completed text-to-image result.
+     */
     run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<TextToImageResponse>;
+    /**
+     * Create a text-to-image task; returns immediately with a task id.
+     * @param params Text-to-image parameters.
+     * @param options Per-request overrides.
+     * @returns The task creation result with id.
+     */
     create(params: TextToImageParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    /**
+     * Fetch the current status of a text-to-image task.
+     * @param id The task id.
+     * @param options Per-request overrides.
+     * @returns The current text-to-image status.
+     */
     get(id: string, options?: RequestOptions): Promise<TextToImageResponse>;
 }
 
 /**
- * GPT-4o Image text-to-image API client.
+ * GPT-4o Image generation and editing API client.
+ *
+ * Supports pure text-to-image generation, image editing with source images,
+ * and inpainting with an optional mask. At least one of `prompt` or
+ * `source_image_urls` must be provided.
+ *
+ * @example
+ * ```typescript
+ * const client = new Gpt4oImageClient({ apiKey: 'your-api-key' });
+ *
+ * // Pure generation
+ * const result = await client.textToImage.run({
+ *   model: 'gpt-4o-image',
+ *   prompt: 'A watercolor painting of a sunset',
+ *   aspect_ratio: '3:2',
+ * });
+ *
+ * // Edit with source images
+ * const edited = await client.textToImage.run({
+ *   model: 'gpt-4o-image',
+ *   prompt: 'Add a rainbow',
+ *   aspect_ratio: '3:2',
+ *   source_image_urls: ['https://cdn.runapi.ai/public/samples/image.jpg'],
+ * });
+ * ```
  */
-declare class Gpt4oImageClient {
+declare class Gpt4oImageClient extends BaseClient {
+    /** Image generation, editing, and inpainting operations. */
     readonly textToImage: TextToImage;
     constructor(options?: ClientOptions);
 }

package/dist/index.d.ts

@@ -1,23 +1,39 @@
-import { AsyncTaskStatus, HttpClient, RequestOptions, PollingOptions, ClientOptions } from '@runapi.ai/core';
+import { AsyncTaskStatus, HttpClient, RequestOptions, PollingOptions, BaseClient, ClientOptions } from '@runapi.ai/core';
 export { AuthenticationError, InsufficientCreditsError, NetworkError, NotFoundError, RateLimitError, RunApiError, ServiceUnavailableError, TaskFailedError, TaskTimeoutError, TimeoutError, ValidationError } from '@runapi.ai/core';
 
 type Gpt4oImageModel = 'gpt-4o-image';
+/** Required output aspect ratio. */
 type AspectRatio = '1:1' | '3:2' | '2:3';
+/** Batch output size: 1, 2, or 4 images per request. */
 type OutputCount = 1 | 2 | 4;
+/**
+ * Parameters for GPT-4o image generation and editing.
+ *
+ * - For pure generation, provide `prompt` (required) and `aspect_ratio`.
+ * - For editing, provide `source_image_urls` (up to 5); `prompt` becomes
+ *   optional since the model can generate variants without one.
+ * - For inpainting, also provide `mask_url` to indicate which regions of
+ *   the source image to regenerate.
+ */
 interface TextToImageParams {
     model: Gpt4oImageModel;
+    /** Text prompt; required when source_image_urls is not provided. */
     prompt?: string;
     aspect_ratio: AspectRatio;
+    /** Up to 5 source image URLs for edits or variants. */
     source_image_urls?: string[];
+    /** Mask image URL marking regions to regenerate (inpainting); only meaningful with source_image_urls. */
     mask_url?: string;
     output_count?: OutputCount;
     callback_url?: string;
+    /** Let the model expand short prompts with additional detail. */
     enable_prompt_expansion?: boolean;
 }
 interface TaskCreateResponse {
     id: string;
     status: string;
 }
+/** A generated image with its CDN URL. */
 interface Image {
     url: string;
 }
@@ -25,23 +41,72 @@ interface TextToImageResponse {
     id: string;
     status: AsyncTaskStatus;
     images?: Image[];
+    /** Intermediate status string while the task is running. */
     progress?: string;
     error?: string;
     [key: string]: unknown;
 }
 
+/**
+ * Generates images from a text prompt, optionally guided by source images and a mask.
+ * For pure generation, provide a prompt. For editing, provide source_image_urls
+ * (and optionally mask_url) to modify specific regions of the source.
+ */
 declare class TextToImage {
     private readonly http;
     constructor(http: HttpClient);
+    /**
+     * Generate an image and wait until complete.
+     * @param params Text-to-image parameters.
+     * @param options Per-request and polling overrides.
+     * @returns The completed text-to-image result.
+     */
     run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<TextToImageResponse>;
+    /**
+     * Create a text-to-image task; returns immediately with a task id.
+     * @param params Text-to-image parameters.
+     * @param options Per-request overrides.
+     * @returns The task creation result with id.
+     */
     create(params: TextToImageParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    /**
+     * Fetch the current status of a text-to-image task.
+     * @param id The task id.
+     * @param options Per-request overrides.
+     * @returns The current text-to-image status.
+     */
     get(id: string, options?: RequestOptions): Promise<TextToImageResponse>;
 }
 
 /**
- * GPT-4o Image text-to-image API client.
+ * GPT-4o Image generation and editing API client.
+ *
+ * Supports pure text-to-image generation, image editing with source images,
+ * and inpainting with an optional mask. At least one of `prompt` or
+ * `source_image_urls` must be provided.
+ *
+ * @example
+ * ```typescript
+ * const client = new Gpt4oImageClient({ apiKey: 'your-api-key' });
+ *
+ * // Pure generation
+ * const result = await client.textToImage.run({
+ *   model: 'gpt-4o-image',
+ *   prompt: 'A watercolor painting of a sunset',
+ *   aspect_ratio: '3:2',
+ * });
+ *
+ * // Edit with source images
+ * const edited = await client.textToImage.run({
+ *   model: 'gpt-4o-image',
+ *   prompt: 'Add a rainbow',
+ *   aspect_ratio: '3:2',
+ *   source_image_urls: ['https://cdn.runapi.ai/public/samples/image.jpg'],
+ * });
+ * ```
  */
-declare class Gpt4oImageClient {
+declare class Gpt4oImageClient extends BaseClient {
+    /** Image generation, editing, and inpainting operations. */
     readonly textToImage: TextToImage;
     constructor(options?: ClientOptions);
 }

package/dist/index.js

@@ -41,12 +41,49 @@ var import_core2 = require("@runapi.ai/core");
 // src/resources/text-to-image.ts
 var import_core = require("@runapi.ai/core");
 var import_internal = require("@runapi.ai/core/internal");
+
+// src/contract_gen.ts
+var contract = {
+  "text-to-image": {
+    "models": [
+      "gpt-4o-image"
+    ],
+    "fields_by_model": {
+      "gpt-4o-image": {
+        "aspect_ratio": {
+          "enum": [
+            "1:1",
+            "3:2",
+            "2:3"
+          ],
+          "required": true
+        },
+        "output_count": {
+          "enum": [
+            1,
+            2,
+            4
+          ],
+          "type": "integer"
+        }
+      }
+    }
+  }
+};
+
+// src/resources/text-to-image.ts
 var ENDPOINT = "/api/v1/gpt_4o_image/text_to_image";
 var TextToImage = class {
   constructor(http) {
     this.http = http;
   }
   http;
+  /**
+   * Generate an image and wait until complete.
+   * @param params Text-to-image parameters.
+   * @param options Per-request and polling overrides.
+   * @returns The completed text-to-image result.
+   */
   async run(params, options) {
     const { id } = await this.create(params, options);
     return (0, import_internal.pollUntilComplete)(() => this.get(id, options), {
@@ -54,12 +91,26 @@ var TextToImage = class {
       pollIntervalMs: options?.pollIntervalMs
     });
   }
+  /**
+   * Create a text-to-image task; returns immediately with a task id.
+   * @param params Text-to-image parameters.
+   * @param options Per-request overrides.
+   * @returns The task creation result with id.
+   */
   async create(params, options) {
+    const body = (0, import_core.compactParams)(params);
+    (0, import_core.validateParams)(contract["text-to-image"], body);
     return this.http.request("POST", ENDPOINT, {
-      body: (0, import_core.compactParams)(params),
+      body,
       ...options
     });
   }
+  /**
+   * Fetch the current status of a text-to-image task.
+   * @param id The task id.
+   * @param options Per-request overrides.
+   * @returns The current text-to-image status.
+   */
   async get(id, options) {
     return this.http.request("GET", `${ENDPOINT}/${id}`, {
       ...options
@@ -68,11 +119,12 @@ var TextToImage = class {
 };
 
 // src/client.ts
-var Gpt4oImageClient = class {
+var Gpt4oImageClient = class extends import_core2.BaseClient {
+  /** Image generation, editing, and inpainting operations. */
   textToImage;
   constructor(options = {}) {
-    const http = (0, import_core2.createHttpClient)(options);
-    this.textToImage = new TextToImage(http);
+    super(options);
+    this.textToImage = new TextToImage(this.http);
   }
 };
 

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/client.ts","../src/resources/text-to-image.ts"],"sourcesContent":["export { Gpt4oImageClient } from './client';\nexport * from './types';\n\n// Re-export core errors for convenience\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\n/**\n * GPT-4o Image text-to-image API client.\n */\nexport class Gpt4oImageClient {\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, PollingOptions, RequestOptions } from '@runapi.ai/core';\nimport { compactParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport type { TextToImageParams, TextToImageResponse, TaskCreateResponse } from '../types';\n\nconst ENDPOINT = '/api/v1/gpt_4o_image/text_to_image';\n\nexport class TextToImage {\n  constructor(private readonly http: HttpClient) {}\n\n  async run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<TextToImageResponse> {\n    const { id } = await this.create(params, options);\n    return pollUntilComplete<TextToImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\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;AAGlC,IAAM,WAAW;AAEV,IAAM,cAAN,MAAkB;AAAA,EACvB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA,EAE7B,MAAM,IAAI,QAA2B,SAAyE;AAC5G,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,eAAO,mCAAuC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACzE,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AAAA,EACH;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;;;ADxBO,IAAM,mBAAN,MAAuB;AAAA,EACZ;AAAA,EAEhB,YAAY,UAAyB,CAAC,GAAG;AACvC,UAAM,WAAO,+BAAiB,OAAO;AACrC,SAAK,cAAc,IAAI,YAAY,IAAI;AAAA,EACzC;AACF;;;ADTA,IAAAC,eAYO;","names":["import_core","import_core"]}
+{"version":3,"sources":["../src/index.ts","../src/client.ts","../src/resources/text-to-image.ts","../src/contract_gen.ts"],"sourcesContent":["export { Gpt4oImageClient } from './client';\nexport * from './types';\n\n// Re-export core errors for convenience\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 { BaseClient, type ClientOptions } from '@runapi.ai/core';\nimport { TextToImage } from './resources/text-to-image';\n\n/**\n * GPT-4o Image generation and editing API client.\n *\n * Supports pure text-to-image generation, image editing with source images,\n * and inpainting with an optional mask. At least one of `prompt` or\n * `source_image_urls` must be provided.\n *\n * @example\n * ```typescript\n * const client = new Gpt4oImageClient({ apiKey: 'your-api-key' });\n *\n * // Pure generation\n * const result = await client.textToImage.run({\n *   model: 'gpt-4o-image',\n *   prompt: 'A watercolor painting of a sunset',\n *   aspect_ratio: '3:2',\n * });\n *\n * // Edit with source images\n * const edited = await client.textToImage.run({\n *   model: 'gpt-4o-image',\n *   prompt: 'Add a rainbow',\n *   aspect_ratio: '3:2',\n *   source_image_urls: ['https://cdn.runapi.ai/public/samples/image.jpg'],\n * });\n * ```\n */\nexport class Gpt4oImageClient extends BaseClient {\n  /** Image generation, editing, and inpainting operations. */\n  public readonly textToImage: TextToImage;\n\n  constructor(options: ClientOptions = {}) {\n    super(options);\n    this.textToImage = new TextToImage(this.http);\n  }\n}\n","import type { HttpClient, PollingOptions, RequestOptions, ActionSchema } from '@runapi.ai/core';\nimport { compactParams, validateParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport { contract } from '../contract_gen';\nimport type { TextToImageParams, TextToImageResponse, TaskCreateResponse } from '../types';\n\nconst ENDPOINT = '/api/v1/gpt_4o_image/text_to_image';\n\n/**\n * Generates images from a text prompt, optionally guided by source images and a mask.\n * For pure generation, provide a prompt. For editing, provide source_image_urls\n * (and optionally mask_url) to modify specific regions of the source.\n */\nexport class TextToImage {\n  constructor(private readonly http: HttpClient) {}\n\n  /**\n   * Generate an image and wait until complete.\n   * @param params Text-to-image parameters.\n   * @param options Per-request and polling overrides.\n   * @returns The completed text-to-image result.\n   */\n  async run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<TextToImageResponse> {\n    const { id } = await this.create(params, options);\n    return pollUntilComplete<TextToImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\n  }\n\n  /**\n   * Create a text-to-image task; returns immediately with a task id.\n   * @param params Text-to-image parameters.\n   * @param options Per-request overrides.\n   * @returns The task creation result with id.\n   */\n  async create(params: TextToImageParams, options?: RequestOptions): Promise<TaskCreateResponse> {\n    const body = compactParams(params);\n    validateParams(contract['text-to-image'] as ActionSchema, body as Record<string, unknown>);\n    return this.http.request<TaskCreateResponse>('POST', ENDPOINT, {\n      body,\n      ...options,\n    });\n  }\n\n  /**\n   * Fetch the current status of a text-to-image task.\n   * @param id The task id.\n   * @param options Per-request overrides.\n   * @returns The current text-to-image status.\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 const contract = {\n  \"text-to-image\": {\n    \"models\": [\n      \"gpt-4o-image\"\n    ],\n    \"fields_by_model\": {\n      \"gpt-4o-image\": {\n        \"aspect_ratio\": {\n          \"enum\": [\n            \"1:1\",\n            \"3:2\",\n            \"2:3\"\n          ],\n          \"required\": true\n        },\n        \"output_count\": {\n          \"enum\": [\n            1,\n            2,\n            4\n          ],\n          \"type\": \"integer\"\n        }\n      }\n    }\n  }\n} as const;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,eAA+C;;;ACC/C,kBAA8C;AAC9C,sBAAkC;;;ACF3B,IAAM,WAAW;AAAA,EACtB,iBAAiB;AAAA,IACf,UAAU;AAAA,MACR;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB,gBAAgB;AAAA,QACd,gBAAgB;AAAA,UACd,QAAQ;AAAA,YACN;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,UACA,YAAY;AAAA,QACd;AAAA,QACA,gBAAgB;AAAA,UACd,QAAQ;AAAA,YACN;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,UACA,QAAQ;AAAA,QACV;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;;;ADpBA,IAAM,WAAW;AAOV,IAAM,cAAN,MAAkB;AAAA,EACvB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7B,MAAM,IAAI,QAA2B,SAAyE;AAC5G,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,eAAO,mCAAuC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACzE,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,OAAO,QAA2B,SAAuD;AAC7F,UAAM,WAAO,2BAAc,MAAM;AACjC,oCAAe,SAAS,eAAe,GAAmB,IAA+B;AACzF,WAAO,KAAK,KAAK,QAA4B,QAAQ,UAAU;AAAA,MAC7D;AAAA,MACA,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,IAAI,IAAY,SAAwD;AAC5E,WAAO,KAAK,KAAK,QAA6B,OAAO,GAAG,QAAQ,IAAI,EAAE,IAAI;AAAA,MACxE,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;;;AD1BO,IAAM,mBAAN,cAA+B,wBAAW;AAAA;AAAA,EAE/B;AAAA,EAEhB,YAAY,UAAyB,CAAC,GAAG;AACvC,UAAM,OAAO;AACb,SAAK,cAAc,IAAI,YAAY,KAAK,IAAI;AAAA,EAC9C;AACF;;;ADlCA,IAAAC,eAYO;","names":["import_core","import_core"]}

package/dist/index.mjs

@@ -1,15 +1,52 @@
 // src/client.ts
-import { createHttpClient } from "@runapi.ai/core";
+import { BaseClient } from "@runapi.ai/core";
 
 // src/resources/text-to-image.ts
-import { compactParams } from "@runapi.ai/core";
+import { compactParams, validateParams } from "@runapi.ai/core";
 import { pollUntilComplete } from "@runapi.ai/core/internal";
+
+// src/contract_gen.ts
+var contract = {
+  "text-to-image": {
+    "models": [
+      "gpt-4o-image"
+    ],
+    "fields_by_model": {
+      "gpt-4o-image": {
+        "aspect_ratio": {
+          "enum": [
+            "1:1",
+            "3:2",
+            "2:3"
+          ],
+          "required": true
+        },
+        "output_count": {
+          "enum": [
+            1,
+            2,
+            4
+          ],
+          "type": "integer"
+        }
+      }
+    }
+  }
+};
+
+// src/resources/text-to-image.ts
 var ENDPOINT = "/api/v1/gpt_4o_image/text_to_image";
 var TextToImage = class {
   constructor(http) {
     this.http = http;
   }
   http;
+  /**
+   * Generate an image and wait until complete.
+   * @param params Text-to-image parameters.
+   * @param options Per-request and polling overrides.
+   * @returns The completed text-to-image result.
+   */
   async run(params, options) {
     const { id } = await this.create(params, options);
     return pollUntilComplete(() => this.get(id, options), {
@@ -17,12 +54,26 @@ var TextToImage = class {
       pollIntervalMs: options?.pollIntervalMs
     });
   }
+  /**
+   * Create a text-to-image task; returns immediately with a task id.
+   * @param params Text-to-image parameters.
+   * @param options Per-request overrides.
+   * @returns The task creation result with id.
+   */
   async create(params, options) {
+    const body = compactParams(params);
+    validateParams(contract["text-to-image"], body);
     return this.http.request("POST", ENDPOINT, {
-      body: compactParams(params),
+      body,
       ...options
     });
   }
+  /**
+   * Fetch the current status of a text-to-image task.
+   * @param id The task id.
+   * @param options Per-request overrides.
+   * @returns The current text-to-image status.
+   */
   async get(id, options) {
     return this.http.request("GET", `${ENDPOINT}/${id}`, {
       ...options
@@ -31,11 +82,12 @@ var TextToImage = class {
 };
 
 // src/client.ts
-var Gpt4oImageClient = class {
+var Gpt4oImageClient = class extends BaseClient {
+  /** Image generation, editing, and inpainting operations. */
   textToImage;
   constructor(options = {}) {
-    const http = createHttpClient(options);
-    this.textToImage = new TextToImage(http);
+    super(options);
+    this.textToImage = new TextToImage(this.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\n/**\n * GPT-4o Image text-to-image API client.\n */\nexport class Gpt4oImageClient {\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, PollingOptions, RequestOptions } from '@runapi.ai/core';\nimport { compactParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport type { TextToImageParams, TextToImageResponse, TaskCreateResponse } from '../types';\n\nconst ENDPOINT = '/api/v1/gpt_4o_image/text_to_image';\n\nexport class TextToImage {\n  constructor(private readonly http: HttpClient) {}\n\n  async run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<TextToImageResponse> {\n    const { id } = await this.create(params, options);\n    return pollUntilComplete<TextToImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\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 { Gpt4oImageClient } from './client';\nexport * from './types';\n\n// Re-export core errors for convenience\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;AAGlC,IAAM,WAAW;AAEV,IAAM,cAAN,MAAkB;AAAA,EACvB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA,EAE7B,MAAM,IAAI,QAA2B,SAAyE;AAC5G,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,WAAO,kBAAuC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACzE,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AAAA,EACH;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;;;ADxBO,IAAM,mBAAN,MAAuB;AAAA,EACZ;AAAA,EAEhB,YAAY,UAAyB,CAAC,GAAG;AACvC,UAAM,OAAO,iBAAiB,OAAO;AACrC,SAAK,cAAc,IAAI,YAAY,IAAI;AAAA,EACzC;AACF;;;AETA;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/contract_gen.ts","../src/index.ts"],"sourcesContent":["import { BaseClient, type ClientOptions } from '@runapi.ai/core';\nimport { TextToImage } from './resources/text-to-image';\n\n/**\n * GPT-4o Image generation and editing API client.\n *\n * Supports pure text-to-image generation, image editing with source images,\n * and inpainting with an optional mask. At least one of `prompt` or\n * `source_image_urls` must be provided.\n *\n * @example\n * ```typescript\n * const client = new Gpt4oImageClient({ apiKey: 'your-api-key' });\n *\n * // Pure generation\n * const result = await client.textToImage.run({\n *   model: 'gpt-4o-image',\n *   prompt: 'A watercolor painting of a sunset',\n *   aspect_ratio: '3:2',\n * });\n *\n * // Edit with source images\n * const edited = await client.textToImage.run({\n *   model: 'gpt-4o-image',\n *   prompt: 'Add a rainbow',\n *   aspect_ratio: '3:2',\n *   source_image_urls: ['https://cdn.runapi.ai/public/samples/image.jpg'],\n * });\n * ```\n */\nexport class Gpt4oImageClient extends BaseClient {\n  /** Image generation, editing, and inpainting operations. */\n  public readonly textToImage: TextToImage;\n\n  constructor(options: ClientOptions = {}) {\n    super(options);\n    this.textToImage = new TextToImage(this.http);\n  }\n}\n","import type { HttpClient, PollingOptions, RequestOptions, ActionSchema } from '@runapi.ai/core';\nimport { compactParams, validateParams } from '@runapi.ai/core';\nimport { pollUntilComplete } from '@runapi.ai/core/internal';\nimport { contract } from '../contract_gen';\nimport type { TextToImageParams, TextToImageResponse, TaskCreateResponse } from '../types';\n\nconst ENDPOINT = '/api/v1/gpt_4o_image/text_to_image';\n\n/**\n * Generates images from a text prompt, optionally guided by source images and a mask.\n * For pure generation, provide a prompt. For editing, provide source_image_urls\n * (and optionally mask_url) to modify specific regions of the source.\n */\nexport class TextToImage {\n  constructor(private readonly http: HttpClient) {}\n\n  /**\n   * Generate an image and wait until complete.\n   * @param params Text-to-image parameters.\n   * @param options Per-request and polling overrides.\n   * @returns The completed text-to-image result.\n   */\n  async run(params: TextToImageParams, options?: RequestOptions & PollingOptions): Promise<TextToImageResponse> {\n    const { id } = await this.create(params, options);\n    return pollUntilComplete<TextToImageResponse>(() => this.get(id, options), {\n      maxWaitMs: options?.maxWaitMs,\n      pollIntervalMs: options?.pollIntervalMs,\n    });\n  }\n\n  /**\n   * Create a text-to-image task; returns immediately with a task id.\n   * @param params Text-to-image parameters.\n   * @param options Per-request overrides.\n   * @returns The task creation result with id.\n   */\n  async create(params: TextToImageParams, options?: RequestOptions): Promise<TaskCreateResponse> {\n    const body = compactParams(params);\n    validateParams(contract['text-to-image'] as ActionSchema, body as Record<string, unknown>);\n    return this.http.request<TaskCreateResponse>('POST', ENDPOINT, {\n      body,\n      ...options,\n    });\n  }\n\n  /**\n   * Fetch the current status of a text-to-image task.\n   * @param id The task id.\n   * @param options Per-request overrides.\n   * @returns The current text-to-image status.\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 const contract = {\n  \"text-to-image\": {\n    \"models\": [\n      \"gpt-4o-image\"\n    ],\n    \"fields_by_model\": {\n      \"gpt-4o-image\": {\n        \"aspect_ratio\": {\n          \"enum\": [\n            \"1:1\",\n            \"3:2\",\n            \"2:3\"\n          ],\n          \"required\": true\n        },\n        \"output_count\": {\n          \"enum\": [\n            1,\n            2,\n            4\n          ],\n          \"type\": \"integer\"\n        }\n      }\n    }\n  }\n} as const;\n","export { Gpt4oImageClient } from './client';\nexport * from './types';\n\n// Re-export core errors for convenience\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,kBAAsC;;;ACC/C,SAAS,eAAe,sBAAsB;AAC9C,SAAS,yBAAyB;;;ACF3B,IAAM,WAAW;AAAA,EACtB,iBAAiB;AAAA,IACf,UAAU;AAAA,MACR;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB,gBAAgB;AAAA,QACd,gBAAgB;AAAA,UACd,QAAQ;AAAA,YACN;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,UACA,YAAY;AAAA,QACd;AAAA,QACA,gBAAgB;AAAA,UACd,QAAQ;AAAA,YACN;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,UACA,QAAQ;AAAA,QACV;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;;;ADpBA,IAAM,WAAW;AAOV,IAAM,cAAN,MAAkB;AAAA,EACvB,YAA6B,MAAkB;AAAlB;AAAA,EAAmB;AAAA,EAAnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7B,MAAM,IAAI,QAA2B,SAAyE;AAC5G,UAAM,EAAE,GAAG,IAAI,MAAM,KAAK,OAAO,QAAQ,OAAO;AAChD,WAAO,kBAAuC,MAAM,KAAK,IAAI,IAAI,OAAO,GAAG;AAAA,MACzE,WAAW,SAAS;AAAA,MACpB,gBAAgB,SAAS;AAAA,IAC3B,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,OAAO,QAA2B,SAAuD;AAC7F,UAAM,OAAO,cAAc,MAAM;AACjC,mBAAe,SAAS,eAAe,GAAmB,IAA+B;AACzF,WAAO,KAAK,KAAK,QAA4B,QAAQ,UAAU;AAAA,MAC7D;AAAA,MACA,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,IAAI,IAAY,SAAwD;AAC5E,WAAO,KAAK,KAAK,QAA6B,OAAO,GAAG,QAAQ,IAAI,EAAE,IAAI;AAAA,MACxE,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;;;AD1BO,IAAM,mBAAN,cAA+B,WAAW;AAAA;AAAA,EAE/B;AAAA,EAEhB,YAAY,UAAyB,CAAC,GAAG;AACvC,UAAM,OAAO;AACb,SAAK,cAAc,IAAI,YAAY,KAAK,IAAI;AAAA,EAC9C;AACF;;;AGlCA;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":[]}

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@runapi.ai/gpt-4o-image",
-  "version": "0.2.5",
-  "description": "RunAPI GPT-4o Image SDK for JavaScript, Ruby, and Go",
+  "runapi": {
+    "slug": "gpt-4o-image"
+  },
+  "version": "0.2.7",
+  "description": "RunAPI GPT-4o Image SDK for text-to-image generation workflows in JavaScript, Python, Ruby, Go, and Java",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -27,7 +30,7 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@runapi.ai/core": "^0.2.5"
+    "@runapi.ai/core": "^0.2.7"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
@@ -46,8 +49,16 @@
     "api",
     "sdk",
     "typescript",
+    "python",
     "ruby",
-    "golang"
+    "golang",
+    "java",
+    "maven",
+    "gradle",
+    "image-generation",
+    "text-to-image",
+    "image-api",
+    "gpt-4o-image-api"
   ],
   "author": "RunAPI",
   "license": "Apache-2.0",
@@ -55,5 +66,8 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/runapi-ai/gpt-4o-image-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/runapi-ai/gpt-4o-image-sdk/issues"
   }
 }