API action
Applies to enterprise.
This document describes the available APIs and capabilities for Firefly, Photoshop, Lightroom, Video & Audio, and Content Tagging (powered by Sensei Platform) as part of the Firefly Services offer.
Firefly APIs
|
Capability |
Operation definition (1) |
---|---|---|
Text to Image |
Generate images based on a text prompt |
1 Operation = 1 image generated from Firefly foundational model or custom models |
Text to Image with Structure Reference |
Generate images based on a prompt with optional reference image to match structure. |
1 Operation = 1 image generated from Firefly foundational model or custom models |
Text to Image with Style Reference |
Generate images based on a prompt with optional reference image to match style |
1 Operation = 1 image generated from Firefly foundational model or custom models |
Generative Fill |
Fill the masked area of an image with an optional prompt |
1 Operation = 1 image generated with the foundation Firefly model |
Generative Expand |
Expand an image to a new size/aspect ratio |
1 Operation = 1 image generated with the foundation Firefly model |
Generate Similar Images |
Generate similar Images based on the reference image. |
1 Operation = 1 image generated with the foundation Firefly model |
Generate Object Composite |
Upload an image (with or without mask), such as a product photo, and utilize a text prompt to generate a seamlessly composited scene featuring the product. |
1 Operation = 1 image generated with the foundation Firefly model |
Creative Cloud APIs
Photoshop APIs
API action |
Capability |
Operation definition (2) |
---|---|---|
Remove Background |
Isolate subject of interest in an image and remove background |
1 Operation = 1 API call |
Create Mask |
Isolate a subject of interest in an image (people, objects, etc) and generate an image mask |
1 Operation = 1 API call |
Create Renditions |
Create flat image representations of a PSD |
1 Operation = 1 API call |
Create actionJSON |
Convert .atn file to an actionJSON format |
1 Operation = 1 API call |
Execute actionJSON |
Execute a Photoshop Action with actionJSON format |
1 Operation = 1 API call |
Execute Photoshop Actions |
Executes Photoshop Action file against a PSD, JPEG, PNG, or TIFF |
1 Operation = 1 API call |
Replace Smart Object |
Replace Smart Object in a PSD |
1 Operation = 1 API call |
Product Crop |
Smart crop an image keeping the subject of interest in view |
1 Operation = 1 API call |
Depth Blur |
Apply depth blur to an image input |
1 Operation = 1 API call |
Edit Text Layer |
Change the contents of a text layer in a PSD, e.g. for localization |
1 Operation = 1 API call |
Apply PSD Edits |
Apply basic layer edits (name, state, etc), add/edit adjustment, pixel, and shape layers |
1 Operation = 1 API call |
Create New PSD |
Create new PSD with layers |
1 Operation = 1 API call |
Create an Artboard |
Create artboards from multiple PSD inputs |
1 Operation = 1 API call |
Get Manifest |
Extract metadata from PSD document, including general file and layer information |
1 Operation = 1 API call |
Lightroom APIs
API action |
Capability |
Operation definition (2) |
---|---|---|
Straighten Image |
Auto-straighten an image |
1 Operation = 1 API call |
Autotone |
Apply autotone to an image |
1 Operation = 1 API call |
Edit Image |
Adjust Lr adjustments to a photo, including exposure, contrast, detail, etc. |
1 Operation = 1 API call |
Apply Preset |
Apply Lr preset to a photo |
1 Operation = 1 API call |
Apply XMP |
Add XMP metadata to a photo |
1 Operation = 1 API call |
InDesign APIs
API action |
Capability |
Operation definition (2) |
---|---|---|
Data Merge |
Generate multiple asset variations by utilizing variable fields from an InDesign-tagged document and a CSV file. |
1 Operation = 1 output page |
Rendition |
Create JPEG, PNG, or PDF from the InDesign document. |
1 Operation = 1 output page |
Custom Scripts |
Create and execute custom scripts using InDesign features. |
1 Operation = 1 output* or input page, whichever is higher *Output includes any files saved through Save, Save As, or Save A Copy, and any files created through Export. |
Video & Audio APIs
API action |
Capability |
Operation definition (2) |
---|---|---|
Reframe |
Identify actions in a video and reframe the clip for different aspect ratios. |
|
Text to Speech |
Transform written text into spoken speech, allowing businesses to create dynamic audio |
1 Operation = 10 minutes of output speech |
Video & Audio APIs, Add-On
API action |
Capability |
Operation definition (2) |
---|---|---|
Translate Audio |
Automate audio and video voice translation with optional lip-syncing, producing high-quality dubbing output regardless of background noise and music. |
1 Operation = 10 seconds of output video |
Lip Sync |
Achieve precise lip-syncing with accurate lip composition on the speaker’s mouth, and create high-quality composited lip-sync videos. |
1 Operation = 5 seconds of output video |
Content tagging APIs
API action |
Capability |
Operation definition (2) |
---|---|---|
Color Tagging |
Given an image, can compute a histogram of pixel colors and sort them by dominant colors into buckets |
1 Operation = 1 API call per asset |
Keyword Tagging |
Given a text document, the keyword tagging service automatically extracts keywords or key phrases that best describe the subject of the document |
1 Operation = 1 API call per asset |
OCR |
Given an image, can indicate if text is present in the image. If text is present, OCR can return the text |
1 Operation = 1 API call per asset |
Additional
Firefly Creative Production
Action |
Capability |
Operation definition |
---|---|---|
Remove Background (flat image output) |
Isolate the subject of interest in an image, remove the background, and output a flat image file |
1 Operation = 1 output file |
Remove Background (layered PSD output) |
Isolate the subject of interest in an image, remove the background, and output a layered PSD file |
3 Operations = 1 output file |
Crop |
Crop image sizes or aspect ratios |
2 Operations = 1 output file |
Color Grade |
Auto tone or apply Lightroom presets to batches of uploaded images |
1 Operation = 1 output file |