{
  "opencollection": "1.0.0",
  "info": {
    "name": "Firefly Services - InDesign API"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Data Merge",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Perform a data merge",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://indesign.adobe.io/v3/merge-data",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates InDesign documents or PDFs by merging CSV data with InDesign templates. Supports multiple output formats: JPEG (`image/jpeg`), PNG (`image/png`), PDF (`application/pdf`), and InDesign (`application/x-indesign`)."
        },
        {
          "info": {
            "name": "Get data merge tags",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://indesign.adobe.io/v3/merge-data-tags",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieves the data merge tags from a document."
        }
      ]
    },
    {
      "info": {
        "name": "Remap Links",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Remap links",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://indesign.adobe.io/v3/remap-links",
            "headers": [
              {
                "name": "x-aem-token",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replaces file-based links in InDesign documents with AEM URLs. Particularly useful for customers working with Adobe Experience Manager (AEM) using Adobe Asset Link, enabling designers to work with output files that have direct links to AEM URLs."
        }
      ]
    },
    {
      "info": {
        "name": "Rendition",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create JPEG, PNG, or PDF renditions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://indesign.adobe.io/v3/create-rendition",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates JPEG, PNG, or PDF renditions of InDesign documents. Supports multiple output formats: JPEG (`image/jpeg`), PNG (`image/png`), and PDF (`application/pdf`)."
        }
      ]
    },
    {
      "info": {
        "name": "Custom Scripts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List custom scripts API",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://indesign.adobe.io/v3/scripts",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination"
              }
            ]
          },
          "docs": "Retrieves details of the latest version of all registered custom scripts. Includes version, download link, registration date, and script name. Response is paginated based on list length."
        },
        {
          "info": {
            "name": "Submit a Custom Script",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://indesign.adobe.io/v3/scripts",
            "body": {
              "type": "multipart-form",
              "data": []
            }
          },
          "docs": "Submits custom script bundles for registration. Returns a URL for posting execution requests for the registered script."
        },
        {
          "info": {
            "name": "Submit a custom script execution request",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://indesign.adobe.io/v3/:script_id/:script_name",
            "params": [
              {
                "name": "script_id",
                "value": "",
                "type": "path",
                "description": "script_id as reported in the response to custom script submit request."
              },
              {
                "name": "script_name",
                "value": "",
                "type": "path",
                "description": "The name of the custom script, specified in the custom script manifest."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submits execution requests for custom scripts. Defines input assets and parameters that the custom script will use during execution."
        },
        {
          "info": {
            "name": "Get Custom Script details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://indesign.adobe.io/v3/scripts/:script_name",
            "params": [
              {
                "name": "script_name",
                "value": "",
                "type": "path",
                "description": "Name of the custom script"
              }
            ]
          },
          "docs": "Retrieves details of a single registered custom script. Includes version, download link, registration date, and script name."
        },
        {
          "info": {
            "name": "Delete a Custom Script",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://indesign.adobe.io/v3/scripts/:script_name",
            "params": [
              {
                "name": "script_name",
                "value": "",
                "type": "path",
                "description": "Name of the custom script to delete"
              }
            ]
          },
          "docs": "Deletes a single registered custom script. All versions of the script will be permanently removed."
        },
        {
          "info": {
            "name": "Update Custom Script App Version",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://indesign.adobe.io/v3/scripts/:script_name/app-version",
            "params": [
              {
                "name": "script_name",
                "value": "",
                "type": "path",
                "description": "Name of the custom script to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the InDesign app version configuration for a registered custom script. Allows customers to specify version strategies: use latest version, fix to a major version, or fix to a specific major and minor version."
        },
        {
          "info": {
            "name": "Get Current App Versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://indesign.adobe.io/v3/app-versions"
          },
          "docs": "Retrieves information about all available InDesign app versions. Returns major version, minor version, and status for each registered app version."
        }
      ]
    },
    {
      "info": {
        "name": "Document Info",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get document information",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://indesign.adobe.io/v3/document-info",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Retrieve comprehensive information about INDD/IDML documents. Returns data based on the enabled information types specified in the request."
        },
        {
          "info": {
            "name": "Get status - Document Info API",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://indesign.adobe.io/v3/status/:document-info_job_id",
            "params": [
              {
                "name": "document-info_job_id",
                "value": "",
                "type": "path",
                "description": "The ID of the Document Info job you want to see the status of. This comes from the response of the Document Info request."
              }
            ]
          },
          "docs": "Returns the latest status of a Document Info job. Poll this endpoint to retrieve the extracted document information including pages, links, fonts, page items, and text stories."
        }
      ]
    },
    {
      "info": {
        "name": "Convert PDF to InDesign",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Convert PDF to InDesign document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://indesign.adobe.io/v3/convert-pdf-to-indesign",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Converts PDF documents to editable InDesign (INDD or IDML) format. The output is a ZIP file (default name 'output.zip') containing subfolders (named after each input PDF) with the converted document and associated assets. If `embedLinks` is false, assets are provided in a separate folder within the ZIP. If `embedLinks` is true, all links are embedded in the InDesign file. Returns warnings for missing fonts and links."
        },
        {
          "info": {
            "name": "Get status - Convert PDF to InDesign API",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://indesign.adobe.io/v3/status/:convert-pdf-to-indesign_job_id",
            "params": [
              {
                "name": "convert-pdf-to-indesign_job_id",
                "value": "",
                "type": "path",
                "description": "The ID of the Convert PDF to InDesign job you want to see the status of. This comes from the response of the Convert PDF to InDesign request."
              }
            ]
          },
          "docs": "Returns the latest status of a job, in this case a PDF to InDesign conversion job. Poll this endpoint to retrieve the job results, warnings, and download URL of the output, in this case an output ZIP file."
        }
      ]
    },
    {
      "info": {
        "name": "Job Status",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the status of a job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://indesign.adobe.io/v3/status/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the job you want to see the status of. This comes from the response of the executed job request."
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of output items to return per page when outputs are paginated. Defaults to 10."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Zero-based page index to retrieve when outputs are paginated. Defaults to 0."
              }
            ]
          },
          "docs": "Returns the latest status of an executed custom script job."
        }
      ]
    }
  ],
  "bundled": true
}