Skip to content
HELP / DEVELOPERSOpen Chucksi ↗

CONNECT TO CHUCKSI

Chucksi API reference

Connect your application to the same tools and recipes used by Chucksi.

Base URL

https://console.chucksi.com/api/v1

Public discovery requires no key. All routes below support GET and HEAD, with OPTIONS for cross-origin requests. Successful responses may be cached for 300 seconds.

RouteResponse
/capabilitiesSupported actions, remote-action flags and connection links.
/toolsStudio directory.
/tools/{id}One studio’s features, inputs, outputs and URL.
/presetsEffect and camera recipes.
/presets/{id}One preset with settings, preview and studio URL.
/workflowsProductive workflow recipes.
/workflows/{id}One workflow with ordered steps.

Search and filter

curl 'https://console.chucksi.com/api/v1/presets?category=effects&q=scan'
curl 'https://console.chucksi.com/api/v1/presets/fx-lidar-cyan'
curl 'https://console.chucksi.com/api/v1/workflows/release-teaser'

Lists return version, count and items. Details return version and item. Search q is case-insensitive, up to 100 characters. Category is an exact match, up to 40 characters. Preset categories are effects and moves. An unknown filter returns an empty list.

Execution is explicit

Resources identify execution: "studio" and remoteExecution: false. Opening a studio URL is a handoff, not a render job. No public POST generation route, API-key management or account access is offered by this version.

Errors

400: invalid search length. 404: unknown resource. 405: unsupported method. Error responses contain an error string and are not cached.

Website compatibility

/templates and /templates/{id} remain compatible with existing Website integrations. They return public examples, not account drafts. Template browsing is at Website → Templates.

Download the OpenAPI 3.1 specification →