Skip to content

API reference

fxquinox is API-first: everything the UI, desktop app and DCC plugins do goes through one canonical API. There are three ways to work against it.

  • HTTP API

    The canonical REST surface, rendered live from OpenAPI. Browse every endpoint, with request and response schemas, in a full-screen reference.

  • Python SDK (fxqclient)

    The recommended way to script against fxquinox: an object-oriented client with Session, Entity and QuerySet.

  • Python core (fxq)

    The backend implementation behind the API, for contributors and advanced integrators.

Which should I use?

You want to... Use
Call the service from any language The HTTP API
Script fxquinox from Python The SDK
Understand or extend the backend The core reference

The SDK and the web UI are both clients of the HTTP API with no privileged access, so anything you can do in one you can do in the others.