Developing with ftrack Studio

Discover how to develop with ftrack for tighter integration and more customisation options.

17 articles in this collection
Written by Björn Rydahl, Fredrik Limsater, and Mattias Seebergs

Getting started with the API

Extend and customize ftrack with the powerful API – built for pipeline developers for deeper functionality and greater flexibility.

Written by Fredrik Limsater
Updated over a week ago

General

API Clients

Official and community supported clients for the API such as python and javascript.

Written by Fredrik Limsater
Updated over a week ago

API keys

Learn how to authenticate using personal and global API keys.

Written by Fredrik Limsater
Updated over a week ago

Examples

Learn how to use the different API clients by example.

Written by Fredrik Limsater
Updated over a week ago

Review

Publish versions that can be reviewed using the review tools available in ftrack.

Written by Fredrik Limsater
Updated over a week ago

Creating a custom widget (with React)

Learn how to get started building custom widgets for use on dashboards and Actions in ftrack.

Written by Mattias Seebergs
Updated over a week ago

Key Concepts

Events

Detect changes in ftrack using the event hub and learn about the available events.

Written by Björn Rydahl
Updated over a week ago

Actions

Extend ftrack with actions and interact with users via simple forms or flexible widgets.

Written by Björn Rydahl
Updated over a week ago

Custom widgets

Learn how to create your own widgets and use them on dashboards or as actions.

Written by Fredrik Limsater
Updated over a week ago

Locations

Learn how to access locations using the API and write your own location plugins.

Written by Fredrik Limsater
Updated over a week ago

Publishing

How to publish files to ftrack and some of the core concepts around it.

Written by Fredrik Limsater
Updated over a week ago

API Endpoint

Overview

Overview of the API endpoint and how it can be used to create an API client for another programming language.

Written by Fredrik Limsater
Updated over a week ago

Operations

Learn about the different operations supported by the server and how to format the request data.

Written by Fredrik Limsater
Updated over a week ago

Schemas

Schemas describe which entity types and attributes are available for a particular server.

Written by Fredrik Limsater
Updated over a week ago

Query Syntax

API query language is used to filter, sort and specify what data to query.

Written by Fredrik Limsater
Updated over a week ago

Query examples

Advanced query examples for API clients and advanced filter queries.

Written by Mattias Seebergs
Updated over a week ago

Data transfer

How to upload and download components from the ftrack.server location.

Written by Fredrik Limsater
Updated over a week ago