Firefly Services - InDesign APIs

Download OpenAPI specification:Download

E-mail: idservices@adobe.com Terms of Service

Firefly Service's RESTful InDesign APIs offer resources to automate tedious, time-consuming design tasks through scalable cloud services, encouraging more personalization at scale, creative automation, and faster content delivery.

Rendition API

The Rendition API creates a version of a file in a specified format (e.g., PNG, JPEG, or PDF).

Create JPEG, PNG, or PDF renditions

Create a JPEG, PNG, or PDF rendition of a specific InDesign document.

The rendition output MIME types are:

    image/jpeg for JPEG.
    image/png for PNG.
    application/pdf for PDF.

SecurityApiKeyAuth or BearerAuth
Request
header Parameters
x-gw-ims-org-id
string

This is the identifier for Adobe Identity Management Service (IMS) as defined in Adobe's developer console. This is optional.

x-api-key
required
string

The API key as defined in Adobe's developer console.

Authorization
required
string

The authorization token with bearer "token_value".

Request Body schema: application/json
required

This object specifies parameters for the JPEG, PNG or PDF output.

required
Array of objects (InputAsset)

Information about the assets, which will be used to process the job.

required
object
Array of objects (OutputAsset)
Responses
202

The job/capability has been accepted for processing.

400

Bad Parameter

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

post/v3/create-rendition
Request samples
application/json
{
  • "assets": [
    ],
  • "params": {
    },
  • "outputs": [
    ]
}
Response samples
application/json
{
  • "jobId": "string",
  • "statusUrl": "string"
}