@lobehub/chat/packages/model-runtime/src/types/image.ts

Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.

/* eslint-disable typescript-sort-keys/interface */
import { ModelUsage } from '@lobechat/types';
import { RuntimeImageGenParams } from 'model-bank';

export type CreateImagePayload = {
  model: string;
  params: RuntimeImageGenParams;
};

/**
 * Why return width and height?
 * 1. The configured width may differ from the actual generated width, which needs to be stored in the generation asset
 * 2. Image dimensions are needed to determine if thumbnail generation is required. Most providers return dimensions, potentially saving computation
 */
export type CreateImageResponse = {
  /**
   * Usually the provider's CDN URL, which often expires after some time and needs to be re-requested
   */
  imageUrl: string;

  /**
   * Image width
   */
  width?: number;

  /**
   * Image height
   */
  height?: number;

  /**
   * For models like GPT-image, Nano Banana which are LLMs with image output modality
   */
  modelUsage?: ModelUsage;
};

// 新增：支持认证图片下载的运行时接口
export interface AuthenticatedImageRuntime {
  /**
   * Get authentication headers for image download
   * Used when the image server requires authentication
   */
  getAuthHeaders(): Record<string, string> | undefined;
}