Layovelle

Import Canvas Edit

Documentation

canvas-actions

Import Canvas Edit

Import an OpenTimelineIO timeline into the Main Edit.

Strict by default: any OTIO item this surface cannot represent fails the whole import with a named fidelity report (on_unsupported=skip imports the rest and reports every dropped item). The converted operations are validated before anything applies; ≤100-operation imports are atomic. mode=replace clears the existing timeline first; append adds after it. External media references resolve only through uploaded media_map entries — unmapped or still-pending media is a named rejection.

POST

canvases

{canvas_ref}

edit

import

Import Canvas Edit
curl --request POST \
  --url https://api.moda.app/v1/canvases/{canvas_ref}/edit/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "otio": {},
  "media_map": {},
  "mode": "replace",
  "on_unsupported": "reject",
  "dry_run": false
}
'
import requests

url = "https://api.moda.app/v1/canvases/{canvas_ref}/edit/import"

payload = {
    "otio": {},
    "media_map": {},
    "mode": "replace",
    "on_unsupported": "reject",
    "dry_run": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    otio: {},
    media_map: {},
    mode: 'replace',
    on_unsupported: 'reject',
    dry_run: false
  })
};

fetch('https://api.moda.app/v1/canvases/{canvas_ref}/edit/import', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.moda.app/v1/canvases/{canvas_ref}/edit/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'otio' => [
        
    ],
    'media_map' => [
        
    ],
    'mode' => 'replace',
    'on_unsupported' => 'reject',
    'dry_run' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moda.app/v1/canvases/{canvas_ref}/edit/import"

	payload := strings.NewReader("{\n  \"otio\": {},\n  \"media_map\": {},\n  \"mode\": \"replace\",\n  \"on_unsupported\": \"reject\",\n  \"dry_run\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.moda.app/v1/canvases/{canvas_ref}/edit/import")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"otio\": {},\n  \"media_map\": {},\n  \"mode\": \"replace\",\n  \"on_unsupported\": \"reject\",\n  \"dry_run\": false\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.moda.app/v1/canvases/{canvas_ref}/edit/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"otio\": {},\n  \"media_map\": {},\n  \"mode\": \"replace\",\n  \"on_unsupported\": \"reject\",\n  \"dry_run\": false\n}"

response = http.request(request)
puts response.read_body

{}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}
{
  "type": "invalid_request",
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>",
  "causes": [
    "<unknown>"
  ],
  "details": {},
  "retry_after_ms": 123,
  "retryable": true
}

Authorizations

Authorization

string

header

required

API key from Settings > Developer > REST API

Headers

Layovelle-Version

enum<string>

default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:

2026-04-12,

2026-05-01

Example:

"2026-05-01"

Path Parameters

canvas_ref

string

required

Body

application/json

OTIO timeline import. otio is the OTIO JSON document (object or string).

otio

required

media_map

Media Map · object | null

Staged media-map manifest (moment-index media_map schema): uploaded entries resolve external media references to Layovelle assets; pending entries are named rejections, never placeholders.

mode

enum<string>

default:replace

Available options:

replace,

append

on_unsupported

enum<string>

default:reject

reject: any unrepresentable OTIO item fails the whole import (default). skip: import what is supported and report every dropped item in fidelity.

Available options:

reject,

skip

dry_run

boolean

default:false

Response

Successful Response

The response is of type Response Editimport · object.