API

This section outlines the ftrack API endpoint, focusing on the HTTP data payload. Here you can learn about general API concepts you need for interacting with our API, like our query language, and can be used as a base when implementing API clients for your specific programming language.

ftrack already provides API clients for some popular programming languages. Read more at the API clients section.

Overview

📄️ Endpoint

The API is available over HTTP with JSON used as the data transmission format.

📄️ Authentication

API keys are used to control access to resources through the API. There are two types of API keys in ftrack, personal and global.

🗃️ Operations

39 items

📄️ Uploading files

Uploading and downloading of components in the ftrack.server location is handled separately from the rest of the API.

📄️ Schemas

As ftrack supports customizing entity types and attributes, the API makes use of schemas to describe which entity types and attributes are available for a particular server.

📄️ Query language

The API provides a straightforward, but powerful query language. Using queries correctly can often substantially speed up your code as well as reduce the amount of code written.

📄️ Performance

The ftrack API is a powerful tool for developers to access and manipulate data stored in ftrack Studio. However, when using the API, it is crucial to ensure your requests are as efficient as possible lest your application underperforms or, worse, the scripts affect your workspace.