feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 2
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/fashn/fashn-sdk-3add3c2ba2bcebda859e6c6c04e71f8e5f865d4a0edb7fe8ec5ba2e1985d00ca.yml
-openapi_spec_hash: 06d789906d61e3fefdfb789d532da5fe
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/fashn/fashn-sdk-c1e5a54d159efed8e9803ae5c34a94bad33a8c14a3fcef7331868db4d724ffc4.yml
+openapi_spec_hash: 58c9627440e1c4a21f879fcb900e3bdc
 config_hash: 6f35cc512a77534117eeac956e613816

packages/mcp-server/src/local-docs-search.ts

@@ -56,11 +56,11 @@ const EMBEDDED_METHODS: MethodEntry[] = [
     httpMethod: 'post',
     summary: 'Create a new prediction',
     description:
-      'Submit a prediction request for AI-powered fashion processing. Supports multiple model types including:\n- Try-on max (tryon-max)\n- Virtual try-on v1.6 (tryon-v1.6)\n- Model creation (model-create)\n- Model swap (model-swap)\n- Product to model (product-to-model)\n- Face to model (face-to-model)\n- Background operations (background-remove, background-change)\n- Image reframing (reframe)\n- Image to video (image-to-video)\n- Image editing (edit)\n\nAll requests use the versioned format with model_name and inputs structure.\n',
+      'Submit a prediction request for AI-powered fashion processing. Supports multiple model types including:\n- Try-on max (tryon-max)\n- Virtual try-on v1.6 (tryon-v1.6)\n- Model creation (model-create)\n- Model swap (model-swap)\n- Product to model (product-to-model)\n- Face to model (face-to-model)\n- Background operations (background-remove, background-change)\n- Image reframing (reframe)\n- Image to video (image-to-video)\n- Image editing (edit)\n- Product packshot (packshot)\n\nAll requests use the versioned format with model_name and inputs structure.\n',
     stainlessPath: '(resource) predictions > (method) run',
     qualified: 'client.predictions.run',
     params: [
-      "body: { inputs: { model_image: string; product_image: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; generation_mode?: 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; prompt?: string; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'tryon-max'; } | { inputs: { garment_image: string; model_image: string; category?: 'auto' | 'tops' | 'bottoms' | 'one-pieces'; garment_photo_type?: 'auto' | 'flat-lay' | 'model'; mode?: 'performance' | 'balanced' | 'quality'; moderation_level?: 'conservative' | 'permissive' | 'none'; num_samples?: number; output_format?: 'png' | 'jpeg'; return_base64?: boolean; seed?: number; segmentation_free?: boolean; }; model_name: 'tryon-v1.6'; } | { inputs: { product_image: string; aspect_ratio?: '1:1' | '2:3' | '3:4' | '4:5' | '5:4' | '4:3' | '3:2' | '16:9' | '9:16'; generation_mode?: 'fast' | 'balanced' | 'quality'; image_prompt?: string; model_image?: string; output_format?: 'png' | 'jpeg'; prompt?: string; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'product-to-model'; } | { inputs: { face_image: string; aspect_ratio?: '1:1' | '4:5' | '3:4' | '2:3' | '9:16'; generation_mode?: 'fast' | 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; prompt?: string; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'face-to-model'; } | { inputs: { prompt: string; aspect_ratio?: '1:1' | '2:3' | '3:4' | '4:5' | '5:4' | '4:3' | '3:2' | '16:9' | '9:16'; face_reference?: string; face_reference_mode?: 'match_base' | 'match_reference'; generation_mode?: 'fast' | 'balanced' | 'quality'; image_reference?: string; num_images?: number; output_format?: 'png' | 'jpeg'; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'model-create'; } | { inputs: { model_image: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; face_reference?: string; face_reference_mode?: 'match_base' | 'match_reference'; generation_mode?: 'fast' | 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; prompt?: string; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'model-swap'; } | { inputs: { aspect_ratio: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; image: string; generation_mode?: 'fast' | 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; return_base64?: boolean; seed?: number; }; model_name: 'reframe'; } | { inputs: { image: string; prompt: string; generation_mode?: 'fast' | 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'background-change'; } | { inputs: { image: string; return_base64?: boolean; }; model_name: 'background-remove'; } | { inputs: { image: string; duration?: 5 | 10; end_image?: string; negative_prompt?: string; prompt?: string; resolution?: '480p' | '720p' | '1080p'; seed?: number; }; model_name: 'image-to-video'; } | { inputs: { image: string; prompt: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; generation_mode?: 'fast' | 'balanced' | 'quality'; image_context?: string; mask?: string; num_images?: number; output_format?: 'png' | 'jpeg'; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'edit'; };",
+      "body: { inputs: { model_image: string; product_image: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; generation_mode?: 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; prompt?: string; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'tryon-max'; } | { inputs: { garment_image: string; model_image: string; category?: 'auto' | 'tops' | 'bottoms' | 'one-pieces'; garment_photo_type?: 'auto' | 'flat-lay' | 'model'; mode?: 'performance' | 'balanced' | 'quality'; moderation_level?: 'conservative' | 'permissive' | 'none'; num_samples?: number; output_format?: 'png' | 'jpeg'; return_base64?: boolean; seed?: number; segmentation_free?: boolean; }; model_name: 'tryon-v1.6'; } | { inputs: { product_image: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; generation_mode?: 'fast' | 'balanced' | 'quality'; image_prompt?: string; model_image?: string; output_format?: 'png' | 'jpeg'; prompt?: string; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'product-to-model'; } | { inputs: { face_image: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; generation_mode?: 'fast' | 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; prompt?: string; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'face-to-model'; } | { inputs: { prompt: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; face_reference?: string; face_reference_mode?: 'match_base' | 'match_reference'; generation_mode?: 'fast' | 'balanced' | 'quality'; image_reference?: string; num_images?: number; output_format?: 'png' | 'jpeg'; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'model-create'; } | { inputs: { model_image: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; face_reference?: string; face_reference_mode?: 'match_base' | 'match_reference'; generation_mode?: 'fast' | 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; prompt?: string; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'model-swap'; } | { inputs: { aspect_ratio: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; image: string; generation_mode?: 'fast' | 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; return_base64?: boolean; seed?: number; }; model_name: 'reframe'; } | { inputs: { image: string; prompt: string; generation_mode?: 'fast' | 'balanced' | 'quality'; num_images?: number; output_format?: 'png' | 'jpeg'; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'background-change'; } | { inputs: { image: string; return_base64?: boolean; }; model_name: 'background-remove'; } | { inputs: { image: string; duration?: 5 | 10; end_image?: string; negative_prompt?: string; prompt?: string; resolution?: '480p' | '720p' | '1080p'; seed?: number; }; model_name: 'image-to-video'; } | { inputs: { image: string; prompt: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; generation_mode?: 'fast' | 'balanced' | 'quality'; image_context?: string; mask?: string; num_images?: number; output_format?: 'png' | 'jpeg'; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'edit'; } | { inputs: { product_image: string; aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16'; generation_mode?: 'fast' | 'balanced' | 'quality'; image_context?: string; num_images?: number; output_format?: 'png' | 'jpeg'; prompt?: string; resolution?: '1k' | '2k' | '4k'; return_base64?: boolean; seed?: number; }; model_name: 'packshot'; };",
       'webhook_url?: string;',
     ],
     response: '{ id: string; error: string; }',

src/resources/predictions.ts

@@ -28,6 +28,7 @@ export class Predictions extends APIResource {
    * - Image reframing (reframe)
    * - Image to video (image-to-video)
    * - Image editing (edit)
+   * - Product packshot (packshot)
    *
    * All requests use the versioned format with model_name and inputs structure.
    *
@@ -332,7 +333,8 @@ export type PredictionRunParams =
   | PredictionRunParams.BackgroundChangeRequest
   | PredictionRunParams.BackgroundRemoveRequest
   | PredictionRunParams.ImageToVideoRequest
-  | PredictionRunParams.EditRequest;
+  | PredictionRunParams.EditRequest
+  | PredictionRunParams.PackshotRequest;
 
 export declare namespace PredictionRunParams {
   export interface TryOnMaxRequest {
@@ -384,9 +386,7 @@ export declare namespace PredictionRunParams {
       generation_mode?: 'balanced' | 'quality';
 
       /**
-       * Number of images to generate in a single run. Image generation has a random
-       * element in it, so trying multiple images at once increases the chances of
-       * getting a good result.
+       * Number of images to generate per request (1-4).
        */
       num_images?: number;
 
@@ -512,9 +512,7 @@ export declare namespace PredictionRunParams {
       moderation_level?: 'conservative' | 'permissive' | 'none';
 
       /**
-       * Number of images to generate in a single run. Image generation has a random
-       * element in it, so trying multiple images at once increases the chances of
-       * getting a good result.
+       * Number of images to generate per request (1-4).
        */
       num_samples?: number;
 
@@ -591,7 +589,7 @@ export declare namespace PredictionRunParams {
        *
        * **Default:** product_image's aspect ratio (standard mode only)
        */
-      aspect_ratio?: '1:1' | '2:3' | '3:4' | '4:5' | '5:4' | '4:3' | '3:2' | '16:9' | '9:16';
+      aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16';
 
       /**
        * Sets the generation quality level. 'quality' produces the most detailed and
@@ -692,12 +690,12 @@ export declare namespace PredictionRunParams {
       face_image: string;
 
       /**
-       * Desired aspect ratio for the output image. Only vertical ratios are supported.
-       * Images will always be extended downward to fit the aspect ratio.
+       * Desired aspect ratio for the output image. Vertical ratios (e.g. `2:3`, `3:4`,
+       * `9:16`) produce the most natural upper-body portraits.
        *
        * **Default:** `2:3`
        */
-      aspect_ratio?: '1:1' | '4:5' | '3:4' | '2:3' | '9:16';
+      aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16';
 
       /**
        * Sets the generation quality level. 'quality' produces the most detailed and
@@ -795,6 +793,7 @@ export declare namespace PredictionRunParams {
        *
        * | Aspect Ratio | Resolution  | Use Case                      |
        * | ------------ | ----------- | ----------------------------- |
+       * | 21:9         | 1568 × 672  | Ultra-wide cinematic          |
        * | 1:1          | 1024 × 1024 | Square format, social media   |
        * | 2:3          | 832 × 1248  | Portrait, fashion photography |
        * | 3:4          | 880 × 1176  | Standard portrait             |
@@ -805,7 +804,7 @@ export declare namespace PredictionRunParams {
        * | 16:9         | 1360 × 768  | Widescreen, banners           |
        * | 9:16         | 760 × 1360  | Vertical video format         |
        */
-      aspect_ratio?: '1:1' | '2:3' | '3:4' | '4:5' | '5:4' | '4:3' | '3:2' | '16:9' | '9:16';
+      aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16';
 
       /**
        * Optional face reference image to guide facial features in the generated model.
@@ -1062,9 +1061,7 @@ export declare namespace PredictionRunParams {
       generation_mode?: 'fast' | 'balanced' | 'quality';
 
       /**
-       * Number of images to generate in a single run. Image generation has a random
-       * element in it, so trying multiple images at once increases the chances of
-       * getting a good result.
+       * Number of images to generate per request (1-4).
        */
       num_images?: number;
 
@@ -1353,9 +1350,96 @@ export declare namespace PredictionRunParams {
       mask?: string;
 
       /**
-       * Number of images to generate in a single run. Image generation has a random
-       * element in it, so trying multiple images at once increases the chances of
-       * getting a good result.
+       * Number of images to generate per request (1-4).
+       */
+      num_images?: number;
+
+      /**
+       * Specifies the desired output image format.
+       *
+       * - `png`: Delivers the highest quality image, ideal for use cases such as content
+       *   creation where quality is paramount.
+       * - `jpeg`: Provides a faster response with a slightly compressed image, more
+       *   suitable for real-time applications.
+       */
+      output_format?: 'png' | 'jpeg';
+
+      /**
+       * Resolution setting for the output image.
+       */
+      resolution?: '1k' | '2k' | '4k';
+
+      /**
+       * When set to `true`, the API will return the generated image as a base64-encoded
+       * string instead of a CDN URL. The base64 string will be prefixed according to the
+       * `output_format` (e.g., `data:image/png;base64,...` or
+       * `data:image/jpeg;base64,...`). This option offers enhanced privacy as
+       * user-generated outputs are not stored on our servers when `return_base64` is
+       * enabled.
+       */
+      return_base64?: boolean;
+
+      /**
+       * Sets random operations to a fixed state. Use the same seed to reproduce results
+       * with the same inputs, or different seed to force different results.
+       */
+      seed?: number;
+    }
+  }
+
+  export interface PackshotRequest {
+    /**
+     * Body param
+     */
+    inputs: PackshotRequest.Inputs;
+
+    /**
+     * Body param: Turns a product photo into a clean commercial packshot. Optionally
+     * accepts a style reference image to guide staging, background, and lighting.
+     */
+    model_name: 'packshot';
+
+    /**
+     * Query param: Optional webhook URL to receive completion notifications
+     */
+    webhook_url?: string;
+  }
+
+  export namespace PackshotRequest {
+    export interface Inputs {
+      /**
+       * Source product image to convert into a commercial packshot. The AI generates a
+       * clean studio-style presentation while preserving product identity and detail.
+       *
+       * Base64 images must include the proper prefix (e.g.,
+       * `data:image/jpg;base64,<YOUR_BASE64>`)
+       */
+      product_image: string;
+
+      /**
+       * Optional aspect ratio for the output image.
+       */
+      aspect_ratio?: '21:9' | '1:1' | '4:3' | '3:2' | '2:3' | '5:4' | '4:5' | '3:4' | '16:9' | '9:16';
+
+      /**
+       * Sets the generation quality level. 'quality' produces the most detailed and
+       * realistic output but takes longer to process and costs more credits. 'fast'
+       * prioritizes speed and lower cost.
+       */
+      generation_mode?: 'fast' | 'balanced' | 'quality';
+
+      /**
+       * Optional URL or base64 of a style reference image guiding the packshot
+       * presentation (staging, background, lighting). The reference influences styling
+       * without overriding the product itself.
+       *
+       * Base64 images must include the proper prefix (e.g.,
+       * `data:image/jpg;base64,<YOUR_BASE64>`)
+       */
+      image_context?: string;
+
+      /**
+       * Number of images to generate per request (1-4).
        */
       num_images?: number;
 
@@ -1369,6 +1453,15 @@ export declare namespace PredictionRunParams {
        */
       output_format?: 'png' | 'jpeg';
 
+      /**
+       * Optional natural-language description of the desired packshot styling. If empty,
+       * the model picks a sensible commercial default for the detected product.
+       *
+       * **Examples:** "clean white background flat-lay", "soft studio lighting on a
+       * beige pedestal", "isolated on a marble surface"
+       */
+      prompt?: string;
+
       /**
        * Resolution setting for the output image.
        */

yarn.lock

@@ -1215,9 +1215,9 @@ baseline-browser-mapping@^2.9.0:
   integrity sha512-B0xUquLkiGLgHhpPBqvl7GWegWBUNuujQ6kXd/r1U38ElPT6Ok8KZ8e+FpUGEc2ZoRQUzq/aUnaKFc/svWUGSg==
 
 brace-expansion@^2.0.2:
-  version "2.1.0"
-  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.1.0.tgz#4f41a41190216ee36067ec381526fe9539c4f0ae"
-  integrity sha512-TN1kCZAgdgweJhWWpgKYrQaMNHcDULHkWwQIspdtjV4Y5aurRdZpjAqn6yX3FPqTA9ngHCc4hJxMAMgGfve85w==
+  version "2.1.1"
+  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.1.1.tgz#c68b1c4111c76aae3a6fba55d496cee10c39dad8"
+  integrity sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==
   dependencies:
     balanced-match "^1.0.0"