Class FireflySdk

constructor

• new FireflySdk(args?: { client?: Client; key?: string }): FireflySdk

  Parameters

  • Optionalargs: { client?: Client; key?: string }

  Returns FireflySdk

Static Readonly__registry

adaptiveComposite

• adaptiveComposite<ThrowOnError extends boolean = false>(
      options: Options<AdaptiveCompositeData, ThrowOnError>,
  ): RequestResult<
      AdaptiveCompositeResponses,
      AdaptiveCompositeErrors,
      ThrowOnError,
      "fields",
  >

  Generate adaptive composite

  Submits an asynchronous adaptive composite generation job using the adaptive composite pipeline.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<AdaptiveCompositeData, ThrowOnError>

  Returns RequestResult<
      AdaptiveCompositeResponses,
      AdaptiveCompositeErrors,
      ThrowOnError,
      "fields",
  >

cancelJobV4

• cancelJobV4<ThrowOnError extends boolean = false>(
      options: Options<CancelJobV4Data, ThrowOnError>,
  ): RequestResult<
      CancelJobV4Responses,
      CancelJobV4Errors,
      ThrowOnError,
      "fields",
  >

  Cancel job

  Cancel an asynchronous job.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<CancelJobV4Data, ThrowOnError>

  Returns RequestResult<CancelJobV4Responses, CancelJobV4Errors, ThrowOnError, "fields">

creativeUpsamplerV3Async

• creativeUpsamplerV3Async<ThrowOnError extends boolean = false>(
      options: Options<CreativeUpsamplerV3AsyncData, ThrowOnError>,
  ): RequestResult<
      CreativeUpsamplerV3AsyncResponses,
      CreativeUpsamplerV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

  Upscale image (beta)

  Upscales an image asynchronously using the creative upsampler (beta). Provide the input image via an upload ID from the storage API or a presigned URL. The response includes links to check status and retrieve the result. Poll the status URL until the job completes, then fetch the result for the upscaled image(s).

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<CreativeUpsamplerV3AsyncData, ThrowOnError>

  Returns RequestResult<
      CreativeUpsamplerV3AsyncResponses,
      CreativeUpsamplerV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

expandImagesV3Async

• expandImagesV3Async<ThrowOnError extends boolean = false>(
      options: Options<ExpandImagesV3AsyncData, ThrowOnError>,
  ): RequestResult<
      ExpandImagesV3AsyncResponses,
      ExpandImagesV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

  Expand image

  Change the aspect ratio or size of an image to expand it. Optionally, provide a text prompt to generate additional imagery for the expansion.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<ExpandImagesV3AsyncData, ThrowOnError>

  Returns RequestResult<
      ExpandImagesV3AsyncResponses,
      ExpandImagesV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

fillImagesV3Async

• fillImagesV3Async<ThrowOnError extends boolean = false>(
      options: Options<FillImagesV3AsyncData, ThrowOnError>,
  ): RequestResult<
      FillImagesV3AsyncResponses,
      FillImagesV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

  Fill image

  Generates a fill in an area of an image based on a text prompt. A mask defines the area of the image to be filled.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<FillImagesV3AsyncData, ThrowOnError>

  Returns RequestResult<
      FillImagesV3AsyncResponses,
      FillImagesV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

fireflyImageV5GenerateAsyncV4

• fireflyImageV5GenerateAsyncV4<ThrowOnError extends boolean = false>(
      options: Options<FireflyImageV5GenerateAsyncV4Data, ThrowOnError>,
  ): RequestResult<
      FireflyImageV5GenerateAsyncV4Responses,
      FireflyImageV5GenerateAsyncV4Errors,
      ThrowOnError,
      "fields",
  >

  Generate images with Image5

  Generate images asynchronously using Firefly's Image5 model.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<FireflyImageV5GenerateAsyncV4Data, ThrowOnError>

  Returns RequestResult<
      FireflyImageV5GenerateAsyncV4Responses,
      FireflyImageV5GenerateAsyncV4Errors,
      ThrowOnError,
      "fields",
  >

generateImagesV3Async

• generateImagesV3Async<ThrowOnError extends boolean = false>(
      options: Options<GenerateImagesV3AsyncData, ThrowOnError>,
  ): RequestResult<
      GenerateImagesV3AsyncResponses,
      GenerateImagesV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

  Generate images

  Generate images based on a text prompt. You may also include a reference image and Firefly will try to mimic the characteristics, such as color scheme, lighting, layout of objects in the image, etc.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GenerateImagesV3AsyncData, ThrowOnError>

  Returns RequestResult<
      GenerateImagesV3AsyncResponses,
      GenerateImagesV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

generateObjectCompositeV3Async

• generateObjectCompositeV3Async<ThrowOnError extends boolean = false>(
      options: Options<GenerateObjectCompositeV3AsyncData, ThrowOnError>,
  ): RequestResult<
      GenerateObjectCompositeV3AsyncResponses,
      GenerateObjectCompositeV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

  Generate object composite

  Combines your image and images generated by Firefly to create an image composite, or scene. The images that Firefly generates are based on a text prompt that you provide. You can upload an image with or without an image mask, such as a product photo, but for a successful result one of the following conditions must be true:

  • The request size is larger than the input image, OR
  • The image contains a transparent layer/channel, OR
  • A mask is provided

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GenerateObjectCompositeV3AsyncData, ThrowOnError>

  Returns RequestResult<
      GenerateObjectCompositeV3AsyncResponses,
      GenerateObjectCompositeV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

generateSimilarImagesV3Async

• generateSimilarImagesV3Async<ThrowOnError extends boolean = false>(
      options: Options<GenerateSimilarImagesV3AsyncData, ThrowOnError>,
  ): RequestResult<
      GenerateSimilarImagesV3AsyncResponses,
      GenerateSimilarImagesV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

  Generate similar images

  Generate similar images based on a reference image that you provide as a parameter.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GenerateSimilarImagesV3AsyncData, ThrowOnError>

  Returns RequestResult<
      GenerateSimilarImagesV3AsyncResponses,
      GenerateSimilarImagesV3AsyncErrors,
      ThrowOnError,
      "fields",
  >

generateVideoV3

• generateVideoV3<ThrowOnError extends boolean = false>(
      options: Options<GenerateVideoV3Data, ThrowOnError>,
  ): RequestResult<
      GenerateVideoV3Responses,
      GenerateVideoV3Errors,
      ThrowOnError,
      "fields",
  >

  Generate video

  Generate a five second video using a text prompt.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GenerateVideoV3Data, ThrowOnError>

  Returns RequestResult<
      GenerateVideoV3Responses,
      GenerateVideoV3Errors,
      ThrowOnError,
      "fields",
  >

getCustomModels

• getCustomModels<ThrowOnError extends boolean = false>(
      options: Options<GetCustomModelsData, ThrowOnError>,
  ): RequestResult<
      GetCustomModelsResponses,
      GetCustomModelsErrors,
      ThrowOnError,
      "fields",
  >

  Retrieve custom models

  Retrieve the custom models for a user.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<GetCustomModelsData, ThrowOnError>

  Returns RequestResult<
      GetCustomModelsResponses,
      GetCustomModelsErrors,
      ThrowOnError,
      "fields",
  >

jobResultV3

• jobResultV3<ThrowOnError extends boolean = false>(
      options: Options<JobResultV3Data, ThrowOnError>,
  ): RequestResult<
      JobResultV3Responses,
      JobResultV3Errors,
      ThrowOnError,
      "fields",
  >

  Get job status

  Get the status of an asynchronous job (including upscale jobs). When the job has completed successfully, the result reflects the operation type (for example generation, composite, or upscale).

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<JobResultV3Data, ThrowOnError>

  Returns RequestResult<JobResultV3Responses, JobResultV3Errors, ThrowOnError, "fields">

preciseComposite

• preciseComposite<ThrowOnError extends boolean = false>(
      options: Options<PreciseCompositeData, ThrowOnError>,
  ): RequestResult<
      PreciseCompositeResponses,
      PreciseCompositeErrors,
      ThrowOnError,
      "fields",
  >

  Generate precise composite

  Submits an asynchronous precise composite generation job using the precise composite pipeline.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<PreciseCompositeData, ThrowOnError>

  Returns RequestResult<
      PreciseCompositeResponses,
      PreciseCompositeErrors,
      ThrowOnError,
      "fields",
  >

storageImageV2

• storageImageV2<ThrowOnError extends boolean = false>(
      options: Options<StorageImageV2Data, ThrowOnError>,
  ): RequestResult<
      StorageImageV2Responses,
      StorageImageV2Errors,
      ThrowOnError,
      "fields",
  >

  Upload image

  Upload source image or mask for image-to-image operations, such as fill, expand, or upscale (beta). This API returns an identifier that is used to refer to uploaded content. The uploaded assets will be valid for 7 days from the date you upload them.

  Type Parameters

  • ThrowOnError extends boolean = false

  Parameters

  • options: Options<StorageImageV2Data, ThrowOnError>

  Returns RequestResult<
      StorageImageV2Responses,
      StorageImageV2Errors,
      ThrowOnError,
      "fields",
  >