Download OpenAPI specification:Download
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.
The Custom Capabilities API allows you to submit custom capabilities to do almost anything you can do in InDesign using a custom script.
Submit the capability bundle. This returns the URL for posting an execution request for the capability.
| x-gw-ims-org-id required | string This is the identifier for Adobe Identity Management Service (IMS) as defined in Adobe's developer console. |
| 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". |
The capability bundle, in ZIP format. This package describes the capability to the app engine.
Status of a capability execution.
Bad Parameter
Unauthorized
Forbidden
Not Found
Too Many Requests
Internal Server Error
{- "capability": "string",
- "version": "string",
- "url": "string"
}Submit an execution request for a custom capability. Define the input assets and parameters the capability will use when it is executed against the app engine.
| organization required | string The organization identifier, reported in the response to a capability submit request. |
| capability required | string The name of the capability, specified in the capability manifest. |
| x-gw-ims-org-id required | string This is the identifier for Adobe Identity Management Service (IMS) as defined in Adobe's developer console. |
| 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". |
This job request object specifies parameters for the execution of the capability.
required | Array of objects (InputAsset) Information about the assets, which will be used to process the job. |
object | |
Array of objects (OutputAsset) |
The job/capability has been accepted for processing.
Bad Parameter
Unauthorized
Forbidden
Not Found
Too Many Requests
Internal Server Error
{- "assets": [
- {
- "source": {
- "url": "string",
- "storageType": "Azure"
}, - "destination": "string"
}
], - "params": {
- "generalSettings": {
- "fonts": {
- "fontsDirectories": [
- "string"
]
}, - "links": {
- "replaceLinks": [
- {
- "targetDocument": "string",
- "mapping": [
- {
- "currentURI": null,
- "linkID": null,
- "newAssetRelativePath": null
}
]
}
]
}, - "appLogs": {
- "logsRelativePath": "string"
}
}
}, - "outputs": [
- {
- "destination": {
- "url": "string",
- "storageType": "Azure"
}, - "source": "string"
}
]
}{- "jobId": "string",
- "statusUrl": "string"
}