POST /import/otio/projects/{project_id}/episodes/{episode_id}
Jwt authorization

Import an OTIO file to set frame_in, frame_out, and nb_frames for shots in an episode. Supports any OpenTimelineIO adapter format like EDL or OTIO. Uses naming convention with episode name to match shots.

Path parameters

  • project_id string(uuid) Required
  • episode_id string(uuid) Required

Query parameters

  • naming_convention string

    Template for matching shot names from the file

  • match_case boolean

    Whether to match shot names case-sensitively

Responses

  • 201 application/json

    Shots imported successfully

    Hide response attributes Show response attributes object
    • updated_shots array[object]
      Hide updated_shots attributes Show updated_shots attributes object
      • id string(uuid)
      • name string
      • project_id string(uuid)
      • nb_frames integer
      • data object
        Hide data attributes Show data attributes object
        • frame_in integer
        • frame_out integer
    • created_shots array[object]
      Hide created_shots attributes Show created_shots attributes object
      • id string(uuid)
      • name string
      • project_id string(uuid)
      • nb_frames integer
      • data object
        Hide data attributes Show data attributes object
        • frame_in integer
        • frame_out integer
  • 400

    Invalid file format or parsing error

POST /import/otio/projects/{project_id}/episodes/{episode_id} 
curl -X POST "http://api.example.com/import/otio/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/b24a6ea4-ce75-4665-a070-57453082c25?naming_convention=%24%7Bproject_name%7D_%24%7Bepisode_name%7D-%24%7Bsequence_name%7D-%24%7Bshot_name%7D&match_case=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
import requests

url = "http://api.example.com/import/otio/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/b24a6ea4-ce75-4665-a070-57453082c25"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {
    "naming_convention": "${project_name}_${episode_name}-${sequence_name}-${shot_name}",
    "match_case": true
}
payload = None

response = requests.post(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
curl \
 --request POST 'http://api.example.com/import/otio/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes/b24a6ea4-ce75-4665-a070-57453082c25' \
 --header "Authorization: $API_KEY"
Response examples (201) 
{
  "updated_shots": [
    {
      "id": "a24a6ea4-ce75-4665-a070-57453082c25",
      "name": "SH010",
      "project_id": "c24a6ea4-ce75-4665-a070-57453082c25",
      "nb_frames": 120,
      "data": {
        "frame_in": 1001,
        "frame_out": 1120
      }
    }
  ],
  "created_shots": [
    {
      "id": "d24a6ea4-ce75-4665-a070-57453082c25",
      "name": "SH020",
      "project_id": "c24a6ea4-ce75-4665-a070-57453082c25",
      "nb_frames": 96,
      "data": {
        "frame_in": 2001,
        "frame_out": 2096
      }
    }
  ]
}