Blender integration through the Model Context Protocol
Adobe Illustrator MCP is installed from its publisher's own source and answers where it runs, so this marketplace is not in the path of a single call. There is no address here to send one to, and a panel that pretended otherwise would be showing you an answer we made up. Install it and call it from your own client — the Installation tab has the entry for each one.
What it does
Use an MCP client to work with Adobe Illustrator documents, artboards, shapes, paths, type, colour, effects, symbols, images, actions, and export. Requires Illustrator installed on the same machine.
Quickstart
# 1 — add it to Claude Code
claude mcp add --scope user zachshallbetter-illustrator-mcp '--' npx -y adobe-mcp-illustrator
# 2 — ask your agent for something these tools do
# edit_colors, create_swatch_group, delete_swatches and 304 more
Adobe Illustrator MCP costs nothing on mcprush: there is no plan to choose here, no cap to set and nothing mcprush can bill you for.
Where are you running it?
Every route below installs the same thing and ends at the same approval screen. This one runs on your machine: your client starts Adobe Illustrator MCP as a process under your own user, with your files and your network, so the tool surface below is what it can do to your computer rather than to a server somewhere else. Its scan result is on the Security tab — read the surface before you approve it.
This is a public server: you run it yourself and this marketplace is not in the path. You need Node.js — the current LTS (24) is the safe choice; npx comes with it. Claude Code registers it in one command; --scope user makes it available in every project. The '--' is in quotes so that PowerShell passes it on.
claude mcp add --scope user zachshallbetter-illustrator-mcp '--' npx -y adobe-mcp-illustratorReconnect, or start a new session, and the tools appear in the model’s tool list.
Nothing is required, but it can take ILLUSTRATOR_APP_NAME (macOS only: address a specific copy, e.g. "Adobe Illustrator 2025". Default: Illustrator by bundle id), ILLUSTRATOR_ALLOWED_DIRS (Extra directories allowed for file operations (':' on macOS, ';' on Windows)), ILLUSTRATOR_SCRIPT_TIMEOUT_MS (How long to wait for Illustrator before reporting that a dialog may be open. Default 120000) if you want to set them.
One config entry your client uses to start the process locally. A local server runs with your file system and your network, which is why it is priced without metering.
307 tools, with what each one reads, writes and reaches shown before you agree — the same list on every route above. Read the tool surface.
Tool surface
What the model actually sees. Descriptions are diffed on every release — see version history.
Recolour the targets with an Edit > Edit Colors command: convert to CMYK, RGB or grayscale, invert, or blend the fills between the frontmost and backmost (or leftmost and rightmost, topmost and bottommost) objects
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| operation | string | yes | — |
Create a swatch group (a colour group in the Swatches panel), optionally moving existing swatches into it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
| swatches | array | no | Names of existing swatches to move into the group |
Delete swatches by name
| Parameter | Type | Required | Notes |
|---|---|---|---|
| names | array | yes | — |
Add a swatch for each process colour used in the fills and strokes of the artwork (Swatches panel > Add Used Colors), skipping colours that already have one. Swatches are named the way Illustrator names them, e.g. "C=0 M=60 Y=100 K=0"
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | no | Only these items. Default the whole document | |
| group | string | no | Put the new swatches in this swatch group, created if needed |
Change a swatch the way Swatch Options does (Swatches panel > Swatch Options): rename it, change its colour, or change its type between process, global process and spot. Changing a global or spot swatch's colour updates every object that uses it. Making a process swatch global or spot recreates it…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | The swatch to change |
| newName | string | no | — |
| color | no | New colour value: "cmyk(c,m,y,k)", "rgb(r,g,b)", "#RRGGBB" or "gray(g)" | |
| type | string | no | — |
Duplicate swatches (Swatches panel > Duplicate Swatch). Each copy is named "<name> copy" (then "copy 2" and so on) and goes in the same swatch group; a global or spot swatch becomes a new global or spot colour and a gradient swatch a new gradient. Pattern swatches cannot be duplicated by script
| Parameter | Type | Required | Notes |
|---|---|---|---|
| names | array | yes | Swatches to duplicate |
Merge swatches into the first one named (Swatches panel > Merge Swatches): every fill, stroke, text colour and gradient stop that uses one of the other swatches is repainted with the first, then the others are deleted. A global or spot swatch is matched wherever it is used, keeping each use's…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| names | array | yes | The swatch to keep first, then the swatches to merge into it |
List the swatches no artwork uses, as Swatches panel > Select All Unused finds them (a script cannot select swatches in the panel; delete them with delete_swatches). Scans the fills and strokes of every path and text character and the gradients in use; a process swatch counts as used when an…
No parameter schema on file.
Add the current colour as a swatch (Color panel > Create New Swatch): the fill or stroke of the first selected object, or the default fill or stroke when nothing is selected. Named after its values the way Illustrator names them unless a name is given
| Parameter | Type | Required | Notes |
|---|---|---|---|
| source | string | no | Default fill |
| name | string | no | — |
| type | string | no | Default process |
Change a colour group (swatch group): rename it, move swatches into it, delete some of its swatches, or delete the group with its swatches, as the Swatches panel and Recolor Artwork's colour groups do
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | The swatch group |
| newName | string | no | — |
| add | array | no | Swatches to move into the group |
| delete | array | no | Swatches in the group to delete from the document |
| deleteGroup | boolean | no | Delete the group and every swatch in it. Default false |
Open a built-in swatch library panel (Window > Swatch Libraries), e.g. "Gradients > Water", "Color Books > PANTONE+ Solid Coated". The panel only shows the library; load_swatch_library copies its swatches into the document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | The library's Window > Swatch Libraries path, or its last part when that is unique |
Copy swatches from a swatch library into the document, the way dragging them from a library panel does: a built-in library (Window > Swatch Libraries, e.g. "Gradients > Wood", including the gradient presets) or a library .ai file. Keeps the library's swatch groups. Colour books (.acb) and pattern…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | no | A built-in library's Window > Swatch Libraries path, e.g. "Gradients > Water", or its last part when that is unique |
| filePath | string | no | Or an absolute path to a swatch library .ai file |
| swatches | array | no | Only these swatches. Default all |
| replace | boolean | no | Overwrite document swatches with the same name. Default false (they are left as they are) |
Save the document's swatches as a swatch library (Swatches panel > Save Swatch Library as AI): an Illustrator file holding just the swatches and their groups, which Window > Swatch Libraries > Other Library opens. Save it in Illustrator's user Swatches folder to see it under User Defined. With…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path of the .ai library file |
| swatches | array | no | Only these swatches. Default all |
| ifExists | string | no | When the file exists: refuse (default), overwrite it, or add to the library in it |
Change colours by script, following Illustrator's colour commands: saturate (Edit > Edit Colors > Saturate: scales each ink, RGB colour amount or spot tint by a percentage), adjust_balance (Edit > Edit Colors > Adjust Color Balance: adds percentages to the CMYK, RGB, gray or global-tint values of…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| operation | string | yes | — |
| target | no | Items whose colours change | |
| swatchGroup | string | no | Or a swatch group whose swatches change |
| amount | no | saturate: percent, -100 to 100 | |
| mode | string | no | adjust_balance: which colours to adjust; global adjusts the tint of global and spot colours |
| cyan | no | — | |
| magenta | no | — | |
| yellow | no | — | |
| black | no | cmyk or gray mode | |
| red | no | — | |
| green | no | — | |
| blue | no | — | |
| tint | no | global mode | |
| fill | boolean | no | Change fills. Default true |
| stroke | boolean | no | Change strokes. Default true |
| gradients | boolean | no | Also change the stops of gradients the targets use. Default false |
Set or clear overprint on black, as Edit > Edit Colors > Overprint Black does, by script: fills and strokes whose black is at least the given percentage. By default only pure black (no cyan, magenta or yellow) and gray qualify; includeCmyBlacks adds rich blacks and includeSpotBlacks adds spot…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| remove | boolean | no | Clear overprint instead of setting it. Default false |
| percentage | number | no | Minimum black percentage. Default 100 |
| fill | boolean | no | Default true |
| stroke | boolean | no | Default true |
| includeCmyBlacks | boolean | no | Include blacks that also contain cyan, magenta or yellow. Default false |
| includeSpotBlacks | boolean | no | Include spot colours. Default false |
Fill (or stroke) items with a gradient swatch and place it the way the Gradient tool does: on each object, or with across: true as one gradient spanning all of them (one gradient across several objects). Give an angle, or from and to points to place it exactly like dragging the Gradient tool (for…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| gradient | string | yes | Gradient swatch name |
| library | string | no | Built-in library to load the gradient from when the document lacks it, e.g. "Gradients > Water" |
| stroke | boolean | no | Apply to strokes instead of fills. Default false |
| across | boolean | no | One gradient spanning the combined bounds of all the targets. Default false (each object gets its own) |
| angle | number | no | Degrees, counter-clockwise; 0 runs left to right. Default 0 |
| from | object | no | Start point, artboard points from the top-left |
| to | object | no | End point |
| artboardIndex | no | — |
List the colour settings files Illustrator offers (Edit > Color Settings), the default for this locale, and the active document's colour mode and assigned profile (Edit > Assign Profile shows it)
No parameter schema on file.
Apply a colour settings file (Edit > Color Settings > Settings): a name from get_color_settings, such as "North America General Purpose 2", or an absolute path to a .csf file. This changes Illustrator's colour management for every document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | A settings name from get_color_settings |
| filePath | string | no | Or an absolute path to a .csf file |
Colour display in the document window: choose the soft-proof condition (View > Proof Setup: working CMYK, legacy Mac RGB, sRGB, monitor RGB, or the protanopia and deuteranopia colour-blindness simulations), toggle View > Proof Colors, and toggle View > Show/Hide Gradient Annotator. Illustrator…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| proofSetup | string | no | — |
| toggleProofColors | boolean | no | Turn soft-proofing on or off. Default false |
| toggleGradientAnnotator | boolean | no | Show or hide the gradient annotator. Default false |
Set Character panel, OpenType panel and CJK character attributes on text frames, a character range of each, or the selected text: font and style, size, leading, kerning, tracking, scales, baseline shift, rotation, language, caps, superscript and subscript, underline, strikethrough, fill and…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| range | no | — | |
| fontStyle | string | no | A style of the text's current font family, e.g. "Bold", "Italic" or "Bold Italic" (the family of the first character of each range) |
| kerning | number | no | Manual kerning in thousandths of an em, at each character of the range |
Step text formatting up or down the way the Type keyboard commands do: font size up or down by points or by Font Size Step Up/Down, kern or track looser or tighter, Clear Tracking, Uniform Type (scales back to 100%), and Fit Headline (Type > Fit Headline, area type)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| range | no | — | |
| operation | string | yes | — |
| amount | number | no | Points for size_up/size_down (default 2); thousandths of an em for kern and track operations (default 20) |
Set Paragraph panel attributes on text frames, some of their paragraphs, or the selected text: alignment, indents, space before and after, hyphenation (the Hyphenation dialog), word and letter spacing, glyph scaling and auto leading (the Justification dialog), single-word justification, composer,…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| paragraphs | no | — |
Set the tab stops of text frames, some of their paragraphs, or the selected text (Tabs panel): left, centre, right and decimal tabs, leaders, the decimal character, and Repeat Tab. Replaces the existing stops; an empty list clears them
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| paragraphs | no | — | |
| stops | array | yes | Tab stops. position is in points from the left edge of the text |
| repeat | integer | no | Repeat Tab: add this many stops after the last one, each at the distance between the last two stops (or from 0 with one stop) |
Read the formatting of text frames or the selected text: character and paragraph attributes (of the first character and paragraph of the range), tab stops, the character and paragraph styles in use, and the frame's area type options and threads
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| range | no | — | |
| limit | integer | no | Most ranges to report |
List the document's character and paragraph styles (Character Styles and Paragraph Styles panels), optionally with their attributes
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | no | — |
| attributes | boolean | no | Include each style's attributes |
Create a character or paragraph style (New Character Style, New Paragraph Style), optionally from the formatting of existing text (its first character and paragraph), then with the given attributes, and optionally apply it to that text
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | — |
| name | string | yes | — |
| from | no | — | |
| apply | boolean | no | Apply the new style to the from text |
Change a character or paragraph style (Character Style Options, Paragraph Style Options): rename it and set attributes. reset first removes every attribute the style holds, so it keeps only the ones given
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | — |
| name | string | yes | — |
| newName | string | no | — |
| reset | boolean | no | — |
Delete character or paragraph styles by name (Delete Character Style, Delete Paragraph Style). Text using them keeps its look as local formatting; the [Normal] styles cannot be deleted
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | — |
| names | array | yes | — |
Apply a character style to text frames, a character range or the selected text, or a paragraph style to their paragraphs. clearOverrides removes local formatting that differs from the style. Without name, the text's current styles are reapplied with overrides cleared (Clear Overrides)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | — |
| name | string | no | Style to apply. Omit to clear overrides on the current styles |
| target | yes | — | |
| range | no | Character styles: … | |
| paragraphs | no | Paragraph styles: … | |
| clearOverrides | boolean | no | — |
Load character styles, paragraph styles or both from another Illustrator file (Load Character Styles, Load Paragraph Styles, Load All Styles). Styles with the same name are replaced
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path of an .ai file |
| kind | string | no | — |
Set text frame options: convert between point and area type (Type > Convert To Area Type / Point Type), resize the type area without scaling the text, Area Type Options (rows, columns, gutters, inset spacing, first baseline, text flow), Optical Margin Alignment and anti-aliasing
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| convertTo | string | no | Convert point type to area type or back first |
| width | number | no | Area type: width of the type area in points |
| height | number | no | Area type: height of the type area in points |
| rows | integer | no | — |
| rowGutter | number | no | Points |
| columns | integer | no | — |
| columnGutter | number | no | Points |
| inset | number | no | Inset spacing in points |
| firstBaseline | string | no | — |
| firstBaselineMin | number | no | First baseline minimum offset in points |
| textFlow | string | no | Text flow across rows first or down columns first |
| opticalMarginAlignment | boolean | no | Type > Optical Margin Alignment |
| antiAliasing | string | no | Anti-aliasing of the type in raster output |
Thread text between area or path type frames (Type > Threaded Text): link flows text through the frames in the order given; release takes the frames out of their threads, keeping the rest linked (Release Selection); remove breaks every thread through them, leaving the text in place (Remove…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | …. For link, give ids in reading order | |
| operation | string | yes | — |
| separateParagraphs | boolean | no | link: end each frame's text with a paragraph return before the next frame's text joins it |
List the action sets and their actions in the Actions panel (Window > Actions), as Illustrator stores them in its preferences. A set loaded or changed since Illustrator last stored its preferences may not show yet. With filePath, describe an .aia file instead: its set, actions and numbered steps…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | no | Absolute .aia path to describe instead of the panel |
Play an action from a loaded set (Actions panel > Play Current Selection). The action acts on the active document and its selection; give target to select items first. Steps run without their dialogs; recorded values are used. The result is the document and selection afterwards
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | Action name, exactly as in the Actions panel |
| set | string | yes | Name of the set that holds it |
| target | no | Select these items first |
Load an action set from an .aia file (Actions panel > Load Actions, or Replace Actions with replace: "all"). Before loading, the file can be edited: load the set under a new name, rename actions (Action Options), remove actions or steps, switch steps on or off (Toggle Item On/Off) and their…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .aia path |
| setName | string | no | Load the set under this name instead of the one in the file |
| actions | array | no | Edits to actions in the file, by name |
| replace | no | — | |
| saveAs | string | no | Also write the edited set to this .aia path |
| load | boolean | no | Load it into Illustrator. Default true; false with saveAs only writes the file |
Create an action set with new actions (Actions panel > Create New Set, Create New Action) from steps recorded in saved .aia files: each new action lists the steps it copies, as a whole saved action or one numbered step of it, and can switch each step or its dialog on or off. Then load the set,…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Set name |
| actions | array | yes | — |
| replace | no | — | |
| saveAs | string | no | Write the set to this .aia path |
| load | boolean | no | Load it into Illustrator. Default true |
Remove action sets or actions from the Actions panel (Delete Selection), or every set (Clear Actions). Removed sets are gone from the panel; save them first if they are not in a file. all: true removes the sets list_actions reports
| Parameter | Type | Required | Notes |
|---|---|---|---|
| set | string | no | Set name |
| actions | array | no | Actions in that set to remove. Default the whole set |
| all | boolean | no | Remove every set (Clear Actions) |
Play an action on every file in a folder, or on every data set of the active document, and save the results (does what Actions panel > Batch does, by script). Folder: each .ai, .pdf, .eps or .svg file is opened, the action played, and the file left open (destination none), saved in place and…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| set | string | yes | Action set name (Batch > Set) |
| action | string | yes | Action name (Batch > Action) |
| source | string | no | Batch > Source. Default folder |
| sourceFolder | string | no | Absolute folder path, for source folder |
| includeSubfolders | boolean | no | Include All Subdirectories. Default false |
| fileTypes | array | no | File extensions to open. Default ai, pdf, eps and svg |
| destination | string | no | Batch > Destination: none (leave open), save_and_close, folder. Default none |
| destinationFolder | string | no | Absolute folder path, for destination folder |
| fileNaming | string | no | Data sets to a folder: file_number (document name + 001), file_data_set (document name_data set name, default), data_set (data set name) |
| onError | string | no | stop at the first error (default) or carry on and list the errors |
| maxFiles | integer | no | Refuse a folder with more matching files than this. Default 200 |
Run a script file (File > Scripts > Other Script, or a script installed in File > Scripts given by its path): .jsx, .js or .jsxbin. Like execute_illustrator_code it runs unrestricted: it can change or delete anything and read or write files. The coordinate system is left as the script expects;…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .jsx, .js or .jsxbin path |
Import a CSV data source into data sets (Variables panel > Import, data merge): the first row names the fields, prefixed @ for an image variable (absolute file paths) and # for a visibility variable (true or false); other fields are text. Fields are separated by commas or tabs. Each row becomes a…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .csv or .txt path, UTF-8 |
| nameColumn | string | no | A column whose values name the data sets (not a variable). Default Row 1, Row 2, ... |
| show | string | no | Data set to display afterwards. Default the first row |
Read items' tags (name-value labels scripts attach to artwork) and notes (Attributes panel > Note). Without target, lists every item in the document that has a tag or a note
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | no | — | |
| limit | integer | no | Most items to return. Default 1000 |
Set items' tags (name-value labels scripts attach to artwork; not shown in Illustrator's panels) and note (Attributes panel > Note). tags maps names to text values; null removes a tag. Tag names use letters, digits and underscores
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| tags | object | no | Tag name to value (text), or null to remove that tag |
| clearTags | boolean | no | Remove every existing tag first. Default false |
| note | string | no | The note; "" clears it |
Place an image or other file at x, y on an artboard, linked or embedded (File > Place): PNG, JPEG, JPEG 2000, TIFF, PSD, GIF, BMP, WebP, AVIF, HEIC, TGA, PCX, PXR, PDF (a chosen page), EPS and DCS, SVG/SVGZ, AI, AutoCAD DWG/DXF, CGM, CorelDRAW, EMF/WMF. Give width to scale it proportionally. Text…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path |
| artboardIndex | no | — | |
| x | number | no | — |
| y | number | no | — |
| width | number | no | Scale proportionally to this width in points |
| embed | boolean | no | Embed instead of linking. Default false |
| layer | string | no | — |
| name | string | no | — |
| no | — | ||
| autocad | no | — |
Export artboards as PNG files, one per artboard, at a scale (100 = 72 ppi, 300 = 216 ppi)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFolder | string | yes | Absolute folder path |
| artboards | no | — | |
| scale | number | no | Percent. Default 100 |
| transparent | boolean | no | — |
| antiAlias | boolean | no | — |
| maxWidth | number | no | Fit each image within this width in pixels, instead of scale |
| maxHeight | number | no | Fit each image within this height in pixels, instead of scale |
| matteColor | string | no | Blend edges (and, with transparent false, the background) against this colour, #RRGGBB |
| saveAsHtml | boolean | no | Also write an HTML page showing each image. Default false |
| prefix | string | no | File name prefix. Default the document name |
Export artboards as JPEG files, one per artboard, at a quality and scale (100 = 72 ppi, 300 = 216 ppi). Transparent areas are filled with the matte colour
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFolder | string | yes | Absolute folder path |
| artboards | no | — | |
| quality | integer | no | JPEG quality, 0-100. Default 80 |
| scale | number | no | Percent. Default 100 |
| antiAlias | boolean | no | — |
| matteColor | string | no | Background for transparent areas, #RRGGBB. Default #FFFFFF |
| blur | number | no | Blur in pixels, 0-2, to reduce file size. Default 0 |
| optimized | boolean | no | Optimised (smaller) encoding. Default true |
| saveAsHtml | boolean | no | Also write an HTML page showing each image. Default false |
| prefix | string | no | File name prefix. Default the document name |
Save artboards as SVG files with the full SVG Options (File > Save As > SVG): profile, font subsetting, encoding, editing data, slices, XMP, variables, text options, SVGZ compression. For lean SVG for the web use export_web_svg
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFile | string | yes | Absolute .svg or .svgz path (.svgz is compressed). With several artboards Illustrator adds the artboard name to each file |
| artboards | no | — | |
| outlineText | boolean | no | Convert text to outlines in the SVG. Default false |
| embedImages | boolean | no | Embed raster images instead of linking. Default true |
| precision | integer | no | Decimal places |
| styling | string | no | Where CSS properties go: internal_css (style elements, default), inline_style, presentation_attributes, entities |
| preserveEditability | boolean | no | Keep Illustrator editing data so the SVG reopens fully editable. Default false |
| profile | string | no | SVG profile. Default svg_1.1 |
| fontSubsetting | string | no | Which glyphs of SVG fonts to embed (text not outlined). Default glyphs_used |
| encoding | string | no | Character encoding. Default utf8 |
| optimizeForSvgViewer | boolean | no | Optimise for the Adobe SVG Viewer |
| slices | boolean | no | Include slicing data |
| includeXmp | boolean | no | Include the document metadata (XMP) |
| includeUnusedStyles | boolean | no | Include unused graphic styles |
| includeVariables | boolean | no | Include Adobe Graphics Server data (variables and data sets) |
| fewerTspans | boolean | no | Output fewer <tspan> elements (lets the viewer kern text) |
| textOnPath | boolean | no | Use <textPath> for text on a path |
Export artboards as lean SVG for the web (File > Export > Export As > SVG): styling, object IDs, decimals, minify, responsive
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFile | string | yes | Absolute .svg path. With several artboards Illustrator adds the artboard name to each file |
| artboards | no | — | |
| styling | string | no | internal_css (a style element, default), inline_style, or presentation_attributes |
| outlineText | boolean | no | Convert text to outlines instead of SVG text. Default false |
| images | string | no | embed, link, or preserve (keep each image as it is placed). Default preserve |
| objectIds | string | no | layer_names (default), minimal, or unique |
| decimals | integer | no | Decimal places for coordinates |
| minify | boolean | no | Strip whitespace and shorten the markup. Default false |
| responsive | boolean | no | Omit width and height so the SVG scales to its container. Default true |
Export artboards, collected assets (list_assets) and the full document in several formats and scales in one pass (File > Export > Export for Screens, and the Asset Export panel). Scales apply to PNG and JPEG
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFolder | string | yes | Absolute folder path |
| formats | array | no | — |
| scales | array | no | One export per value (Add Scale), e.g. [1, 2, 3]. Default [1] |
| scaleBy | string | no | What scales mean: factor (2 = 2x, default), width or height in pixels, or resolution in ppi |
| artboards | no | Artboards to export, 1-based: "1", "1-3,5". Default all, or none when assets or fullDocument are given | |
| assets | array | no | Asset ids to export (list_assets, collect_assets) |
| fullDocument | boolean | no | Also export the whole document as one file. Default false |
| prefix | string | no | File name prefix |
| advanced | no | — | |
| openFolder | boolean | no | Open the folder when the export finishes. Default false |
Save a PDF copy of the document with a PDF preset (e.g. "[High Quality Print]", "[PDF/X-4:2008]"), optionally overriding its compatibility, PDF/X standard, image compression and downsampling, font subsetting, bleed, printer's marks, colour conversion, output intent, transparency flattening,…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFile | string | yes | Absolute .pdf path |
| preset | string | no | PDF preset name as Illustrator lists it. Default "[High Quality Print]". The options below override it |
| artboards | no | — | |
| preserveEditability | boolean | no | Keep Illustrator editing data in the PDF. Default false |
| compatibility | string | no | Acrobat version: acrobat4 (PDF 1.3) to acrobat8 (PDF 1.7) |
| standard | string | no | PDF/X standard. A PDF/X preset sets this and the matching compatibility for you |
| bleed | number | no | Bleed on every side, in points |
| marks | array | no | Printer's marks to add: trim, registration, color_bars, page_info, or all. An empty list removes them |
| markType | string | no | Printer's mark style. Default roman |
| trimMarkWeight | string | no | Trim mark weight in points |
| markOffset | number | no | Distance between the artboard and the marks, in points |
| colorConversion | string | no | none; convert_to_destination; or preserve_numbers (convert only colours with a different profile) |
| destination | string | no | Destination colour space for conversion |
| profileInclusion | string | no | Which ICC profiles to embed |
| outputIntent | string | no | PDF/X output intent profile name, e.g. "Coated FOGRA39 (ISO 12647-2:2004)" |
| outputCondition | string | no | PDF/X output condition description |
| outputConditionId | string | no | PDF/X output condition identifier, e.g. "FOGRA39" |
| registryName | string | no | PDF/X registry, e.g. "http://www.color.org" |
| acrobatLayers | boolean | no | Make Acrobat layers from top-level layers (acrobat6 or later) |
| fastWebView | boolean | no | Optimise for fast web view |
Put text on or inside a path (Type on a Path tool, or the Area Type tool on a shape). kind path runs the text along the path; area flows it inside the shape. The path becomes the text's path, as with the tools; give keepPath to leave the original in place
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | One path (not a group or compound path) | |
| contents | string | yes | The text. Use \r for new paragraphs |
| kind | string | no | path: along the path; area: inside the shape |
| orientation | string | no | Vertical Type on a Path / Vertical Area Type. Default horizontal |
| font | string | no | PostScript font name (list_fonts) |
| size | number | no | Font size in points |
| start | number | no | Path text: where the text starts, 0 (path start) to 1 (path end), counted by segments |
| end | number | no | Path text: where the text ends, 0 to 1 |
| keepPath | boolean | no | Keep the original path as well. Default false |
| name | string | no | Name for the new text frame |
Change type on a path (Type > Type on a Path and Type on a Path Options): apply an effect (rainbow, skew, 3D ribbon, stair step, gravity), slide the text along the path with start and end, set spacing, flip the text to the other side of the path, or update legacy path type. Align to Path…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| effect | string | no | Type > Type on a Path effect |
| start | number | no | Where the text starts, 0 (path start) to 1 (path end), counted by segments |
| end | number | no | Where the text ends, 0 to 1 |
| spacing | number | no | Spacing (Type on a Path Options): space added between characters on tight curves, in points |
| flip | boolean | no | true: flip the text to the other side of the path, by reversing the path's direction (Object > Path > Reverse Path Direction). Flipping again flips back |
| updateLegacy | boolean | no | true: Type > Type on a Path > Update Legacy Type on a Path, first |
Insert a special, white space or break character into text frames (Type > Insert Special Character, Insert White Space Character, Insert Break Character): symbols, dashes, quotation marks, spaces and forced line break. At the start, at the end, or at a character index
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| character | string | yes | — |
| position | string | no | — |
| index | integer | no | Insert before this character (0-based); overrides position |
| count | integer | no | How many to insert |
Replace keyboard punctuation with typographer's punctuation, the way Type > Smart Punctuation does: straight quotes to curly quotes, -- to an en dash and --- to an em dash, ... to an ellipsis, multiple spaces after a period to one, and optionally ff/fi/fl/ffi/ffl ligatures and fractions such as…
No parameter schema on file.
Fill text frames with placeholder text (Type > Fill With Placeholder Text). Area text is filled to the edge of its frame; point and path text get one sentence. Existing text is replaced
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Run a Type or Edit menu command that opens no dialog: convert_bullets_to_text (Type > Bullets and Numbering > Convert to text, on the targets), show_hidden_characters (Type > Show Hidden Characters) or auto_spell_check (Edit > Spelling > Auto Spell Check). The last two switch the setting on or off…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| command | string | yes | — |
| target | no | Text frames, for convert_bullets_to_text |
List the fonts used in the document's text, with how many characters use each and whether each is missing (not installed or activated)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | no | — |
Replace fonts in the document's text (Type > Find/Replace Font, and the replace step of Type > Resolve Missing Fonts): every run in the from fonts, or in every missing font, gets the to font. Other formatting is kept. Activating fonts from Adobe Fonts is not done
| Parameter | Type | Required | Notes |
|---|---|---|---|
| to | string | yes | PostScript name of the replacement font (list_fonts) |
| from | array | no | PostScript names to replace (list_document_fonts) |
| missing | boolean | no | Replace every missing font |
| target | no | — |
Find text across the document or in text frames, and optionally replace it (Edit > Find and Replace, Find Next), with Match Case and Whole Word. Without replace, matches are listed, and selectMatch selects one of them in the text, like Find Next. Formatting is kept; threaded frames are searched as…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| find | string | yes | — |
| replace | string | no | Replacement text. Omit to only find |
| matchCase | boolean | no | — |
| wholeWord | boolean | no | — |
| target | no | — | |
| selectMatch | integer | no | Find only: select this match (0-based) in the text |
Make or release text wrap on objects (Object > Text Wrap > Make, Release, Text Wrap Options): text in frames below the object flows around it, at an offset, or inside it with invert. The object must be above the text
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| wrap | boolean | no | true: Make; false: Release. Default true |
| offset | number | no | Offset in points between the object and the text |
| invert | boolean | no | Invert Wrap: flow the text inside the object |
List the document's stories (the text in one frame, or flowing through threaded frames), with their frames, length and the start of their text, plus how many legacy text objects need updating
| Parameter | Type | Required | Notes |
|---|---|---|---|
| includeText | boolean | no | Return each story's full text (up to 10000 characters) instead of the first 80 |
| limit | integer | no | — |
Update legacy text (from Illustrator 10 or earlier) so it can be edited (Type > Legacy Text > Update All Legacy Text, or Update Selected Legacy Text for the targets). Line breaks and spacing can shift as the text is recomposed
| Parameter | Type | Required | Notes |
|---|---|---|---|
| all | boolean | no | Update every legacy text object in the document |
| target | no | Legacy text objects to update (instead of all) |
Make text frames horizontal or vertical (Type > Type Orientation)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| orientation | string | yes | — |
Bring a plain text file (.txt, UTF-8) into the document: into a new point or area text frame at x, y, or replacing the text of one frame (File > Place for text). Line breaks become paragraphs
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .txt path |
| target | no | One text frame whose text is replaced. Omit to make a new frame at x, y | |
| artboardIndex | no | — | |
| x | number | no | New frame: left, in points from the artboard |
| y | number | no | New frame: top (area text) or first baseline (point text) |
| width | number | no | New area text frame width; omit for point text |
| height | number | no | New area text frame height |
| layer | string | no | Layer for a new frame. Default: the active layer |
Save text to a plain text file (.txt, UTF-8): the stories of the given frames, or every story in the document, separated by blank lines (File > Export > Text Format)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .txt path; an existing file is replaced |
| target | no | — |
Set Japanese and other Asian composition on text frames: the Adobe Asian (Latin and CJK) composer, single-line or every-line; kinsoku shori and mojikumi sets (by the names the document defines) and the kinsoku order; and the character options tsume, aki, tate-chu-yoko and warichu
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| composer | string | no | Use the Latin and CJK composer, single-line or every-line |
| kinsoku | string | no | Kinsoku shori set name, e.g. "Hard" or "Soft" (the document's sets are listed if the name is wrong) |
| kinsokuOrder | string | no | Kinsoku type: push in first, push out first, or push out only |
| mojikumi | string | no | Mojikumi set name (the document's sets are listed if the name is wrong) |
| tsume | number | no | Tsume: % of space removed around each character |
| akiLeft | number | no | Aki before each character, in ems |
| akiRight | number | no | Aki after each character, in ems |
| tateChuYoko | boolean | no | Tate-chu-yoko: set the characters horizontally within vertical text |
| wariChu | boolean | no | Warichu: set the characters in smaller lines within one line |
| wariChuLines | integer | no | — |
| wariChuScale | number | no | Warichu size, % |
Set up Arabic and Hebrew text on text frames: paragraph direction, the Middle Eastern composer, digit set, kashidas and character direction
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| direction | string | no | Paragraph direction |
| composer | string | no | Composer engine: middle_eastern for Arabic and Hebrew, latin_cjk for the standard composer |
| digits | string | no | Digit set |
| kashidas | string | no | Insert kashidas to justify Arabic text |
| characterDirection | string | no | Character direction override |
List items with their id, name, type, layer and position. Filter by layer, artboard or type. Ids are what other tools take in target.ids
| Parameter | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | Only items on this layer (and its sublayers) |
| artboardIndex | no | Only items whose centre is on this artboard | |
| type | string | no | — |
| topLevelOnly | boolean | no | Skip items inside groups. Default true |
| limit | integer | no | — |
Describe the current selection
No parameter schema on file.
Select items (replacing the current selection). Menu commands act on the selection
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Deselect everything in the active document
No parameter schema on file.
Select every object that shares an attribute with the targets (Select > Same), e.g. all objects with the same fill colour. The targets are selected first and set the attribute
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| attribute | string | yes | — |
Select all unlocked, visible objects in the document, or on one artboard (Select > All, All on Active Artboard)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| artboardIndex | integer | no | Only this artboard (0-based). Default the whole document |
Delete items from the document (Illustrator's Edit > Undo can restore them)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Duplicate items, offsetting each copy by dx, dy points. With count > 1, each copy is offset from the previous one (step and repeat)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| dx | number | no | — |
| dy | number | no | — |
| count | integer | no | — |
Move items by dx, dy points, or place their top-left corner at x, y on an artboard
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| dx | number | no | — |
| dy | number | no | — |
| x | number | no | — |
| y | number | no | — |
| artboardIndex | no | — |
Scale items by a percentage. Give scale for uniform scaling, or scaleX and scaleY
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| scale | number | no | Percent, e.g. 150 |
| scaleX | number | no | — |
| scaleY | number | no | — |
| origin | no | — | |
| scaleStrokes | boolean | no | Scale stroke weights too. Default true |
Rotate items by an angle in degrees (counter-clockwise, as in Illustrator)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| angle | number | yes | — |
| origin | no | — |
Flip items horizontally or vertically around their centre
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| axis | string | yes | horizontal flips left-right |
Align items to each other (their combined bounds), to an artboard, or to a key object that stays still (Object > Align, Align panel). center_middle centres both ways in one step
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| edge | string | yes | — |
| to | string | no | Default selection |
| artboardIndex | no | — | |
| keyObjectId | string | no | With to: key_object, the id of the item the others align to |
| usePreviewBounds | boolean | no | Measure including strokes and effects (Use Preview Bounds). Default true |
Change stacking order: bring to front, bring forward, send backward, send to back
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| order | string | yes | — |
Group items. The group is created where the frontmost item is
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| name | string | no | — |
Ungroup groups, leaving their contents in place. With allLevels, ungroup every level of nested groups at once (Object > Ungroup All, Illustrator 29.3 or later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| allLevels | boolean | no | Ungroup nested groups too (Object > Ungroup All). Default false: one level |
Clip items with a path: the clipping path shows only the artwork inside it. clipPath must be a path id; it is moved above the other items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| clipPathId | string | yes | Id of the path to clip with |
Combine paths into one compound path (Object > Compound Path > Make): overlapping areas become holes
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Draw a rectangle, optionally with rounded corners. x and y are the top-left corner in points from the artboard's top-left
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | number | yes | — |
| y | number | yes | — |
| width | number | yes | — |
| height | number | yes | — |
| cornerRadius | number | no | Corner radius in points. Default 0 |
Draw an ellipse inside the box whose top-left corner is x, y
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | number | yes | — |
| y | number | yes | — |
| width | number | yes | — |
| height | number | yes | — |
Draw a regular polygon centred on centerX, centerY
| Parameter | Type | Required | Notes |
|---|---|---|---|
| centerX | number | yes | — |
| centerY | number | yes | — |
| radius | number | yes | — |
| sides | integer | no | — |
Draw a star centred on centerX, centerY
| Parameter | Type | Required | Notes |
|---|---|---|---|
| centerX | number | yes | — |
| centerY | number | yes | — |
| radius | number | yes | Outer radius |
| innerRadius | number | no | Default half the outer radius |
| points | integer | no | — |
Draw a straight line (Line Segment tool) from x1, y1 to x2, y2, or from x1, y1 with a length and angle as in the tool's options dialog. With fill, the line is filled (Fill Line)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x1 | number | yes | — |
| y1 | number | yes | — |
| x2 | number | no | — |
| y2 | number | no | — |
| length | number | no | Length in points, instead of x2, y2 |
| angle | number | no | With length: degrees counterclockwise from the 3 o'clock direction. Default 0 |
Draw a path through points. Each point is [x, y], or an object with x, y and optional curve handles in and out ([x, y] in the same coordinates)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| points | array | yes | — |
| closed | boolean | no | — |
Add text. Point text grows with its content from x, y (the left end of the first baseline); area text flows inside a box of width and height whose top-left is x, y
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contents | string | yes | The text. Use \r for new paragraphs |
| kind | string | no | — |
| x | number | yes | — |
| y | number | yes | — |
| width | number | no | Area text only |
| height | number | no | Area text only |
| font | string | no | PostScript font name, e.g. "MyriadPro-Regular" (see list_fonts) |
| size | number | no | Font size in points |
| color | no | — | |
| justification | string | no | — |
| leading | number | no | Leading in points (turns off auto leading) |
| tracking | number | no | Tracking in thousandths of an em |
| layer | no | — | |
| name | no | — |
Set font, size, colour, justification, leading or tracking on whole text frames
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| font | string | no | PostScript font name |
| size | number | no | — |
| color | no | — | |
| justification | string | no | — |
| leading | number | no | — |
| tracking | number | no | — |
Replace the text of text frames. Character formatting of the first character is kept
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| contents | string | yes | — |
Convert text frames to outlined artwork (Type > Create Outlines). The text is no longer editable
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
List installed fonts whose name, family or style contains the query
| Parameter | Type | Required | Notes |
|---|---|---|---|
| query | string | no | Case-insensitive text to match |
| limit | integer | no | — |
List the assets collected for export in the document (Window > Asset Export): id, name and the file name they export as. Pass the ids to export_for_screens to export them
No parameter schema on file.
Add artwork to the Asset Export panel (Collect for Export > As Single Asset, or As Multiple Assets). Returns the new asset ids for export_for_screens
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| as | string | no | single: one asset from all the targets; multiple: one asset per target. Default single |
| names | array | no | Asset names: one for single, one per target (in target order) for multiple. Default Illustrator's names |
Rename an asset in the Asset Export panel. The name is the exported file name
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | integer | yes | Asset id (list_assets) |
| name | string | yes | New name |
Remove assets from the Asset Export panel. The artwork stays in the document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ids | array | no | Asset ids (list_assets) |
| all | boolean | no | Remove every asset |
Export the selected artwork on its own (File > Export Selection), as a PNG at 100% or as an Illustrator file. For other formats and scales, collect_assets and export_for_screens with the asset ids
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFile | string | yes | Absolute path ending in .png or .ai |
| target | no | Select these items first. Default the current selection |
List object-based slices (items made into slices with Object > Slice > Make) and sliced layers, with each slice's URL. User slices drawn with the Slice Tool are not listed
No parameter schema on file.
Run an Object > Slice command: make (object-based slices from the targets), release, create_from_selection, create_from_guides, duplicate, combine, clip_to_artboard (toggle), delete_all; or View > Show / Hide Slices (toggle_visibility) and Lock Slices (toggle_lock). create_region makes a slice…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | — |
| target | no | Select these items first. make, release, create_from_selection, duplicate and combine act on the selection | |
| x | number | no | create_region: left edge, points from the artboard's left |
| y | number | no | create_region: top edge, points from the artboard's top |
| width | number | no | create_region: points |
| height | number | no | create_region: points |
| artboardIndex | no | — |
Set the URL of items (Attributes panel URL, used for image maps, and the URL of object-based slices). An empty url clears it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| url | string | yes | e.g. "https://example.com/page". Empty to clear |
Start an untitled document from an Illustrator template (.ait) file (File > New from Template). The template itself is not changed
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path to an .ait file |
Write a copy of the active document's saved file to another path; the document stays open and keeps referring to its own file (File > Save a Copy). The document must be saved with no unsaved changes, and the copy keeps its format
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path for the copy, with the same extension as the document's file |
| overwrite | boolean | no | Replace an existing file at filePath. Default false |
Discard the active document's unsaved changes by reloading its saved file (File > Revert). Undo history is lost
No parameter schema on file.
Close every open document (File > Close All). Unsaved changes are discarded unless save is true; with save, every document with changes must already have a file
| Parameter | Type | Required | Notes |
|---|---|---|---|
| save | boolean | no | Save changes before closing. Default false |
List the new-document presets (Print, Web, Mobile, Film & Video, Art & Illustration and saved custom presets) with their size, units and colour mode, for create_document_from_preset
No parameter schema on file.
Create a document from a new-document preset (File > New), overriding its name, size, orientation, units, colour mode, raster effects resolution, preview mode, transparency grid and bleed. list_document_presets names the presets
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | yes | Preset name, e.g. "Print", "Web", "Mobile" |
| title | string | no | Name of the new document |
| width | number | no | Artboard width in points |
| height | number | no | Artboard height in points |
| orientation | string | no | Swap width and height to match |
| units | string | no | Ruler and field units of the document |
| colorMode | string | no | — |
| rasterEffects | string | no | Raster effects resolution: screen 72, medium 150, high 300 ppi |
| previewMode | string | no | — |
| transparencyGrid | string | no | Transparency grid colours |
| bleed | number | no | Bleed on every side, in points |
Report the active document's Document Setup values the object model exposes: units, colour mode, large canvas, Show Images in Outline Mode, and each artboard's ruler origin
No parameter schema on file.
Change document settings: colour mode (File > Document Color Mode, converting every colour), an artboard's ruler origin, conversion to a large canvas, or switch to the Artboard tool (Document Setup > Edit Artboards). Units, bleed and the other Document Setup options can only be set in the dialog;…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| colorMode | string | no | Convert the document to CMYK or RGB |
| rulerOrigin | object | no | Ruler zero point of an artboard, in points from its top-left corner. { x: 0, y: 0 } restores the default |
| artboardIndex | no | Artboard whose ruler origin is set (0-based). Default the active artboard | |
| largeCanvas | boolean | no | true converts the document to a large canvas (10 times the standard maximum size). It cannot be converted back |
| editArtboards | boolean | no | true switches to the Artboard tool so the user can edit artboards |
Open a file with Illustrator's open options: update legacy text and gradient meshes, convert a pre-CS4 document's crop area, print tiles or artwork bounds to artboards, keep it off the recent files list, or open it as a swatch, brush, symbol or graphic style library. Use open_document for a plain…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path |
| updateLegacyText | boolean | no | Update type from documents saved before Illustrator CS |
| updateLegacyGradientMesh | boolean | no | Keep spot colours in gradient meshes from documents saved before CS3 |
| preserveLegacyArtboard | boolean | no | Pre-CS4 documents: keep the legacy artboard |
| convertCropAreaToArtboard | boolean | no | Pre-CS4 documents: turn the crop area into an artboard (otherwise it is discarded) |
| convertTilesToArtboards | boolean | no | Pre-CS4 documents: turn print tiles into artboards |
| createArtboardFromArtworkBounds | boolean | no | Pre-CS4 documents: make an artboard the size of the artwork |
| addToRecentFiles | boolean | no | List the file under File > Open Recent Files |
| openAs | string | no | Open as a document (default) or as a library panel |
Read the active document's metadata (File > File Info): title, authors, description, keywords, copyright, and the dates and creator tool, from its XMP packet
| Parameter | Type | Required | Notes |
|---|---|---|---|
| includeXmp | boolean | no | Also return the whole XMP packet. Default false |
Set the active document's metadata (File > File Info). Each field given replaces the stored value; an empty value removes it. Or pass xmp to replace the whole XMP packet. Saved with the document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| title | string | no | — |
| authors | array | no | — |
| description | string | no | — |
| keywords | array | no | — |
| copyright | string | no | Copyright notice |
| xmp | string | no | A complete XMP packet (from get_file_info includeXmp). Not combined with the fields |
Cut or copy items, or paste the clipboard (Edit > Cut, Copy, Paste, Paste in Place, Paste on All Artboards, Paste without Formatting). Pasted items are selected and returned
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | — |
| target | no | cut and copy: the items. Default the current selection | |
| artboardIndex | no | paste_in_place: the artboard to paste onto (0-based). Default the active artboard |
Bring an open document to the front by name or by its list_documents index, or move to the next or previous document or document group (Window menu document navigation)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | Document name, as list_documents gives it |
| index | integer | no | Position in list_documents, which changes as documents are activated |
| direction | string | no | — |
Describe the active document: name, file, colour mode, artboards with their sizes, layers, item counts and selection
No parameter schema on file.
List the open documents and which one is active
No parameter schema on file.
Create a document. The colour mode cannot be changed later without converting every colour, so choose CMYK for print and RGB for screen
| Parameter | Type | Required | Notes |
|---|---|---|---|
| colorMode | string | yes | CMYK for print, RGB for screen |
| width | number | no | Artboard width in points (72 pt = 1 in). Default 612 |
| height | number | no | Artboard height in points. Default 792 |
| artboards | integer | no | Number of artboards. Default 1 |
| artboardLayout | string | no | How several artboards are arranged. Default GridByRow |
| artboardSpacing | number | no | Space between artboards in points. Default 20 |
| columns | integer | no | Columns (or rows, for column layouts) in a grid |
Open a file as a new document (File > Open): Illustrator (.ai, .ait template), PDF, EPS, SVG/SVGZ, AutoCAD DWG/DXF, images (PSD, TIFF, PNG, JPEG, JPEG 2000, GIF, BMP, WebP, AVIF, HEIC, TGA, PCX, PXR), CGM, CorelDRAW, EMF/WMF, and Word, RTF or text (opened with Illustrator's last-used import…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path |
| no | — | ||
| autocad | no | — |
Save the active document. With filePath, save it as an Illustrator (.ai) or Illustrator EPS (.eps) file there; the document then refers to that file. Can also save each artboard to its own file
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | no | Absolute .ai or .eps path. Omit to save in place |
| compatibility | string | no | Illustrator version to save for: 24 = Illustrator 2020 and later (default), 17 = CC, 16 = CS6 |
| separateArtboards | boolean | no | Also save each artboard to its own file, named after the artboard. Default false |
| artboards | string | no | With separateArtboards: the artboards to save, 1-based: "1", "1-3,5". Default all |
| embedLinkedFiles | boolean | no | Embed linked images. Default false |
| pdfCompatible | boolean | no | .ai: embed a PDF-compatible copy so other apps can preview it. Default true. False gives a much smaller native file |
| compressed | boolean | no | .ai: compress the file. Default true |
| embedIccProfile | boolean | no | .ai: embed the document's colour profile. Default true |
| fontSubsetThreshold | number | no | .ai: subset embedded fonts when less than this percent of their characters is used. Default 100 |
| preview | string | no | .eps: preview format. Default tiff_color |
| postScript | integer | no | .eps: PostScript level. Default 3 |
| embedFonts | boolean | no | .eps: include document fonts. Default true |
| cmykPostScript | boolean | no | .eps: include CMYK PostScript in RGB files. Default true |
| compatibleGradientPrinting | boolean | no | .eps: rasterise gradients and meshes for older PostScript printers. Default false |
| thumbnails | boolean | no | .eps: include a thumbnail. Default true |
| overprint | string | no | .eps: keep or discard overprints. Default preserve |
| transparency | string | no | Saving for Illustrator 8 or 3 only, which have no transparency: preserve_paths (discard transparency) or preserve_appearance (flatten it) |
Close the active document. Unsaved changes are discarded unless save is true
| Parameter | Type | Required | Notes |
|---|---|---|---|
| save | boolean | no | Save before closing. Default false |
List artboards with their position and size in points. x and y are measured from artboard 0's top-left corner
No parameter schema on file.
Add an artboard. x and y are measured from artboard 0's top-left corner, in points
| Parameter | Type | Required | Notes |
|---|---|---|---|
| x | number | yes | — |
| y | number | yes | — |
| width | number | yes | — |
| height | number | yes | — |
| name | string | no | — |
Rename, move or resize an artboard, or switch it between portrait and landscape (Object > Artboards > Switch Orientation). Position is measured from artboard 0's top-left corner. scaleArtwork scales and moves the artwork on it with it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| artboardIndex | yes | — | |
| name | string | no | — |
| x | number | no | — |
| y | number | no | — |
| width | number | no | — |
| height | number | no | — |
| orientation | string | no | Swap width and height to make it portrait or landscape, or switch whichever it is. The top-left corner stays put |
| scaleArtwork | boolean | no | Scale and move the artwork whose centre lies on the artboard along with it. Default false |
Delete an artboard. Its artwork stays on the canvas. The last artboard cannot be deleted
| Parameter | Type | Required | Notes |
|---|---|---|---|
| artboardIndex | yes | — |
Make an artboard active (the one Illustrator's artboard commands and menu commands act on)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| artboardIndex | yes | — |
Resize an artboard to the bounds of the given artwork (Object > Artboards > Fit to Selected Art), or without target, to all the artwork on it (Fit to Artwork Bounds)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| artboardIndex | yes | — | |
| target | no | Fit to these items. Default: all the artwork on the artboard |
Arrange all artboards in a grid, row or column
| Parameter | Type | Required | Notes |
|---|---|---|---|
| layout | string | no | Default GridByRow |
| columns | integer | no | Columns (rows for column layouts). Default 1 |
| spacing | number | no | Points between artboards. Default 20 |
| moveArtwork | boolean | no | Move artwork with its artboard. Default true |
List top-level layers and their sublayers, with visibility, lock state, Layer Options and item counts
No parameter schema on file.
Create a layer at the top of the stack, or as a sublayer of parentLayer, with the Layer Options settings (Layers panel menu > New Layer, New Layer with Dialog)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
| parentLayer | string | no | Create inside this layer |
| visible | boolean | no | — |
| locked | boolean | no | — |
| printable | boolean | no | — |
Rename a layer, show or hide it, lock it, set whether it prints, its opacity, Layer Options (colour, preview, dim images), knockout group, or move it in the stack
| Parameter | Type | Required | Notes |
|---|---|---|---|
| layer | string | yes | Layer name |
| newName | string | no | — |
| visible | boolean | no | — |
| locked | boolean | no | — |
| printable | boolean | no | — |
| opacity | number | no | — |
| arrange | string | no | — |
| knockout | string | no | Knockout Group (Transparency panel): whether the layer's objects knock each other out |
Make a layer active: new artwork goes on it when a tool is not given a layer
| Parameter | Type | Required | Notes |
|---|---|---|---|
| layer | string | yes | — |
Delete a layer and everything on it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| layer | string | yes | — |
Move items to the top of another layer, or of the active layer when layer is omitted (Object > Arrange > Send to Current Layer)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| layer | string | no | Top-level layer name. Default the active layer |
Apply a Live Effect to items (Effect menu): Stylize, Distort & Transform, Warp, Path, Convert to Shape, Crop Marks, Rasterize, Gaussian Blur and NTSC Colors. It stays editable in the Appearance panel unless expand is true, which turns the result into plain artwork. Raster effects render at the…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| effect | string | yes | — |
| options | object | no | The effect's options, as listed in the tool description |
| expand | boolean | no | Expand the result to plain artwork (Object > Expand Appearance). Default false |
Combine shapes as the Pathfinder panel does: unite, minus front, intersect, exclude, divide, trim, merge, crop, outline, minus back, and the Effect > Pathfinder colour operations hard mix, soft mix and trap. The items are grouped and the Pathfinder effect applied; with expand (default) the result…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| operation | string | yes | — |
| expand | boolean | no | Expand the result to plain paths. Default true |
| precision | number | no | Pathfinder Options > Precision. Default 10 |
| removeRedundantPoints | boolean | no | Pathfinder Options > Remove Redundant Points. Default false |
| removeUnpainted | boolean | no | Divide and Outline: remove unpainted artwork. Default false |
| mixRate | number | no | Soft mix: mixing rate in percent. Default 50 |
| trapThickness | number | no | Trap: thickness in points. Default 0.25 |
| trapHeightWidth | number | no | Trap: height/width in percent. Default 100 |
| trapTintReduction | number | no | Trap: tint reduction in percent. Default 40 |
| trapReverse | boolean | no | Trap: reverse traps. Default false |
| method | string | no | effect (default) applies the Pathfinder effect; menu runs the Live Pathfinder menu command on the selection instead (not for soft mix or trap, whose commands open a dialog) |
Apply an SVG filter to items as a Live Effect (Effect > SVG Filters): one of the filters new documents carry (…) or the name of another SVG filter in the document. The filter must exist in the document. Use expand to turn the result into plain artwork
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| filter | string | yes | SVG filter name, e.g. AI_Shadow_1 |
| method | string | no | effect (default) applies the filter to each item; menu runs the preset's Effect > SVG Filters command on the selection (built-in filters only) |
| expand | boolean | no | Expand the result (Object > Expand Appearance). Default false |
Apply the most recently used effect again, with the same settings, to items (Effect > Apply Last Effect). Nothing changes if no effect has been applied in this Illustrator session
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| expand | boolean | no | Expand the result (Object > Expand Appearance). Default false |
Set the document raster effects settings (Effect > Document Raster Effects Settings): the colour model, resolution, background, anti-aliasing, clipping mask, added space and spot colours that raster effects such as drop shadows, glows, blurs and Rasterize use. Give only what should change; called…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| colorModel | string | no | document (RGB or CMYK, as the document), grayscale or bitmap |
| resolution | number | no | Pixels per inch (Screen 72, Medium 150, High 300) |
| transparent | boolean | no | Transparent background (false: white) |
| antiAlias | boolean | no | Anti-alias the rasterized edges |
| clippingMask | boolean | no | Create a clipping mask |
| padding | number | no | Add Around Object, in points |
| preserveSpotColors | boolean | no | Keep spot colours (false converts them to process) |
Read Illustrator preferences: …. Omit names to read them all
| Parameter | Type | Required | Notes |
|---|---|---|---|
| names | array | no | — |
Change Illustrator preferences. They persist, as if set in the Preferences dialog. Pass an object of name: value
No parameter schema on file.
Switch Illustrator to a tool, ready for the user to draw with it. Name it as Illustrator does, e.g. "Pen Tool", "Shape Builder Tool", "Width Tool", "Column Graph Tool", "Mesh Tool", "Blend Tool"
| Parameter | Type | Required | Notes |
|---|---|---|---|
| tool | string | yes | Tool name |
Export as a Photoshop file (File > Export > Export As > Photoshop): colour model, resolution, layers, editable text, maximum editability, anti-aliasing, ICC profile, one file per artboard
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFile | string | yes | Absolute .psd path |
| useArtboards | no | — | |
| artboards | no | — | |
| colorModel | no | — | |
| resolution | no | — | |
| writeLayers | boolean | no | Keep layers as Photoshop layers instead of flattening. Default true |
| editableText | boolean | no | Keep text editable where possible. Default true |
| maximumEditability | boolean | no | Write each top-level sublayer as a layer to keep as much editable as possible. Default true |
| antiAlias | boolean | no | Anti-alias the artwork. Default true |
| embedIccProfile | boolean | no | Embed the colour profile. Default false |
Export as TIFF (File > Export > Export As > TIFF): colour model, resolution, anti-aliasing, LZW compression, byte order, ICC profile, one file per artboard
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFile | string | yes | Absolute .tif or .tiff path |
| useArtboards | no | — | |
| artboards | no | — | |
| colorModel | no | — | |
| resolution | no | — | |
| antiAlias | string | no | art_optimized (default), type_optimized or none |
| lzw | boolean | no | LZW compression. Default false |
| byteOrder | string | no | ibm_pc (default) or macintosh |
| embedIccProfile | boolean | no | Embed the colour profile. Default false |
Export artboards as GIF or PNG-8 with a reduced colour table, one per artboard (File > Export > Save for Web (Legacy)): colours, reduction, dither, transparency, matte, web snap, lossy GIF, interlacing, scale, HTML
| Parameter | Type | Required | Notes |
|---|---|---|---|
| format | string | yes | gif or png8 |
| outputFolder | string | yes | Absolute folder path |
| artboards | no | — | |
| clipToArtboard | boolean | no | Crop each image to its artboard. False writes one image of all the artwork. Default true |
| colors | integer | no | Colours in the colour table. Default 128 |
| reduction | string | no | Colour reduction: perceptual, selective (default), adaptive or web |
| dither | string | no | none, diffusion (default), pattern or noise |
| ditherAmount | number | no | Percent, with diffusion dither |
| lossy | number | no | GIF only: lossy compression, 0-100. Default 0 |
| transparent | boolean | no | Keep transparency. Default true |
| matteColor | string | no | Blend edges (and, with transparent false, the background) against #RRGGBB, or "none". Default white |
| webSnap | number | no | Percent tolerance for shifting colours to the web palette. Default 0 |
| interlaced | boolean | no | Interlaced image. Default false |
| antiAlias | boolean | no | — |
| scale | number | no | Percent. Default 100 |
| verticalScale | number | no | Vertical percent when different from scale |
| saveAsHtml | boolean | no | Also write an HTML page showing each image. Default false |
| prefix | string | no | File name prefix. Default the document name |
Export as an AutoCAD drawing, DWG or DXF by the file extension (File > Export > Export As > AutoCAD): AutoCAD version, scale and units, line weights, colours, raster format, appearance or editability, selected art only, outlined text
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFile | string | yes | Absolute .dwg or .dxf path |
| version | string | no | AutoCAD release: r13, r14, r15 (2000), r18 (2004), r21 (2007), r24 (2010 and later) |
| unit | string | no | Unit that one drawing unit maps from |
| unitRatio | number | no | Drawing units per unit, e.g. 1 for 1 millimeter = 1 unit |
| scaleLineweights | boolean | no | Scale line weights with the drawing |
| colors | string | no | Number of colours: 8, 16, 256 or true_color |
| rasterFormat | string | no | Format for raster artwork |
| preserve | string | no | Preserve appearance, or maximum editability |
| selectedOnly | boolean | no | Export only the selected artwork |
| alterPaths | boolean | no | Alter paths for appearance |
| outlineText | boolean | no | Convert text to outlines |
Write only the selected artwork (or the items given) to a new Illustrator file, leaving the document as it is (File > Export Selection as AI)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFile | string | yes | Absolute .ai path |
| target | no | — |
Place the contents of a plain-text (.txt) file as type at x, y on an artboard (File > Place with a text file): point text, or area text when width and height are given
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .txt path |
| encoding | string | no | utf8 (default), utf16 or latin1 |
| artboardIndex | no | — | |
| x | number | no | — |
| y | number | no | — |
| width | number | no | Area text: box width in points |
| height | number | no | Area text: box height in points |
| layer | string | no | — |
| name | string | no | — |
List linked and embedded images and other non-native art (the Links panel and Links information): file name, path, format, size on disk, modified date, missing links, effective resolution, colour space and bits per channel of embedded images, embedded files, non-native art and plug-in art such as…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kinds | array | no | linked: placed files; embedded: embedded images (raster items); embedded_file: embedded files; non_native: art Illustrator keeps but cannot edit; plugin: plug-in art such as Image Trace objects. Defau |
| missingOnly | boolean | no | Only linked files that are missing. Default false |
| limit | integer | no | — |
Relink or replace linked files (Links panel > Relink). Give target and filePath to point the targets at another file; with allInstances, every placement of the same file is relinked too. Give folder to replace missing links at once: each missing link is relinked to the file with the same name in…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | no | Linked items to relink. With folder, optional: default every missing link | |
| filePath | string | no | Absolute path of the new file |
| allInstances | boolean | no | With filePath: also relink every other placement of the targets' current file. Default false |
| folder | string | no | Absolute folder to search for missing links by file name |
Update linked files that changed on disk (Links panel > Update Link), or embed them (Embed Image). Acts on the targets, or every linked file with all: true. Embedding replaces each placed item with native art, so its id changes
| Parameter | Type | Required | Notes |
|---|---|---|---|
| operation | string | no | Default update |
| target | no | — | |
| all | boolean | no | Every linked file in the document instead of target |
Select a linked or embedded image and centre the view on it (Links panel > Go To Link)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| zoom | number | no | Zoom factor (1 = 100%). Default: keep the current zoom |
Place several files at once (File > Place with multiple files), laid out in a grid from x, y on an artboard, linked or embedded. Photoshop files take the Photoshop Import Options: convert layers to objects (needs embed), import hidden layers, slices, image maps and a layer comp; Illustrator's own…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| files | array | yes | Absolute paths, placed in this order |
| artboardIndex | no | — | |
| x | number | no | — |
| y | number | no | — |
| columns | integer | no | Files per row. Default: all in one row |
| gap | number | no | Space between files in points. Default 10 |
| width | number | no | Scale each file proportionally to this width in points |
| embed | boolean | no | Embed instead of linking. Default false |
| layer | string | no | — |
| photoshop | object | no | Photoshop Import Options for .psd files |
Rasterize the targets into an embedded image (Object > Rasterize), with the dialog's options: colour model, resolution, background, anti-aliasing, clipping mask, space added around the object, spot colours, text to outlines and layer attributes. By default the targets become one image; clipBounds…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| resolution | number | no | Pixels per inch: 72 screen, 150 medium, 300 high. Default 300 |
| colorModel | string | no | default: the document's colour mode. Default default |
| background | string | no | Default white |
| antiAliasing | string | no | none, art (Art Optimized, supersampling) or type (Type Optimized, hinted). Default art |
| clippingMask | boolean | no | Create Clipping Mask: mask the background. Default false |
| padding | number | no | Add Around Object, in points. Default 0 |
| preserveSpotColors | boolean | no | Keep spot colours; false converts them to process. Default true |
| convertTextToOutlines | boolean | no | Outline text before rasterizing. Default false |
| includeLayers | boolean | no | Keep layer opacity and blending in the image. Default false |
| separately | boolean | no | One image per target instead of one for all. Default false |
| clipBounds | no | Rasterize only this rectangle, in points from the artboard's top-left corner | |
| artboardIndex | no | — |
Crop linked or embedded images to a rectangle, discarding the pixels outside it (Object > Crop Image). The result is an embedded image at the given resolution; a linked file is embedded, as Crop Image does
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| bounds | yes | The area to keep, in points from the artboard's top-left corner | |
| artboardIndex | no | — | |
| resolution | number | no | Pixels per inch of the cropped image. Default 300; list_images gives each image's current ppi |
Colour a grayscale or 1-bit embedded image with an RGB or CMYK colour (Colorize, the way a fill applies to such an image). Embed linked images first with update_links
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| color | string | yes | An RGB or CMYK colour: "#RRGGBB", "rgb(r,g,b)", "cmyk(c,m,y,k)" or a process swatch name |
Run an Object menu image command on the targets: remove_background (Object > Remove Background, Illustrator 30.4 and later: keeps the subject of an image), make_mockup (Object > Mockup > Make / Preview: wrap the vector art onto the image beneath it; select both), release_mockup (Object > Mockup >…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| operation | string | yes | — |
Run a Layers panel menu command: merge layers (Merge Selected), flatten every layer into one (Flatten Artwork), collect items or layers in a new layer (Collect in New Layer), give each object of a layer or group its own sublayer (Release to Layers (Sequence) or (Build)), or reverse the stacking…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| command | string | yes | merge: the layers into the last one listed. flatten: every top-level layer into layer (default the active layer's top-level layer). collect: target items, or layers, into a new layer. release_sequence |
| layers | no | merge, reverse, collect: layer names at the same level of the Layers panel | |
| layer | string | no | flatten: the layer to flatten into. release_*: the layer whose objects are released |
| target | no | collect: the items to move into a new sublayer of the first item's layer. release_*: one group whose objects are released | |
| name | string | no | collect: name of the new layer |
| hiddenLayers | string | no | flatten: move the artwork of hidden layers in as hidden objects, or delete those layers. Default include |
Hide, lock or outline every top-level layer except the ones holding the chosen layers or items (Object > Hide > Other Layers, Object > Lock > Other Layers, Layers panel menu > Outline Others), or show, unlock or preview them again
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | — |
| layers | no | Layers to leave alone (a sublayer keeps its top-level layer) | |
| target | no | Or: leave alone the layers holding these items |
Select all the artwork on layers, as clicking a layer's selection column or target circle in the Layers panel does. Appearance tools then act on it. Artwork on hidden or locked layers cannot be selected
| Parameter | Type | Required | Notes |
|---|---|---|---|
| layers | yes | — | |
| add | boolean | no | Add to the current selection instead of replacing it. Default false |
Paste the clipboard directly in front of or behind the selected objects, on their layer (Edit > Paste in Front, Paste in Back). With target, those items are copied first, so the pasted copies sit exactly over or under them
| Parameter | Type | Required | Notes |
|---|---|---|---|
| placement | string | yes | — |
| target | no | Copy these items first. Default: paste what is on the clipboard |
Duplicate an artboard with the artwork on it (Artboards panel menu > Duplicate Artboards), copy it into another open document, or cut it (move it and its artwork, removing the original). Artwork belongs to an artboard when its centre lies on it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| artboardIndex | yes | — | |
| withArtwork | boolean | no | Copy the artwork on the artboard too. Default true |
| toDocument | string | no | Name of another open document to copy into (list_documents). Default this document |
| cut | boolean | no | Remove the original artboard and its artwork afterwards. Default false |
| name | string | no | Name of the copy. Default the original's name |
| x | number | no | Left of the copy, from the destination's artboard 0 top-left, in points. Default: right of its rightmost artboard, 20 pt apart |
| y | number | no | Top of the copy, measured the same way. Default level with the original (artboard 0 in another document) |
Delete every artboard that no artwork touches (Artboards panel menu > Delete Empty Artboards). Hidden and locked artwork and guides count as artwork. One artboard always remains
| Parameter | Type | Required | Notes |
|---|---|---|---|
| dryRun | boolean | no | Only report which artboards would be deleted. Default false |
Align artboards to one another, or space them evenly, moving the artwork on them along (Artboard tool: align and distribute artboards). Artwork belongs to an artboard when its centre lies on it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| artboards | no | — | |
| align | string | no | Line up the artboards' edges or centres with the outermost one |
| distribute | string | no | Space the artboards evenly in a row (left to right) or a column (top to bottom) |
| spacing | number | no | With distribute: a fixed gap in points. Default: an even gap between the outermost artboards |
| moveArtwork | boolean | no | Move the artwork with its artboard. Default true |
Change the artboards' numbering order, which sets their page order when exporting (Artboards panel: move up, move down, or drag). Positions and artwork do not change
| Parameter | Type | Required | Notes |
|---|---|---|---|
| order | array | no | Every artboard index in its new order, e.g. [2, 0, 1] |
| artboardIndex | integer | no | Or: the artboard to move |
| toIndex | integer | no | with artboardIndex: its new index |
Turn the chosen objects (usually rectangles) into artboards of the same bounds (Object > Artboards > Convert to Artboards)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Artboard display options (Artboard Options: Show Center Mark, Show Cross Hairs, Show Video Safe Areas, Video Ruler Pixel Aspect Ratio, ruler origin), the artboard border and name display (application preferences, for every document), and the View menu's Show / Hide Artboards and Show / Hide Video…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| artboards | no | — | |
| showCenter | boolean | no | Show a mark at the centre |
| showCrossHairs | boolean | no | Show lines through the centre of each edge |
| showSafeAreas | boolean | no | Show video title-safe and action-safe areas |
| rulerPixelAspectRatio | number | no | Pixel aspect ratio of the video rulers, e.g. 1 for square pixels |
| rulerOrigin | object | no | Zero point of the artboard's rulers, in points from its top-left corner |
| borderColor | string | no | Artboard border colour, "#RRGGBB" or "rgb(r,g,b)" (all documents) |
| borderWidth | integer | no | Artboard border width, 1-4 (all documents) |
| showNames | boolean | no | Show artboard names on the canvas (all documents) |
| toggleArtboards | boolean | no | Run View > Show / Hide Artboards, which switches artboard outlines on or off |
| toggleVideoRulers | boolean | no | Run View > Rulers > Show / Hide Video Rulers, which switches them on or off |
Show an artboard in the document window: make it active and fit it in the window, fit all artboards, or zoom on its centre (View > Fit Artboard in Window, Fit All in Window)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| artboardIndex | yes | — | |
| fit | string | no | Fit this artboard, or every artboard, in the window. Default artboard unless zoom is given |
| zoom | number | no | Instead of fitting: zoom factor centred on the artboard (1 = 100%) |
Edit anchor points of paths: remove them without splitting the path (Object > Path > Remove Anchor Points), convert them to corner points (handles retracted) or smooth points (handles aligned; retracted handles are pulled out a third of the way to the neighbouring anchors), or set one point's…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | Paths, compound paths or groups. With points, exactly one path | |
| action | string | yes | remove, corner, smooth, or set (one point: anchor and handles) |
| points | array | no | 0-based anchor indexes on the one target path |
| selectedPoints | boolean | no | Act on the anchors selected with the Direct Selection tool instead of indexes |
| anchor | no | set: new anchor [x, y]. Its handles move with it unless given | |
| leftHandle | no | set: the handle towards the previous anchor, [x, y] | |
| rightHandle | no | set: the handle towards the next anchor, [x, y] | |
| artboardIndex | no | — |
Copy paths and other items into another open document (onto its active layer or a named layer, at the same document coordinates), or onto the clipboard for pasting into other applications (Edit > Copy)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| to | string | yes | — |
| document | string | no | to: "document": the name of the open document to copy into (list_documents) |
| layer | string | no | to: "document": layer in that document. Default its active layer |
Reduce the anchor points of paths while keeping their shape (Object > Path > Simplify), with Simplify's curve precision, corner angle threshold and straight lines options. Runs Illustrator's own Simplify through a temporary Action, with its dialog closed
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| curvePrecision | number | no | Percent: how closely the result follows the original; lower removes more anchors. Default 50 |
| angleThreshold | number | no | Degrees: corners sharper than this stay corners. Default 0 |
| straightLines | boolean | no | Replace curves with straight segments. Default false |
Pathfinder panel compound shapes: make one from the targets with a shape mode (unite, intersect, exclude, minus_front; the parts stay editable), release one back into its objects, or expand one into plain paths (the panel's Expand button). Runs the panel's commands through a temporary Action
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | make: two or more objects; release and expand: compound shapes | |
| operation | string | yes | — |
| mode | string | no | make: the shape mode. Default unite |
Apply the last Pathfinder panel operation again to the targets (Repeat Pathfinder, Cmd/Ctrl+4). It repeats what was last done in the panel, not the pathfinder tool here; if nothing was, nothing happens
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Object > Intertwine (Illustrator 2023 or later). make puts overlapping objects in an Intertwine group; choosing which overlaps swap front and back is done by the user afterwards, by clicking or drawing around each overlap. release returns the objects to their original stacking
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | make: two or more overlapping objects; release: an Intertwine object | |
| operation | string | yes | — |
Make a pattern swatch from the targets (Object > Pattern > Make), optionally naming it. The artwork stays where it is. By default Illustrator leaves pattern editing mode at once; with keepEditing it stays there so tile type, size, spacing and overlap can be set by hand in the Pattern Options…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| name | string | no | Name for the pattern swatch. Default Illustrator's ("New Pattern") |
| keepEditing | boolean | no | Stay in pattern editing mode. Default false |
Fill or stroke paths, compound paths, groups (every path inside) and text with a pattern swatch in the document, by pattern or swatch name: one made with create_pattern or a predefined one (list_swatches shows them as kind pattern). Library patterns must first be added to the document's Swatches…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| pattern | string | yes | Pattern or pattern swatch name |
| paint | no | — |
Rename a pattern swatch (the Name field of the Pattern Options panel)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| pattern | string | yes | Current pattern or pattern swatch name |
| newName | string | yes | — |
Enter pattern editing mode for the pattern that fills the target (Object > Pattern > Edit Pattern), or leave it (mode exit, like Done). In the mode, the tile options are set by hand in the Pattern Options panel and other tools act on the pattern's artwork
| Parameter | Type | Required | Notes |
|---|---|---|---|
| mode | string | yes | — |
| target | no | For enter: one object filled with the pattern |
Move, scale, rotate, reflect or shear the pattern inside objects without changing the objects (like the Transform options with Transform Objects off and Transform Patterns on, or dragging with the ` key held). Steps apply in that order: reflect, scale, rotate, shear, move
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| paint | no | — | |
| dx | number | no | Move the pattern right by this many points |
| dy | number | no | Move the pattern down by this many points |
| scale | number | no | Uniform scale in percent, e.g. 50 |
| scaleX | number | no | Horizontal scale in percent; overrides scale |
| scaleY | number | no | Vertical scale in percent; overrides scale |
| angle | number | no | Rotate the pattern by this many degrees, anticlockwise |
| reflect | string | no | horizontal flips the pattern left-right |
| shear | number | no | Shear the pattern horizontally by this angle in degrees |
| origin | no | — |
Repeat the targets as a live radial, grid or mirror repeat (Object > Repeat > Radial, Grid, Mirror; Illustrator 2023 or later), optionally setting its options: instances, radius and reverseOverlap for radial; horizontalSpacing, verticalSpacing, gridType, flipRows and flipColumns for grid;…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| kind | string | yes | — |
Change the options of radial, grid or mirror repeats (Object > Repeat > Options): instances, radius and reverseOverlap for radial; horizontalSpacing, verticalSpacing, gridType, flipRows and flipColumns for grid; axisAngle for mirror. With no options, report the current ones
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Release radial, grid or mirror repeats back into their source artwork (Object > Repeat > Release)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Set Overprint Fill and Overprint Stroke (Attributes panel) on paths, compound paths, groups and text frames, so the colour prints over the inks beneath instead of knocking them out
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| fill | boolean | no | Overprint the fill |
| stroke | boolean | no | Overprint the stroke |
Draw trim marks around the targets' bounds (Object > Create Trim Marks). The marks are editable artwork
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Trap paths by hand (spread traps): give each filled path an overprinting stroke in its own fill colour, so the colour spreads into the inks around it by half the stroke weight. Paths with gradient, pattern or no fill are skipped
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| weight | number | no | Stroke weight in points; the trap is half of it. Default 0.5 |
| round | boolean | no | Round caps and joins. Default true |
Flatten transparency in the targets permanently (Object > Flatten Transparency), without the dialog: transparent artwork becomes opaque vector and raster pieces. Resolution is the one setting offered; the dialog's other settings stay at the values published scripts record for this command
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| resolution | number | no | Resolution for rasterised parts, ppi. Default 300 |
Toggle a prepress view or panel: overprint_preview (View > Overprint Preview), print_tiling (View > Show/Hide Print Tiling), separations_preview, flattener_preview or attributes (Window menu panels). Illustrator does not report whether Overprint Preview or a panel is showing, so those simply…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| view | string | yes | — |
| show | boolean | no | print_tiling only: show (true) or hide (false) instead of switching |
List what printing can use: printers with their capabilities, PPD files, print presets, transparency flattener presets and PDF presets
No parameter schema on file.
Print the active document to a printer, or to a PostScript file with outputFile. A print preset is the base; options are grouped like the Print dialog's pages and override it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| printer | string | no | Printer name from list_print_settings. Default the preset's or the system default |
| outputFile | string | no | Absolute .ps path: print to this file instead of sending the job to the printer |
| preset | string | no | Print preset name from list_print_settings |
| ppd | string | no | PPD name for a PostScript printer |
Select every object of one kind (Select > Object): all_text, point_type, area_type, clipping_masks, stray_points (lone anchor points), brush_strokes, bristle_brush_strokes, not_pixel_aligned, flash_dynamic_text, flash_input_text. Two kinds start from a selection, given as target: same_layers…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| kind | string | yes | — |
| target | no | For same_layers and direction_handles only: the items to start from |
Change the selection with a Select menu command: reselect (repeat the last Select > Same or Select > Object command), inverse (select everything not selected), next_above or next_below (the next object up or down the stacking order in the same layer; next_below reaches objects hidden behind…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | — |
| target | no | Items to select before the command. Default the current selection |
Select inside groups, as the Direct Selection and Group Selection tools do: children (the items directly inside each target group), all (every object inside the target groups at any depth, not the groups themselves) or parent (the group that holds each target, one level up). The selection is…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| level | string | yes | — |
Start or stop Global Edit (Select > Start/Stop Global Edit): with an object selected it starts, and edits to that object then apply to every similar object; run it again to stop. Illustrator does not report whether Global Edit is on; the result shows the selection afterwards. The matching options…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | no | The object to start from. Default the current selection |
Lock artwork so it cannot be selected or edited (Object > Lock): scope selection locks the targets, above locks the artwork stacked above them, others locks everything except them. The result lists what was locked
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| scope | string | no | Default selection |
Hide artwork (Object > Hide): scope selection hides the targets, above hides the artwork stacked above them, others hides everything except them. show_all shows it again. The result lists what was hidden
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| scope | string | no | Default selection |
Unlock every locked object in the document (Object > Unlock All). Illustrator selects the unlocked objects; the result lists them
No parameter schema on file.
Show every hidden object in the document (Object > Show All). Illustrator selects the objects it shows; the result lists them
No parameter schema on file.
Enter or leave isolation mode: enter isolates one group or object (Isolate Selected Object) so the rest of the artwork is dimmed and cannot be edited; exit leaves it (Exit Isolation Mode)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| mode | string | yes | — |
| target | no | For enter: the one group or object to isolate |
Select every path whose stroke weight or opacity is within a tolerance of one reference path, optionally with the same blending mode (the Magic Wand's Stroke Weight, Opacity and Blending Mode options). Every option given must match. Unlocked, visible paths and compound paths on every layer are…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | The one reference path or compound path | |
| strokeWeightTolerance | number | no | Match stroked paths whose stroke weight is within this many points of the reference's |
| opacityTolerance | number | no | Match paths whose opacity is within this many percent of the reference's |
| blendingMode | boolean | no | Match only paths with the reference's blending mode |
Draw an arc (Arc tool, with the Arc Segment Tool Options): the arc spans a width x height box (Length X-Axis, Length Y-Axis) from the start corner to the opposite corner. baseAlong x leaves the start point horizontally, y vertically. slope: positive is convex, negative concave, 0 a straight line.…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| width | number | yes | Length X-Axis in points |
| height | number | yes | Length Y-Axis in points |
| startCorner | string | no | Corner of the box where the arc starts (the dialog's reference point). Default top_left |
| closed | boolean | no | Type: true for a closed arc, false for open. Default false |
| baseAlong | string | no | Base Along: the axis the arc leaves its start point along. Default x |
| slope | number | no | Slope, -100 (concave) to 100 (convex). About 55 approximates a quarter ellipse. Default 50 |
Draw a spiral (Spiral tool, with its dialog's options): radius from the centre to the outermost point, decay (each quarter-turn segment's radius as a percentage of the one before), segments (quarter turns; four make one wind) and style (direction). It starts at its outermost point, to the right of…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| centerX | number | yes | — |
| centerY | number | yes | — |
| radius | number | yes | Points from the centre to the outermost point |
| decay | number | no | Percent, 5-100. 100 draws a circle. Default 80 |
| segments | integer | no | Quarter-turn segments. Default 10 |
| style | string | no | Direction the spiral winds in from its outer end. Default counterclockwise |
Draw a rectangular grid (Rectangular Grid tool, with its options dialog) as a group: horizontal and vertical dividers with skew, and the outside edges as one rectangle (Use Outside Rectangle As Frame) or as four lines. With fill, the frame is filled (Fill Grid)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| width | number | yes | Default Size: width in points |
| height | number | yes | Default Size: height in points |
| horizontalDividers | no | — | |
| horizontalSkew | no | — | |
| verticalDividers | no | — | |
| verticalSkew | no | — | |
| frame | boolean | no | Use Outside Rectangle As Frame: draw the outside edges as one rectangle. Default true |
Draw a polar grid (Polar Grid tool, with its options dialog) as a group: concentric ellipses and radial lines, each with skew. compoundPath makes every other ring a compound path (Create Compound Path From Ellipses). With fill, the ellipses are filled (Fill Grid)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| width | number | yes | Default Size: width in points |
| height | number | yes | Default Size: height in points |
| concentricDividers | no | — | |
| concentricSkew | no | — | |
| radialDividers | no | — | |
| radialSkew | number | no | Skew, -500 to 500 percent. 0 spaces the lines evenly. Going counterclockwise from 12 o'clock, positive makes each sector 1 + |skew|/100 times smaller than the one before, negative that much larger. De |
| compoundPath | boolean | no | Create Compound Path From Ellipses: pair the ellipses from the outside in as compound paths, so alternate rings are filled. Default false |
Turn paths that resemble rectangles, rounded rectangles, ellipses, polygons or lines into live shapes (Object > Shape > Convert to Shape), or turn live shapes back into ordinary paths (Object > Shape > Expand Shape). Live-shape properties (width, height, angle, corner radii in the Transform panel)…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| operation | string | yes | convert_to_shape or expand_shape |
Show or hide the corner widget, the on-canvas control for rounding live-shape corners (View > Show / Hide Corner Widget). It flips the current state; Illustrator does not report which state results
No parameter schema on file.
List the graphic styles in the document (Graphic Styles panel), in panel order
No parameter schema on file.
Apply a graphic style from the document's Graphic Styles panel to items. By default the style replaces their appearance; with merge it is added to it (Alt/Option-click in the panel)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| style | string | yes | Graphic style name (list_graphic_styles) |
| merge | boolean | no | Add the style to the items' current appearance instead of replacing it. Default false |
Rename a graphic style (Graphic Styles panel menu > Graphic Style Options)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Current name |
| newName | string | yes | — |
Delete graphic styles from the document (Graphic Styles panel menu > Delete Graphic Style). Items keep their appearance; only the saved style goes
| Parameter | Type | Required | Notes |
|---|---|---|---|
| names | array | yes | Graphic style names |
Save the document's graphic styles as a graphic style library file (Graphic Styles panel menu > Save Graphic Style Library), an .ai file other documents can open as a library
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .ai path |
Show the Graphic Styles panel (Window > Graphic Styles), or open one of Illustrator's built-in graphic style libraries as a panel (Window > Graphic Style Libraries). A style used from a library is added to the document. Like every Window menu command, this hides a panel that is already showing at…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | no | Built-in library to open. Omit for the Graphic Styles panel |
Add another fill or stroke to each item's appearance (Appearance panel menu > Add New Fill / Add New Stroke), so one object can carry several fills or strokes. The new attribute goes above the current ones; apply_effect, apply_graphic_style or the Appearance panel then style it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| attribute | string | yes | — |
| count | integer | no | How many to add to each item. Default 1 |
Set Knockout Group and Isolate Blending (Transparency panel) on groups, other items or layers. Knockout stops the objects inside from showing through each other; Isolate Blending keeps blending modes inside the group or layer
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | no | — | |
| layers | array | no | Layer names, instead of or as well as target |
| knockout | string | no | on, off, or inherit (the neutral state of the checkbox) |
| isolateBlending | boolean | no | — |
Show or hide the transparency grid (View > Show / Hide Transparency Grid) or Live Paint gap highlighting (View > Show / Hide Live Paint Gaps). Each call switches the option; Illustrator does not report which state it is in
| Parameter | Type | Required | Notes |
|---|---|---|---|
| option | string | yes | — |
Make a Live Paint group from paths (Object > Live Paint > Make), or add paths to an existing Live Paint group (Object > Live Paint > Merge) when into is given. Painting its faces and edges stays interactive (select_tool "Planar Paintbucket Tool")
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| into | no | An existing Live Paint group to merge the target paths into |
Release Live Paint groups back into plain paths with a thin black stroke and no fill (Object > Live Paint > Release)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Expand Live Paint groups into ordinary filled and stroked paths that keep their painted look (Object > Live Paint > Expand)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Read the document's default fill and stroke, the attributes new objects get, and whether the Fill or the Stroke box is in front in the toolbar's Fill and Stroke controls
No parameter schema on file.
Set the document's default fill and stroke, the attributes new objects get. reset gives a white fill and a black 1 pt solid stroke, as the toolbar's Default Fill and Stroke button does; other options apply after it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| reset | boolean | no | White fill, black 1 pt solid stroke |
| fill | no | — | |
| stroke | no | — | |
| strokeWeight | number | no | Points |
| cap | string | no | — |
| join | string | no | — |
| miterLimit | number | no | — |
| dashes | array | no | Dash and gap lengths in points. [] for a solid line |
| dashOffset | number | no | — |
| fillOverprint | boolean | no | — |
| strokeOverprint | boolean | no | — |
Swap the fill and stroke colours of paths, compound paths and groups (every path inside), as the toolbar's Swap Fill and Stroke button does. A missing fill becomes a missing stroke and the other way round
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Give paths, compound paths and groups (every path inside) a white fill and a black 1 pt solid stroke, as the toolbar's Default Fill and Stroke button does for selected objects
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
List the document's symbols (Symbols panel) with how many instances each has; unused symbols are marked (Symbols panel > Select All Unused)
No parameter schema on file.
Make a symbol from artwork (Symbols panel > New Symbol) with a registration point. By default the artwork is replaced by an instance of the new symbol, as the panel does. Several items become one symbol, or one symbol each with each: true
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| name | string | no | Symbol name. With each: true, items are numbered after it ("Leaf 1", "Leaf 2"). Default: Illustrator names it |
| registration | string | no | Registration point on the symbol's bounding box. Default center |
| each | boolean | no | One symbol per item instead of one for all. Default false |
| replace | boolean | no | Replace the artwork with an instance of the symbol. Default true |
Place instances of a symbol (Symbols panel > Place Symbol Instance). x and y are the instance's top-left corner; without them it goes in the centre of the artboard
| Parameter | Type | Required | Notes |
|---|---|---|---|
| symbol | string | yes | Symbol name (list_symbols) |
| x | number | no | — |
| y | number | no | — |
| artboardIndex | no | — | |
| layer | string | no | Layer to place on. Default the active layer |
| count | integer | no | Number of instances, all at the same spot. Default 1 |
Make symbol instances use another symbol (Symbols panel > Replace Symbol)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | Symbol instances | |
| symbol | string | yes | The symbol they should use |
Turn symbol instances into ordinary artwork (Symbols panel > Break Link to Symbol). The symbol stays in the document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | Symbol instances |
Rename a symbol (Symbols panel > Symbol Options: name). A symbol's type, registration point and 9-slice guides cannot be changed by script
| Parameter | Type | Required | Notes |
|---|---|---|---|
| symbol | string | yes | Current name |
| newName | string | yes | — |
Copy a symbol under a new name (Symbols panel > Duplicate Symbol). The copy is registered at its centre
| Parameter | Type | Required | Notes |
|---|---|---|---|
| symbol | string | yes | — |
| newName | string | no | Default: Illustrator names it |
Delete symbols by name, or every unused symbol (Symbols panel > Select All Unused, then Delete Symbol). A symbol with instances is refused unless instances says to delete them or turn them into ordinary artwork (expand)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| symbols | array | no | Symbol names |
| unused | boolean | no | Delete every symbol with no instances |
| instances | string | no | What to do with instances of the symbols: refuse (default), delete them, or expand them (break their links) |
Select every instance of the given symbols (Symbols panel > Select All Instances)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| symbols | array | yes | Symbol names |
| add | boolean | no | Add to the current selection instead of replacing it. Default false |
Open a symbol library as a panel: one of Illustrator's built-in libraries (Window > Symbol Libraries), or a library file such as one saved with save_symbol_library (Window > Symbol Libraries > Other Library). Drag or copy its symbols into the document from the panel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | no | A built-in library |
| filePath | string | no | Or an absolute path to a library (.ai) file |
Save the document's symbols, or some of them, as a symbol library file (Symbols panel > Save Symbol Library). Open it later with open_symbol_library; files saved in Illustrator's Symbols presets folder also appear under Window > Symbol Libraries > User Defined
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path of the .ai library file to write |
| symbols | array | no | Symbol names. Default all |
Scale, move, rotate and flip each item around its own reference point (Object > Transform > Transform Each). With random, each item gets a random amount between none and the value given. With copy, transformed copies are made and the originals stay
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| scaleX | number | no | Horizontal scale in percent. Default 100 |
| scaleY | number | no | Vertical scale in percent. Default 100 |
| moveX | number | no | Horizontal move in points, right positive. Default 0 |
| moveY | number | no | Vertical move in points, down positive. Default 0 |
| angle | number | no | Rotation in degrees, counter-clockwise. Default 0 |
| flipHorizontal | boolean | no | Mirror left-right |
| flipVertical | boolean | no | Mirror top-bottom |
| origin | no | — | |
| random | boolean | no | Random amounts per item. Default false |
| copy | boolean | no | Transform copies, leaving the originals. Default false |
| apply | no | — | |
| scaleStrokes | boolean | no | Scale stroke weights. Default: the Scale Strokes & Effects preference |
| scaleCorners | no | — |
Shear (slant) items by an angle along a horizontal, vertical or angled axis (Object > Transform > Shear). On a horizontal axis a positive angle leans the item's vertical edges to the right
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| angle | number | yes | Shear angle in degrees |
| axis | string | no | Default horizontal |
| axisAngle | number | no | With axis: angle, the axis direction in degrees counter-clockwise from horizontal |
| origin | no | — | |
| apply | no | — |
Transform items by an affine matrix [a, b, c, d, tx, ty] in artboard terms (x right, y down): x' = a·x + c·y + tx, y' = b·x + d·y + ty, applied around the reference point. tx and ty are points
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| matrix | array | yes | [a, b, c, d, tx, ty]; [1, 0, 0, 1, 0, 0] leaves items unchanged |
| origin | no | — | |
| apply | no | — | |
| scaleStrokes | boolean | no | Scale stroke weights by the matrix's area change. Default: the Scale Strokes & Effects preference |
Repeat the last transformation on the targets (Object > Transform > Transform Again), count times. It repeats what Illustrator recorded as the last move, scale, rotate, reflect, shear or Transform Each, usually one made by hand or in a Transform dialog; transformations made by other tools may not…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| count | integer | no | — |
Set items' width and height in points (Transform panel W and H) around a reference point. With constrainProportions and one dimension, the other follows. With relative, the values are added to the current size (e.g. width: 10 makes it 10 pt wider). For percentages use scale_items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| width | number | no | Points |
| height | number | no | Points |
| relative | boolean | no | Add width and height to the current size. Default false |
| constrainProportions | boolean | no | Keep the width to height ratio when only one is given (Constrain Width and Height Proportions). Default true |
| origin | no | — | |
| usePreviewBounds | boolean | no | Measure including strokes and effects. Default: the Use Preview Bounds preference |
| transformPatterns | boolean | no | Scale pattern fills too. Default true |
| scaleStrokes | boolean | no | Scale stroke weights. Default: the Scale Strokes & Effects preference |
| scaleCorners | no | — |
Report items' geometric bounds (paths only), visible bounds (with strokes and effects) and control bounds (with handles), in points from an artboard's top-left corner
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| artboardIndex | no | Measure from this artboard (0-based). Default: the artboard each item is on |
Move items as the arrow keys do: by the Keyboard Increment preference, times steps, times 10 with large (Shift + arrow)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| direction | string | yes | — |
| steps | integer | no | — |
| large | boolean | no | Ten times the increment, like Shift + arrow. Default false |
Set Transform panel options: the reference point, Scale Corners, and whether the bounding box shows (View > Show / Hide Bounding Box). Returns the current options, including Scale Strokes & Effects, Transform Patterns and Use Preview Bounds (set those with set_preferences); call with no options…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| referencePoint | string | no | The Transform panel's reference point |
| scaleCorners | boolean | no | Scale live corner radii when scaling (Scale Corners) |
| showBoundingBox | boolean | no | Show the bounding box handles around selections |
Square the bounding box of rotated items back to the page (Object > Transform > Reset Bounding Box). The artwork does not move
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Distribute items evenly (Object > Distribute, Align panel): by left, horizontal centre or right edges, top, vertical centre or bottom edges, or equal horizontal or vertical space between them. The outermost items stay put. With spacing (hspace, vspace), items are set exactly that many points…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| by | string | yes | — |
| spacing | number | no | hspace or vspace: the exact gap in points (Distribute Spacing) |
| keyObjectId | string | no | With spacing: the id of the item that stays still (Key Object). Default the leftmost or topmost item |
| usePreviewBounds | boolean | no | Measure including strokes and effects (Use Preview Bounds). Default true |
Distort items into the shape of a top object (Object > Envelope Distort > Make with Top Object). Give the contents as target and the shape as shapeId; the shape is brought to the front of the first item's layer or group, so keep them together. Without shapeId, the frontmost target is the shape.…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| shapeId | string | no | Id of the path to use as the envelope |
Work with envelopes (Object > Envelope Distort): release (separate the contents from the envelope shape), expand (apply the distortion as plain artwork), or edit_contents (switch between editing the contents and the envelope; run again to switch back)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| operation | string | yes | — |
Turn objects attached to a path into independent objects in place (Object > Objects on Path > Expand; Illustrator 2025 or later). Attaching and the Objects on Path options open a dialog or need clicks, so they are not offered
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Distort items by moving the corners of their bounding box, as the Free Transform tool's Free Distort and Perspective Distort do. free: give corners as [x, y] fractions of the box (0,0 top-left, 1,1 bottom-right). perspective: one edge narrows (positive amount) or widens (negative) symmetrically.…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| mode | string | yes | — |
| corners | object | no | free: new corner positions; corners left out stay put. E.g. { topRight: [1.2, -0.1] } |
| edge | string | no | perspective: the edge whose corners move |
| amount | number | no | perspective: percent of the width (or height) each corner moves inward; negative moves outward |
| expand | boolean | no | Expand the effect into plain artwork. Default true |
List the document's variables with their kind and the items bound to them, its data sets, the data set on display, and whether variables are locked
No parameter schema on file.
Create a variable (Variables panel > New Variable) and optionally bind it to items: text to text frames, image to placed images, graph to graphs, visibility to any object (Make Object Dynamic, Make Visibility Dynamic)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Letters, digits, _ . and -; starts with a letter or underscore |
| kind | string | yes | — |
| target | no | Items to bind it to |
Bind an existing variable to more items. Each item takes the variable's kind: a text frame for text, a placed image for image, a graph for graph, any object for visibility
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
| target | yes | — |
Delete variables by name. Their bound items stay in the document, no longer dynamic
| Parameter | Type | Required | Notes |
|---|---|---|---|
| names | array | yes | — |
Create data sets from records: for each record, set the bound items to its values (text for text variables, an image file for image variables, true/false for visibility) and capture a data set with its name. A record that names an existing data set updates it. Variables a record leaves out keep…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| records | array | yes | — |
| show | string | no | Data set to display afterwards. Default the first record |
Display a data set: its values replace the bound items' current content (Variables panel > previous/next data set)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | Data set name |
| index | integer | no | Or its 0-based position |
Delete data sets by name, or all of them. Variables and the artwork stay as displayed
| Parameter | Type | Required | Notes |
|---|---|---|---|
| names | array | no | — |
| all | boolean | no | Delete every data set |
Load a variable library (Variables panel > Load Variable Library): an XML file of variables and data sets, e.g. one saved by export_variables or another Illustrator document. Variables bind to objects by name
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .xml path |
Save the document's variables and data sets as a variable library (Variables panel > Save Variable Library), an XML file
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .xml path |
Lock or unlock the document's variables (Variables panel > Lock Variables). Locked variables cannot be created, bound or deleted
| Parameter | Type | Required | Notes |
|---|---|---|---|
| locked | boolean | yes | — |
Export every data set (or the ones named) as PNG or JPEG files: each data set is displayed in turn and its artboards exported as <data set>-<artboard>.<ext>. The data set on display before is shown again afterwards
| Parameter | Type | Required | Notes |
|---|---|---|---|
| outputFolder | string | yes | Absolute folder path |
| dataSets | array | no | Data set names. Default all |
| format | string | no | Default png |
| artboards | string | no | Artboards, 1-based: "1", "1-3,5". Default all |
| scale | number | no | Percent. Default 100 |
| transparent | boolean | no | PNG: transparent background. Default true |
| quality | integer | no | JPEG quality. Default 80 |
Set the fill of paths, compound paths, groups (every path inside) and text frames. "none" removes the fill; a gradient swatch name fills with the gradient
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| color | yes | — | |
| tint | no | — |
Set the stroke of paths, compound paths and groups: colour, weight, caps, joins and dashes. A gradient swatch name as the colour puts the gradient on the stroke
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| color | no | — | |
| tint | no | — | |
| weight | number | no | Points |
| cap | string | no | — |
| join | string | no | — |
| miterLimit | number | no | — |
| dashes | array | no | Dash and gap lengths in points, e.g. [12, 6]. [] for a solid line |
| dashOffset | number | no | — |
Set the opacity and blending mode of items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| opacity | number | no | — |
| blendMode | string | no | — |
Read the fill, stroke, opacity and blending mode of items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
List the document's swatches with their kind (process, global, spot), colour values and swatch group
No parameter schema on file.
Add a swatch: a process colour, a global process colour (editing it updates every object that uses it), or a spot colour (an ink such as a Pantone colour or a varnish plate). Optionally put it in a swatch group
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
| color | yes | "cmyk(c,m,y,k)", "rgb(r,g,b)", "#RRGGBB" or "gray(g)"; a spot colour can also be "lab(L,a,b)" | |
| spot | boolean | no | Create a spot colour. Default false |
| global | boolean | no | Create a global process colour. Default false |
| group | string | no | Swatch group to put it in, created if needed |
Add a linear or radial gradient swatch from colour stops, and optionally apply it as the fill of items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | — |
| type | string | no | — |
| stops | array | yes | — |
| applyTo | no | — | |
| angle | number | no | Angle in degrees for linear gradients applied to items |
Blend two or more objects (Object > Blend > Make), optionally setting the number of steps and the orientation. The objects blend in stacking order. For text designs, outlineText converts text to outlines first
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| outlineText | boolean | no | Convert text frames among the objects to outlines before blending (Type > Create Outlines), for blended lettering. The text is no longer editable. Default false |
Set the number of steps and the orientation of existing blends (Object > Blend > Blend Options)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Release blends back into their original objects (Object > Blend > Release)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Expand blends so every step becomes an ordinary object (Object > Blend > Expand)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Reverse a blend's spine (the order along the path) or its stacking order (front to back)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| what | string | yes | spine: Reverse Spine; stack: Reverse Front to Back |
Make a blend follow a path (Object > Blend > Replace Spine): the path becomes the blend's spine and the steps are spread along it
| Parameter | Type | Required | Notes |
|---|---|---|---|
| blendId | string | yes | Id of the blend |
| pathId | string | yes | Id of the path to use as the spine (an open or closed path) |
List the brushes in the active document's Brushes panel, by name. Illustrator's scripting does not report a brush's type (calligraphic, scatter, art, pattern, bristle) or its settings
No parameter schema on file.
Apply a brush from the document's Brushes panel to paths (as clicking a brush in the Brushes panel does): calligraphic, scatter, art, pattern or bristle. Paths inside groups and compound paths are brushed too. With expand, the brush strokes become ordinary artwork (Object > Expand Appearance). Use…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| brush | string | yes | Brush name, as list_brushes reports it |
| expand | boolean | no | Expand the brushed paths into outlines (Object > Expand Appearance). Default false |
Bring brushes from a brush library file (an .ai file, such as one saved with save_brush_library or a library from Illustrator's Presets folder) into the active document's Brushes panel, as Window > Brush Libraries > Other Library does. Give names to import only those; brushes the document already…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path of the library .ai file |
| names | array | no | Brush names to import. Default: every brush in the library |
Save the active document's brushes as a brush library file (Brushes panel menu > Save Brush Library). Open it later with import_brushes or Window > Brush Libraries > Other Library
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute .ai path to write |
Open one of the brush libraries Illustrator ships as a panel (Window > Brush Libraries), for the user to pick brushes from. Clicking a brush there adds it to the document; to bring brushes in by script, use import_brushes with the library's file
| Parameter | Type | Required | Notes |
|---|---|---|---|
| library | string | yes | — |
List the document's graphs (made with the graph tools) with their position and the graph variable each is bound to, plus the data sets that can redraw them
No parameter schema on file.
Redraw graphs with new data (the Graph Data window's Import Data and Apply): optionally load a variable library (.xml) holding graph data, then display one of its data sets. Graphs must be bound to graph variables (create_variable with kind graph); a library exported from Illustrator after…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | no | Absolute .xml path of a variable library to load first |
| dataSet | string | no | Data set to display. Default the first one |
| index | integer | no | Or the data set's 0-based position |
Release clip groups (Object > Clipping Mask > Release): the contents show in full again and the clipping path stays as a path with no fill or stroke
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | Clip groups to release |
Select the clipping path of clip groups (Object > Clipping Mask > Edit Mask) or their contents (Edit Contents), so other tools can change them; returns their ids
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | Clip groups | |
| part | string | yes | mask: the clipping path; contents: everything it clips |
Put items inside a clipping mask, keeping their position: into an existing clip group (given the group or its clipping path), or, given a plain path or compound path, make that path a clipping mask around them the way Draw Inside does. The items go in front of the group's other contents
| Parameter | Type | Required | Notes |
|---|---|---|---|
| containerId | string | yes | Id of a clip group, its clipping path, or a path or compound path to draw inside |
| target | yes | Items to put inside |
Take items out of their clip group, keeping their position: they are placed just in front of the group and are no longer clipped. The clipping path itself cannot be removed this way (use release_clipping_mask)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | Items inside clip groups |
List the document's gradient mesh objects with their id, position and size. Mesh points and colours are not reachable by script
No parameter schema on file.
Run an Object > Path command on the targets: outline_stroke (stroke to filled shape), join (connect open paths' end points), add_anchor_points (one between each pair), reverse_direction, divide_objects_below (cut everything beneath with the target's shape), release_compound_path,…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| operation | string | yes | — |
Average anchor points (Object > Path > Average): move them onto one horizontal line, one vertical line, or one point. Handles move with their anchors. With join, connect the averaged end points afterwards (Average & Join)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| axis | string | yes | horizontal: same y (a horizontal line); vertical: same x; both: one point |
| selectedPointsOnly | boolean | no | Only anchor points selected with the Direct Selection tool. Default false: every anchor of the targets |
| join | boolean | no | Join the end points afterwards. Default false |
Remove stray points (single-anchor paths), unpainted paths (no fill, no stroke) and empty text from the document (Object > Path > Clean Up). Locked and hidden objects, clipping paths, guides and the paths inside compound paths are left alone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| strayPoints | boolean | no | — |
| unpaintedObjects | boolean | no | — |
| emptyText | boolean | no | — |
Split each target into a grid of rectangles (Object > Path > Split Into Grid): rows and columns with gutters, taking the target's fill, stroke and opacity. The target is replaced. Optionally add guides along the grid
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| rows | integer | yes | — |
| columns | integer | yes | — |
| gutter | number | no | Points between cells, both ways. Default 0 |
| rowGutter | number | no | Points between rows; overrides gutter |
| columnGutter | number | no | Points between columns; overrides gutter |
| addGuides | boolean | no | Add guides along the cell edges. Default false |
Cut a path at one of its anchor points (like the Scissors tool). An open path becomes two paths; a closed path opens there. Point indexes come from get_path_info
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | One path | |
| pointIndex | integer | yes | 0-based anchor point index |
Set path attributes on paths (inside groups and compound paths too): even-odd or non-zero fill rule, closed or open, make or release guides, and align to pixel grid (Transform panel)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| evenOdd | boolean | no | true: even-odd fill rule; false: non-zero winding |
| closed | boolean | no | — |
| guide | boolean | no | true: make the paths guides (View > Guides > Make Guides); false: release them |
| pixelAligned | boolean | no | Align to Pixel Grid (applies to the targets themselves) |
Describe paths (inside groups and compound paths too): closed, fill rule, guide, anchor count, area and length, and optionally every anchor point with its handles and type, in artboard coordinates
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| includePoints | boolean | no | List anchor points. Default false |
Set up the perspective grid (View > Perspective Grid): choose a preset (one_point, two_point, three_point or a saved preset's name), show or hide the grid, set the active plane, move the plane to match an object, and flip the grid's toggles (Show Rulers, Snap to Grid, Lock Grid, Lock Station…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | one_point, two_point, three_point ([1P/2P/3P-Normal View]) or the name of a saved preset |
| visible | boolean | no | Show (true) or hide (false) the grid |
| activePlane | string | no | Plane to draw on. A one-point grid has only left and floor |
| matchItem | no | An object in perspective: move the grid plane to match it (Object > Perspective > Move Plane to Match Object) | |
| toggle | array | no | Settings to flip. Illustrator does not report their state, so each one is turned on if off and off if on |
Put objects into perspective on a grid plane. Without a position, they are attached where they are (Object > Perspective > Attach to Active Plane); with x and y they are placed at that point on the plane (PageItem.bringInPerspective, in the grid's own coordinates as Adobe's scripting guide uses…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| plane | string | no | Plane to attach to. Default: the active plane |
| x | number | no | Position on the plane, horizontal. Give x and y together |
| y | number | no | Position on the plane, vertical |
Take objects out of perspective, keeping how they look (Object > Perspective > Release with Perspective)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Load perspective grid presets from a file exported by export_perspective_presets or Edit > Perspective Grid Presets > Export. Give preset to load only that one, and select to make it the document's grid
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path of the presets file |
| preset | string | no | Load only this preset. Default: all of them |
| select | boolean | no | Select the loaded preset for the document (needs preset). Default false |
Save every perspective grid preset to a file (Edit > Perspective Grid Presets > Export), to load with import_perspective_presets
| Parameter | Type | Required | Notes |
|---|---|---|---|
| filePath | string | yes | Absolute path to write |
Make objects or text 3D with a live effect (Effect > 3D and Materials): extrude, revolve, inflate, or rotate (a flat plane turned in 3D). It stays editable in the 3D and Materials panel unless expand is true. The current effect takes depth, cap, revolveAngle, bothSides and wireframe; lighting,…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| type | string | yes | — |
| classic | boolean | no | Use the classic effect (extrude, revolve, rotate). Default false |
| depth | number | no | Extrude or inflate depth in points. Default 50 (extrude), 10 (inflate) |
| cap | boolean | no | Extrude and revolve: cap on, solid (true, default) or off, hollow |
| revolveAngle | number | no | Revolve angle in degrees. Default 360 |
| bothSides | boolean | no | Inflate both sides. Default false |
| wireframe | boolean | no | Render as wireframe. Default false |
| rotation | object | no | Classic only: rotation in degrees (-180 to 180). Default x -18, y -26, z 8 (Off-Axis Front) |
| perspective | number | no | Classic only: perspective angle in degrees. Default 0 |
| surface | string | no | Classic only. Default plastic (diffuse for rotate) |
| expand | boolean | no | Expand the result to plain artwork (Object > Expand Appearance). Default false |
List the Image Trace presets Illustrator has: the built-in ones (in brackets) and any saved (Image Trace panel > Preset, Edit > Tracing Presets)
No parameter schema on file.
Trace placed or embedded images into vector artwork (Object > Image Trace > Make, or Make and Expand with expand: true), with a preset and any Image Trace panel option: mode, palette, colours, grays, threshold, paths, corners, noise, method, fills, strokes, stroke width, snap curves to lines,…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | Placed or embedded images (place_image gives ids) | |
| expand | boolean | no | Expand the result into ordinary paths straight away (Make and Expand). Default false |
Change the options of existing image tracings, which re-traces them (Image Trace panel): load a preset and set any option, then optionally save the result as a preset (Image Trace panel > Save as New Preset). Returns the new counts
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| savePreset | string | no | Save the first tracing's options as a preset with this name. A saved preset of that name is overwritten; built-in presets cannot be |
Report image tracings: their paths, anchors and colours (Image Trace panel info) and every option they use
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Expand image tracings into ordinary paths that can be edited like any artwork (Object > Image Trace > Expand). The tracing and its source image are replaced
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — | |
| asViewed | boolean | no | Expand as shown by the tracing's view (outlines, source image) rather than the tracing result. Default false |
Release image tracings: discard the traced result and keep the original image (Object > Image Trace > Release)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| target | yes | — |
Check that Illustrator is reachable: platform, how the server addresses Illustrator, whether it is running, its version and open documents. Use this first when a call fails to connect
| Parameter | Type | Required | Notes |
|---|---|---|---|
| probe | boolean | no | Ask Illustrator for its version and documents (starts Illustrator if it is not running). Default true |
Run an Illustrator menu command by its executeMenuCommand name (e.g. "outline" = Type > Create Outlines, "expandStyle" = Object > Expand Appearance). Illustrator reports nothing back and silently ignores names it does not know, so the result is the selection and document state afterwards. Commands…
| Parameter | Type | Required | Notes |
|---|---|---|---|
| command | string | yes | executeMenuCommand name |
| target | no | Select these items first. Many commands act only on the selection | |
| allowUnknown | boolean | no | Run a name that is not in the known command list. Default false |
Search the known executeMenuCommand names by command name or menu path
| Parameter | Type | Required | Notes |
|---|---|---|---|
| query | string | yes | — |
| limit | integer | no | — |
Run your own ExtendScript in Illustrator and return its last expression. It runs unrestricted: it can change or delete anything and read or write files. Prefer the specific tools
| Parameter | Type | Required | Notes |
|---|---|---|---|
| code | string | yes | ExtendScript (ES3) source |
List the tools by area, or describe one tool's parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
| tool | string | no | A tool name |
- Every tool, no call limit
- No card, and mcprush charges nothing for it
- Source published under MIT
- Runs on your machine — nothing of it reaches our gateway
- Nothing to cap, because mcprush bills nothing
What counts against your monthly calls
| Tool | Unit | Calls used | Out of the allowance |
|---|
Nothing here is billable: mcprush charges nothing to install Adobe Illustrator MCP or to call it, at any volume.
Two independent axes, because powerful and malicious are different questions. The grade is threat only. The capability level is blast radius, and it is never a penalty on the grade — it is priced as one subtract-only term in the score, where you can see it.
| Term | Level | What it prices | Points |
|---|---|---|---|
| capability-exposure | minimal | capability blast radius (minimal) — client exposure if the model is manipulated | −0 |
| verification-discount | source | publisher verification (provenance) — cryptographic build provenance ties the artifact to its source | −0 |
| coverage-honesty | source | inspection depth (source) — how much of the target the scan could see | −0 |
What the scan could actually read
A grade is only as meaningful as its coverage, so the scanner publishes its own depth before it publishes its result.
No tools were enumerated, so prompt-injection, capability and toxic-flow analysis had no tool surface to inspect. To grade a package’s real runtime tools, scan the running server: --command "npx -y <package>".
Capability — what it could do if the model were manipulated
Tags derived from each tool’s schema and the implementation, not from what the tool calls itself. minimal is the level these add up to.
| Tool | Capability tags | Why the tag was assigned |
|---|---|---|
| No per-tool rows for this release — see the note below. | ||
Toxic-flow graph
The lethal trifecta, checked as a graph rather than as a checklist: untrusted input, a sensitive source and an external sink have to meet before there is a path worth worrying about.
The public result for this release does not print the flow graph, so there is nothing to show here. That is not the same as "no paths were found": what the scan did read is above, under coverage.
Supply chain and provenance
This is the first scan of this surface here, so there is nothing yet to compare it against.
Every result on this tab comes from one deterministic pass over the published package — offline, rule by rule, and auditable line by line above. Same methodology version, same bytes, same score.
Release history
Always latest — the install command names no version, so it installs the newest release when it runs; the current release on file is 0.9.0. Pin a release below and the command asks for exactly that one.
No release note was published with this version.
- The version this listing was on when mcprush began following its releases. The registry was not asked when it shipped, so this row carries no date.
One review per account, from a signed-in account that does not publish this listing. Nothing else is asked — you can say what you think before you install it. Publishers can reply once per review, and a review can be edited or deleted by whoever wrote it.
Any signed-in account that does not publish Adobe Illustrator MCP can review it, once — before installing it or after. A review from an account that has installed it is marked as one.
Nobody has reviewed this listing. The rating on the card is the mean of the reviews written here and nothing else, so there is no rating until somebody writes the first — which takes a signed-in account that does not publish it, and nothing else.