{
  "opencollection": "1.0.0",
  "info": {
    "name": "Firefly API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "x-api-key",
      "value": "{{x-api-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Common Operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Generate images",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v3/images/generate-async",
            "headers": [
              {
                "name": "x-model-version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Generate images with Image5",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v4/images/generate-async",
            "headers": [
              {
                "name": "x-model-version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate images asynchronously using Firefly's Image5 model. When <code>referenceBlobs</code> is included in the request, omit <code>aspectRatio</code> or set it to <code>auto</code>."
        },
        {
          "info": {
            "name": "Generate similar images",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v3/images/generate-similar-async",
            "headers": [
              {
                "name": "x-model-version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate similar images based on a reference image that you provide as a parameter."
        },
        {
          "info": {
            "name": "Expand image",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v3/images/expand-async",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Change the aspect ratio or size of an image to expand it. Optionally, provide a text prompt to generate additional imagery for the expansion."
        },
        {
          "info": {
            "name": "Fill image",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v3/images/fill-async",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Generate video",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v3/videos/generate",
            "headers": [
              {
                "name": "x-model-version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate a five second video using a text prompt."
        },
        {
          "info": {
            "name": "Retrieve custom models",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://firefly-api.adobe.io/v3/custom-models",
            "headers": [
              {
                "name": "x-user-token",
                "value": ""
              },
              {
                "name": "x-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "A sorting option for the response list. For a reverse sort, use `-` (e.g., `-modifiedDate`). Multi-vector sorting is not currently supported."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The first result to include in a paginated response. Required if a `limit` is specified."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The number of custom models to return in a paginated response."
              },
              {
                "name": "publishedState",
                "value": "",
                "type": "query",
                "description": "This filters custom models by published state."
              }
            ]
          },
          "docs": "Retrieve the custom models for a user."
        },
        {
          "info": {
            "name": "Upload image",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v2/storage/image"
          },
          "docs": "Upload source image or mask for image-to-image operations, such as fill, expand, or upscale. 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."
        }
      ]
    },
    {
      "info": {
        "name": "Composite Operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Generate object composite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v3/images/generate-object-composite-async",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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: <ul> <li>The request size is larger than the input image, OR</li> <li>The image contains a transparent layer/channel, OR</li> <li>A mask is provided</li> </ul>"
        },
        {
          "info": {
            "name": "Generate precise composite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v3/images/precise-composite",
            "headers": [
              {
                "name": "content-type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submits an asynchronous precise composite generation job using the precise composite pipeline."
        },
        {
          "info": {
            "name": "Generate adaptive composite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v3/images/adaptive-composite",
            "headers": [
              {
                "name": "content-type",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submits an asynchronous adaptive composite generation job using the adaptive composite pipeline."
        }
      ]
    },
    {
      "info": {
        "name": "Upscale",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Upscale image",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://firefly-api.adobe.io/v3/images/upscale",
            "headers": [
              {
                "name": "x-model-version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Upscales an image asynchronously using the precise upsampler. 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)."
        }
      ]
    },
    {
      "info": {
        "name": "Manage jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get job status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://firefly-api.adobe.io/v3/status/:jobId",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "The job ID or URN returned in async response links."
              }
            ]
          },
          "docs": "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)."
        },
        {
          "info": {
            "name": "Cancel job",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://firefly-api.adobe.io/v3/cancel/:jobId",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "The job ID or URN returned in async response links."
              }
            ]
          },
          "docs": "Cancel an asynchronous job."
        }
      ]
    }
  ],
  "bundled": true
}