Open interface

LockitNetwork API

Our Clip Inspector and reporting aren’t specific enough for you? With our API you can use real set data in your own applications – for example for custom-built post-production pipelines and workflows.

Read the API docs Contact

Available for projects running on the Production Service.

POST/projects/{projectId}/projectdays/{dayId}/matchClips

// Camera clips of a shooting day
[
  "A001_C001_1234.R3D",
  "A001_C002_1234.R3D"
]

// Response: set data per matched clip
200 OK
{
  "matched": {
    "A001_C001_1234.R3D": {
      "preformatted": {
        "scene": "12",  // scene
        "shot": "3",    // shot
        "take": "2",    // take
        "takeComment": "Sharp focus"
      },
      "take": {
        "printState": 1  // good take
      },
      …
    }
  },
  "unmatched": [ … ]
}

01 Int. Cutting Room – Night

Who is the API for?

LockitScript metadata from set reflects the actual state of the shoot. And you can put this data to use.

Post-production

Match camera clips to the scenes and takes from set by their file names and bring the metadata into your own post-production pipeline.

3rd-party tool makers

Fill your own application with real set data instead of copying it by hand – and attach your own values back to scenes, takes or clips.

Production & controlling

Pull the daily progress report as structured data and use it for your own analysis of progress, working hours and material.

02 Int. Production Office – Day

What the API delivers

Among other things, you can query the following information via our API:

Projects, episodes and scenes – with content, day/night, interior/exterior, sets, scheduled shooting day and status
All shooting days of a project with their dates
Clip matching: merge camera clips with a shooting day’s set data by their file names
Daily progress report as structured data: scenes shot, cast, working hours, material consumption, shooting ratios
Annotations: attach your own JSON values to a project, scene, take, clip or shooting day
Write back: send a scene’s comment and editor’s running time from post back into the project

REST with JSON
OpenAPI specification
API token or OAuth 2

03 Int. Production Office – Continuous

Access management built in

You decide who can access the API and which data is made available.

Access per account

Every request runs through a user account, via API token or OAuth 2, and only returns data from projects that account is authorised for.

Full control

Post-production or an external tool doesn’t automatically see everything. What can be retrieved depends on the permissions of the connected account, which you set in LockitWebTools.

04 End Credits

Customisation

If you don’t want to build your own tools but still need the set data prepared in a different way, we can offer you a customised solution. Just get in touch.

Get in touch