openapi: 3.1.0
info:
title: Adobe Illustrator Scripting API
description: >-
The Adobe Illustrator Scripting API provides programmatic access to
Illustrator's functionality through JavaScript, AppleScript, and VBScript.
It allows developers to automate repetitive tasks, manipulate documents,
select and edit text, generate art from data, and batch process files.
Scripts can control nearly every aspect of Illustrator, from creating and
modifying paths and shapes to managing layers, colors, and typography.
version: 29.0.0
contact:
name: Adobe Developer Support
url: https://developer.adobe.com/illustrator/
license:
name: Proprietary
url: https://www.adobe.com/legal/terms.html
x-logo:
url: https://www.adobe.com/favicon.ico
externalDocs:
description: Adobe Illustrator Scripting Guide
url: https://ai-scripting.docsforadobe.dev/
servers:
- url: https://localhost
description: Local Illustrator Application
tags:
- name: Application
description: >-
Access to the Illustrator application object, including preferences,
version information, and global settings.
- name: Artboards
description: >-
Manage artboards within an Illustrator document, including creating,
resizing, reordering, and removing artboards.
- name: Documents
description: >-
Manage Illustrator documents, including opening, creating, saving,
closing, and exporting documents in various formats.
- name: Graphic Styles
description: >-
Manage graphic styles that can be applied to artwork for consistent
appearance across multiple objects.
- name: Layers
description: >-
Create, manage, and manipulate layers within an Illustrator document,
including visibility, locking, and ordering.
- name: Path Items
description: >-
Create and manipulate vector path items, including shapes, lines,
and complex paths with anchor points and control handles.
- name: Swatches
description: >-
Manage color swatches, including spot colors, process colors,
gradients, and patterns stored in the document.
- name: Symbols
description: >-
Manage symbol definitions and symbol instances, enabling reuse of
artwork across documents.
- name: Text Frames
description: >-
Create and manipulate text frames, including point text, area text,
and text on a path, with full typography control.
paths:
/application:
get:
operationId: getApplication
summary: Adobe Illustrator Get Application Information
description: >-
Returns information about the Illustrator application, including the
version, build number, locale, and current preferences.
tags:
- Application
responses:
'200':
description: Application information retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/application/preferences:
get:
operationId: getPreferences
summary: Adobe Illustrator Get Application Preferences
description: >-
Returns the current application preferences, including general, type,
units, guides, and smart guides preferences.
tags:
- Application
responses:
'200':
description: Preferences retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Preferences'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: updatePreferences
summary: Adobe Illustrator Update Application Preferences
description: >-
Updates the application preferences with the provided values.
tags:
- Application
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Preferences'
responses:
'200':
description: Preferences updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Preferences'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents:
get:
operationId: listDocuments
summary: Adobe Illustrator List Open Documents
description: >-
Returns a list of all currently open Illustrator documents.
tags:
- Documents
responses:
'200':
description: List of open documents retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Document'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createDocument
summary: Adobe Illustrator Create a New Document
description: >-
Creates a new Illustrator document with the specified settings,
including document color mode, dimensions, and artboard configuration.
tags:
- Documents
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentCreate'
responses:
'201':
description: Document created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}:
get:
operationId: getDocument
summary: Adobe Illustrator Get a Document
description: >-
Returns detailed information about a specific open document,
including its layers, artboards, and document properties.
tags:
- Documents
parameters:
- $ref: '#/components/parameters/documentId'
responses:
'200':
description: Document retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Document'
'404':
description: Document not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: closeDocument
summary: Adobe Illustrator Close a Document
description: >-
Closes the specified document. Optionally saves changes before closing.
tags:
- Documents
parameters:
- $ref: '#/components/parameters/documentId'
- name: saveChanges
in: query
description: Whether to save changes before closing.
schema:
type: string
enum:
- save
- discard
- prompt
default: prompt
example: save
responses:
'204':
description: Document closed successfully.
'404':
description: Document not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/save:
post:
operationId: saveDocument
summary: Adobe Illustrator Save a Document
description: >-
Saves the specified document. If the document has not been saved
before, a file path must be provided.
tags:
- Documents
parameters:
- $ref: '#/components/parameters/documentId'
requestBody:
content:
application/json:
schema:
type: object
properties:
filePath:
type: string
description: File path to save to.
format:
type: string
description: File format for saving.
enum:
- ai
- eps
- pdf
- svg
responses:
'200':
description: Document saved successfully.
'404':
description: Document not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/export:
post:
operationId: exportDocument
summary: Adobe Illustrator Export a Document
description: >-
Exports the document to a specified format, including PNG, JPEG,
SVG, PDF, TIFF, and other supported formats.
tags:
- Documents
parameters:
- $ref: '#/components/parameters/documentId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExportOptions'
responses:
'200':
description: Document exported successfully.
content:
application/json:
schema:
type: object
properties:
filePath:
type: string
description: Path to the exported file.
format:
type: string
description: Format of the exported file.
'404':
description: Document not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/layers:
get:
operationId: listLayers
summary: Adobe Illustrator List Layers in a Document
description: >-
Returns all layers in the specified document, including nested
sublayers, with their properties and ordering.
tags:
- Layers
parameters:
- $ref: '#/components/parameters/documentId'
responses:
'200':
description: Layers retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Layer'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createLayer
summary: Adobe Illustrator Create a New Layer
description: >-
Creates a new layer in the specified document with the provided
name, color, visibility, and other properties.
tags:
- Layers
parameters:
- $ref: '#/components/parameters/documentId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LayerCreate'
responses:
'201':
description: Layer created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Layer'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/layers/{layerId}:
get:
operationId: getLayer
summary: Adobe Illustrator Get a Layer
description: >-
Returns detailed information about a specific layer, including its
contents, visibility, lock state, and sublayers.
tags:
- Layers
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/layerId'
responses:
'200':
description: Layer retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Layer'
'404':
description: Layer not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: updateLayer
summary: Adobe Illustrator Update a Layer
description: >-
Updates the properties of a specific layer, including name,
visibility, lock state, opacity, and blend mode.
tags:
- Layers
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/layerId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LayerCreate'
responses:
'200':
description: Layer updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Layer'
'404':
description: Layer not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteLayer
summary: Adobe Illustrator Delete a Layer
description: >-
Removes the specified layer and all of its contents from the document.
tags:
- Layers
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/layerId'
responses:
'204':
description: Layer deleted successfully.
'404':
description: Layer not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/artboards:
get:
operationId: listArtboards
summary: Adobe Illustrator List Artboards in a Document
description: >-
Returns all artboards in the specified document with their
dimensions, positions, and names.
tags:
- Artboards
parameters:
- $ref: '#/components/parameters/documentId'
responses:
'200':
description: Artboards retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Artboard'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createArtboard
summary: Adobe Illustrator Create a New Artboard
description: >-
Adds a new artboard to the document with the specified dimensions
and position.
tags:
- Artboards
parameters:
- $ref: '#/components/parameters/documentId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ArtboardCreate'
responses:
'201':
description: Artboard created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Artboard'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/artboards/{artboardIndex}:
get:
operationId: getArtboard
summary: Adobe Illustrator Get an Artboard
description: >-
Returns detailed information about a specific artboard, including
its bounds, name, and ruler origin.
tags:
- Artboards
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/artboardIndex'
responses:
'200':
description: Artboard retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Artboard'
'404':
description: Artboard not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: updateArtboard
summary: Adobe Illustrator Update an Artboard
description: >-
Updates the properties of a specific artboard, including name,
bounds, and ruler origin.
tags:
- Artboards
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/artboardIndex'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ArtboardCreate'
responses:
'200':
description: Artboard updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Artboard'
'404':
description: Artboard not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteArtboard
summary: Adobe Illustrator Delete an Artboard
description: >-
Removes the specified artboard from the document.
tags:
- Artboards
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/artboardIndex'
responses:
'204':
description: Artboard deleted successfully.
'404':
description: Artboard not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/pathItems:
get:
operationId: listPathItems
summary: Adobe Illustrator List Path Items
description: >-
Returns all path items in the document or a specific layer,
including their anchor points, fill, and stroke properties.
tags:
- Path Items
parameters:
- $ref: '#/components/parameters/documentId'
- name: layerId
in: query
description: Filter path items by layer.
schema:
type: string
example: example_value
responses:
'200':
description: Path items retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PathItem'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createPathItem
summary: Adobe Illustrator Create a Path Item
description: >-
Creates a new path item in the document with the specified anchor
points, fill, stroke, and other properties. Supports creating
rectangles, ellipses, polygons, stars, and freeform paths.
tags:
- Path Items
parameters:
- $ref: '#/components/parameters/documentId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PathItemCreate'
responses:
'201':
description: Path item created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PathItem'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/pathItems/{pathItemId}:
get:
operationId: getPathItem
summary: Adobe Illustrator Get a Path Item
description: >-
Returns detailed information about a specific path item, including
its anchor points, control handles, fill, stroke, and transform.
tags:
- Path Items
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/pathItemId'
responses:
'200':
description: Path item retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PathItem'
'404':
description: Path item not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: updatePathItem
summary: Adobe Illustrator Update a Path Item
description: >-
Updates the properties of a specific path item, including its
anchor points, fill, stroke, opacity, and transform.
tags:
- Path Items
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/pathItemId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PathItemCreate'
responses:
'200':
description: Path item updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/PathItem'
'404':
description: Path item not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deletePathItem
summary: Adobe Illustrator Delete a Path Item
description: >-
Removes the specified path item from the document.
tags:
- Path Items
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/pathItemId'
responses:
'204':
description: Path item deleted successfully.
'404':
description: Path item not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/textFrames:
get:
operationId: listTextFrames
summary: Adobe Illustrator List Text Frames
description: >-
Returns all text frames in the document, including point text,
area text, and text on a path items.
tags:
- Text Frames
parameters:
- $ref: '#/components/parameters/documentId'
- name: layerId
in: query
description: Filter text frames by layer.
schema:
type: string
example: example_value
responses:
'200':
description: Text frames retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TextFrame'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createTextFrame
summary: Adobe Illustrator Create a Text Frame
description: >-
Creates a new text frame in the document. Supports point text, area
text, and text on a path with full typography settings.
tags:
- Text Frames
parameters:
- $ref: '#/components/parameters/documentId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TextFrameCreate'
responses:
'201':
description: Text frame created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TextFrame'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/textFrames/{textFrameId}:
get:
operationId: getTextFrame
summary: Adobe Illustrator Get a Text Frame
description: >-
Returns detailed information about a specific text frame, including
its contents, character attributes, paragraph attributes, and bounds.
tags:
- Text Frames
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/textFrameId'
responses:
'200':
description: Text frame retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TextFrame'
'404':
description: Text frame not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: updateTextFrame
summary: Adobe Illustrator Update a Text Frame
description: >-
Updates the properties of a specific text frame, including its
contents, character attributes, and paragraph attributes.
tags:
- Text Frames
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/textFrameId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TextFrameCreate'
responses:
'200':
description: Text frame updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TextFrame'
'404':
description: Text frame not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteTextFrame
summary: Adobe Illustrator Delete a Text Frame
description: >-
Removes the specified text frame from the document.
tags:
- Text Frames
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/textFrameId'
responses:
'204':
description: Text frame deleted successfully.
'404':
description: Text frame not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/symbols:
get:
operationId: listSymbols
summary: Adobe Illustrator List Symbols
description: >-
Returns all symbol definitions in the document that can be
instantiated as symbol items.
tags:
- Symbols
parameters:
- $ref: '#/components/parameters/documentId'
responses:
'200':
description: Symbols retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Symbol'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createSymbol
summary: Adobe Illustrator Create a Symbol
description: >-
Creates a new symbol definition from the specified artwork in the
document. The symbol can then be instantiated multiple times.
tags:
- Symbols
parameters:
- $ref: '#/components/parameters/documentId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SymbolCreate'
responses:
'201':
description: Symbol created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Symbol'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/symbols/{symbolId}:
get:
operationId: getSymbol
summary: Adobe Illustrator Get a Symbol
description: >-
Returns detailed information about a specific symbol definition.
tags:
- Symbols
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/symbolId'
responses:
'200':
description: Symbol retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Symbol'
'404':
description: Symbol not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteSymbol
summary: Adobe Illustrator Delete a Symbol
description: >-
Removes the specified symbol definition from the document.
tags:
- Symbols
parameters:
- $ref: '#/components/parameters/documentId'
- $ref: '#/components/parameters/symbolId'
responses:
'204':
description: Symbol deleted successfully.
'404':
description: Symbol not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/swatches:
get:
operationId: listSwatches
summary: Adobe Illustrator List Swatches
description: >-
Returns all color swatches defined in the document, including
process colors, spot colors, gradients, and patterns.
tags:
- Swatches
parameters:
- $ref: '#/components/parameters/documentId'
responses:
'200':
description: Swatches retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Swatch'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createSwatch
summary: Adobe Illustrator Create a Swatch
description: >-
Creates a new color swatch in the document with the specified
color values and properties.
tags:
- Swatches
parameters:
- $ref: '#/components/parameters/documentId'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SwatchCreate'
responses:
'201':
description: Swatch created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Swatch'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/swatches/{swatchName}:
get:
operationId: getSwatch
summary: Adobe Illustrator Get a Swatch
description: >-
Returns detailed information about a specific swatch by name.
tags:
- Swatches
parameters:
- $ref: '#/components/parameters/documentId'
- name: swatchName
in: path
required: true
description: Name of the swatch.
schema:
type: string
example: Example Artboard
responses:
'200':
description: Swatch retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Swatch'
'404':
description: Swatch not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteSwatch
summary: Adobe Illustrator Delete a Swatch
description: >-
Removes the specified swatch from the document.
tags:
- Swatches
parameters:
- $ref: '#/components/parameters/documentId'
- name: swatchName
in: path
required: true
description: Name of the swatch.
schema:
type: string
example: Example Artboard
responses:
'204':
description: Swatch deleted successfully.
'404':
description: Swatch not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/graphicStyles:
get:
operationId: listGraphicStyles
summary: Adobe Illustrator List Graphic Styles
description: >-
Returns all graphic styles defined in the document.
tags:
- Graphic Styles
parameters:
- $ref: '#/components/parameters/documentId'
responses:
'200':
description: Graphic styles retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GraphicStyle'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/documents/{documentId}/graphicStyles/{graphicStyleName}:
get:
operationId: getGraphicStyle
summary: Adobe Illustrator Get a Graphic Style
description: >-
Returns detailed information about a specific graphic style.
tags:
- Graphic Styles
parameters:
- $ref: '#/components/parameters/documentId'
- name: graphicStyleName
in: path
required: true
description: Name of the graphic style.
schema:
type: string
example: Example Artboard
responses:
'200':
description: Graphic style retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/GraphicStyle'
'404':
description: Graphic style not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteGraphicStyle
summary: Adobe Illustrator Delete a Graphic Style
description: >-
Removes the specified graphic style from the document.
tags:
- Graphic Styles
parameters:
- $ref: '#/components/parameters/documentId'
- name: graphicStyleName
in: path
required: true
description: Name of the graphic style.
schema:
type: string
example: Example Artboard
responses:
'204':
description: Graphic style deleted successfully.
'404':
description: Graphic style not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
parameters:
documentId:
name:
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-illustrator/refs/heads/main/openapi/adobe-illustrator-scripting-openapi-original.yml