Skip to content

Developer overview

fxquinox is API-first, so extending it means talking to the same API every built-in surface uses. There are no private back doors: the web UI, the desktop app, the DCC integrations and your own scripts are all clients of one API. That is The One Law, and it is what makes the platform easy to build on.

Ways to build on fxquinox

  • Use the SDK

    fxqclient - an object-oriented Python client for scripting fxquinox.

  • Authentication and API keys

    Log in, issue API keys, and authenticate scripts and services.

  • Events and realtime

    Subscribe to changes over WebSocket and react to them.

  • Pipeline APIs

    Path resolution, the universal loader, the render farm, and multi-site sync.

  • Integrations

    The desktop app and the Houdini and Nuke publish/load adapters.

  • Architecture

    How the codebase fits together — the universal Record store and the one-API model.

Reference

For the exhaustive surface, see the API reference: the HTTP API, the Python SDK, and the Python core.

Contributing

Want to work on fxquinox itself rather than against it? See Contributing and how the docs work.