Skip to main content

API Clients

This section outlines the officially supported API clients - JavaScript and Python, explaining their functionality along with a collection of usage examples. For a comprehensive understanding of the API endpoint, please refer to the API section.

Overview​

📄️ Client comparison

There are two official API clients for ftrack, a Python client and a JavaScript client. Besides the language they use they have some fundamental differences. The Python client has more helper functions and automatic conveniences. It's especially targeted towards backend scripting and pipeline automation. On the other hand, the JavaScript client adopts a thinner design, focusing on direct interactions with the ftrack API, which is better suited for web development and lightweight applications. For most use cases they are however interchangeable, and a team more used to working with one language or the other can confidently choose whichever fits them the best, as long as they are aware of the differences in how they work.