Examples

The following examples show how to use the API to accomplish specific tasks using the default configuration.

note

If you are using a server with a customised configuration you may need to alter the examples slightly to make them work correctly.

Most of the examples assume you have the ftrack_api package imported and have already constructed a Session:

Python

import ftrack_api

session = ftrack_api.Session(
  server_url="https://my-company.ftrackapp.com",
  api_key="jane.doe@example.com",
  api_user="7545344e-a653-11e1-a82c-f22c11dd25eq"
)

JavaScript

const session = new ftrack.Session(
  "https://my-company.ftrackapp.com",
  "john.doe@example.com",
  "7545344e-a653-11e1-a82c-f22c11dd25eq",
);