After Effects Endpoints

The CEP panel calls these endpoints. They are also useful for any AE-style integration you might build yourself.

Resolve a URL

POST /api/integrations/after-effects/resolve-media
{
  "board_id": "…",
  "url": "https://www.youtube.com/watch?v=…"
}

Runs the URL parser, downloads media, returns the resulting elements:

{
  "elements": [
    { "id": "…", "type": "video", "url": "/media/…", "name": "…" }
  ]
}

The elements are added to the board.

List elements for import

GET /api/integrations/after-effects/elements?board_id=…

Returns a flat list of every element suitable for AE import (images, videos, HTML pre-renders). The format is optimised for the CEP panel’s list view.

Get an element’s import URL

GET /api/integrations/after-effects/elements/{eid}/download?board_id=…

Returns a streaming download of the file. The CEP panel uses this to copy the file into the AE project folder.

Status check

GET /api/integrations/after-effects/status

Returns:

{
  "version":  "2.3.3",
  "backend_port": 18000,
  "boards_count": 12
}

The CEP panel polls this to detect the desktop app and surface “Desktop app not running” if it gets no response.

Where to go next

Was this helpful?

0

Updated

Comments

Leave a Reply

Your email address will not be published. Required fields are marked *