Adobe Illustrator Application API

openapi: 3.1.0
info:
  title: Adobe Illustrator Scripting Application API
  description: The Adobe Illustrator Scripting API provides programmatic access to Illustrator's functionality through JavaScript, AppleScript, and VBScript. It allows developers to automate repetitive tasks, manipulate documents, select and edit text, generate art from data, and batch process files. Scripts can control nearly every aspect of Illustrator, from creating and modifying paths and shapes to managing layers, colors, and typography.
  version: 29.0.0
  contact:
    name: Adobe Developer Support
    url: https://developer.adobe.com/illustrator/
  license:
    name: Proprietary
    url: https://www.adobe.com/legal/terms.html
  x-logo:
    url: https://www.adobe.com/favicon.ico
servers:
- url: https://localhost
  description: Local Illustrator Application
tags:
- name: Application
  description: Access to the Illustrator application object, including preferences, version information, and global settings.
paths:
  /application:
    get:
      operationId: getApplication
      summary: Adobe Illustrator Get Application Information
      description: Returns information about the Illustrator application, including the version, build number, locale, and current preferences.
      tags:
      - Application
      responses:
        '200':
          description: Application information retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /application/preferences:
    get:
      operationId: getPreferences
      summary: Adobe Illustrator Get Application Preferences
      description: Returns the current application preferences, including general, type, units, guides, and smart guides preferences.
      tags:
      - Application
      responses:
        '200':
          description: Preferences retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Preferences'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updatePreferences
      summary: Adobe Illustrator Update Application Preferences
      description: Updates the application preferences with the provided values.
      tags:
      - Application
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Preferences'
      responses:
        '200':
          description: Preferences updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Preferences'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Preferences:
      type: object
      properties:
        rulerUnits:
          type: string
          description: Default ruler units.
          enum:
          - Points
          - Picas
          - Inches
          - Millimeters
          - Centimeters
          - Pixels
          example: Points
        generalPreferences:
          type: object
          properties:
            keyboardIncrement:
              type: number
              description: Keyboard increment value.
            constrainAngle:
              type: number
              description: Constrain angle in degrees.
            useAreaSelect:
              type: boolean
              description: Whether to use area select.
        typePreferences:
          type: object
          properties:
            showHiddenCharacters:
              type: boolean
              description: Whether to show hidden characters.
            useSmartQuotes:
              type: boolean
              description: Whether to use smart quotes.
    Application:
      type: object
      properties:
        name:
          type: string
          description: The application name.
          examples:
          - Adobe Illustrator
          example: Example Artboard
        version:
          type: string
          description: The version string.
          examples:
          - 29.0
          example: example_value
        buildNumber:
          type: string
          description: The build number.
          example: example_value
        locale:
          type: string
          description: The current locale.
          examples:
          - en_US
          example: example_value
        scriptingVersion:
          type: string
          description: The scripting API version.
          example: example_value
        freeMemory:
          type: integer
          description: Available memory in bytes.
          example: 1024
        activeDocument:
          type: string
          description: Name of the currently active document.
          example: example_value
        documents:
          type: array
          description: List of open document names.
          items:
            type: string
        userInteractionLevel:
          type: string
          description: The level of user interaction allowed.
          enum:
          - DISPLAYALERTS
          - DONTDISPLAYALERTS
          example: DISPLAYALERTS
externalDocs:
  description: Adobe Illustrator Scripting Guide
  url: https://ai-scripting.docsforadobe.dev/