Duplicate a project

curl --request POST \
  --url https://api-vod-express.syncwords.com/v1/projects/{id}/duplicate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Fishing Channel S02",
  "options": {
    "autoStart": false,
    "copyFiles": true
  }
}
'

import requests

url = "https://api-vod-express.syncwords.com/v1/projects/{id}/duplicate"

payload = {
    "name": "Fishing Channel S02",
    "options": {
        "autoStart": False,
        "copyFiles": True
    }
}
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({name: 'Fishing Channel S02', options: {autoStart: false, copyFiles: true}})
};

fetch('https://api-vod-express.syncwords.com/v1/projects/{id}/duplicate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "01m3k8jnrdw509457nhz7w81bq",
    "name": "Fishing Channel S01",
    "description": null,
    "buildVersion": "0.9.0-alpha1-2026-10-29T15-45Z-d1f144",
    "status": "running",
    "files": {
      "total": 3,
      "pending": 1,
      "processing": 0,
      "done": 1,
      "failed": 1,
      "countedAt": "2026-09-28T06:15:00.000Z"
    },
    "startOnNewFiles": true,
    "config": {
      "sourceMedia": {
        "@type": "S3FolderSource"
      },
      "transcription": {
        "@type": "Speechmatics",
        "language": "en"
      },
      "translations": [
        {
          "language": "es",
          "engine": {
            "@type": "Gemini"
          },
          "ttsOptions": {
            "provider": {
              "@type": "Deepdub",
              "voice": "auto"
            }
          }
        }
      ],
      "outputs": [
        {
          "@type": "S3FolderOutput",
          "items": [
            {
              "@type": "MP4",
              "nameTemplate": "${name}.es.${ext}",
              "copyOriginalAudio": true,
              "dubs": [
                {
                  "@type": "AACTrack",
                  "languages": [
                    {
                      "language": "es"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    },
    "storage": {
      "connection": null,
      "path": "s3://sw-vod-express/projects/141/01m3k8jnrdw509457nhz7w81bq/",
      "inputPath": "s3://sw-vod-express/projects/141/01m3k8jnrdw509457nhz7w81bq/input/",
      "outputPath": "s3://sw-vod-express/projects/141/01m3k8jnrdw509457nhz7w81bq/output/",
      "inputPrefix": null,
      "outputPrefix": null
    },
    "meta": {
      "createdAt": "2026-09-28T05:42:35.534Z",
      "updatedAt": "2026-09-28T05:42:35.534Z",
      "createdBy": {
        "accountId": 141,
        "accountName": "Acme Media",
        "userId": null,
        "userEmail": null,
        "userFullName": null
      },
      "configLocked": false,
      "messages": [],
      "fileCopy": null
    }
  }
}

{
  "message": "<string>",
  "code": "bad_request",
  "errors": {}
}

{
  "message": "Unauthenticated.",
  "code": "unauthenticated"
}

{
  "message": [
    "VOD Express is not enabled for your account."
  ],
  "code": "vod_express_not_enabled"
}

{
  "message": "Project not found.",
  "code": "project_not_found"
}

{
  "message": [
    "A request with this Idempotency-Key is still in progress. Retry it shortly."
  ],
  "code": "idempotency_in_progress"
}

{
  "message": [
    "The request body is too large."
  ],
  "code": "payload_too_large"
}

{
  "message": [
    "Send the body as JSON (Content-Type: application/json) or YAML (Content-Type: application/yaml)."
  ],
  "code": "unsupported_media_type"
}

{
  "code": "validation_failed",
  "message": "No translation has ttsOptions, so there is no dub to add: use copyOriginalAudio for the input’s audio. (and 2 more errors)",
  "errors": {
    "/config/outputs/0/items/0/dubs/0/languages/0/language": [
      "No translation has ttsOptions, so there is no dub to add: use copyOriginalAudio for the input’s audio."
    ],
    "/config/outputs/0/items/0/nameTemplate": [
      "The name template must contain ${name}, or every input would write the same file."
    ],
    "/config/translations/0/language": [
      "Language 'xx' is not supported by engine 'DeepL'"
    ]
  }
}

{
  "message": [
    "Too Many Attempts."
  ],
  "code": "too_many_requests"
}

Projects

Duplicate a project

Creates a new project with this one’s settings: its config, description, startOnNewFiles and storage connection, named Copy of <name>. No files are copied: the copy has input and output folders of its own, empty, and on a storage connection they are the default folders for the copy’s id. The project you copy is only read.

Like a create, the copy runs on your account’s default build unless you name buildVersion, its config is checked in full against that build, and its service starts unless options.autoStart is false. A copy of a feed project reads the same feed: pass autoStart: false and change its sourceMedia before you start it, or both projects process every item. Every body field is optional and replaces what is copied; config is not taken — change the copy with PATCH afterwards.

With options.copyFiles, the project’s input files are copied too, in the background and within your storage (never through the API): meta.fileCopy follows the copy, and each file is processed by the copy as it lands — and billed again. The copy must be on the project’s storage, and a feed project has no files to copy.

Idempotency-Key works as on create.

Guide: Projects

POST

projects

{id}

duplicate

Duplicate a project

curl --request POST \
  --url https://api-vod-express.syncwords.com/v1/projects/{id}/duplicate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Fishing Channel S02",
  "options": {
    "autoStart": false,
    "copyFiles": true
  }
}
'

import requests

url = "https://api-vod-express.syncwords.com/v1/projects/{id}/duplicate"

payload = {
    "name": "Fishing Channel S02",
    "options": {
        "autoStart": False,
        "copyFiles": True
    }
}
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({name: 'Fishing Channel S02', options: {autoStart: false, copyFiles: true}})
};

fetch('https://api-vod-express.syncwords.com/v1/projects/{id}/duplicate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "01m3k8jnrdw509457nhz7w81bq",
    "name": "Fishing Channel S01",
    "description": null,
    "buildVersion": "0.9.0-alpha1-2026-10-29T15-45Z-d1f144",
    "status": "running",
    "files": {
      "total": 3,
      "pending": 1,
      "processing": 0,
      "done": 1,
      "failed": 1,
      "countedAt": "2026-09-28T06:15:00.000Z"
    },
    "startOnNewFiles": true,
    "config": {
      "sourceMedia": {
        "@type": "S3FolderSource"
      },
      "transcription": {
        "@type": "Speechmatics",
        "language": "en"
      },
      "translations": [
        {
          "language": "es",
          "engine": {
            "@type": "Gemini"
          },
          "ttsOptions": {
            "provider": {
              "@type": "Deepdub",
              "voice": "auto"
            }
          }
        }
      ],
      "outputs": [
        {
          "@type": "S3FolderOutput",
          "items": [
            {
              "@type": "MP4",
              "nameTemplate": "${name}.es.${ext}",
              "copyOriginalAudio": true,
              "dubs": [
                {
                  "@type": "AACTrack",
                  "languages": [
                    {
                      "language": "es"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    },
    "storage": {
      "connection": null,
      "path": "s3://sw-vod-express/projects/141/01m3k8jnrdw509457nhz7w81bq/",
      "inputPath": "s3://sw-vod-express/projects/141/01m3k8jnrdw509457nhz7w81bq/input/",
      "outputPath": "s3://sw-vod-express/projects/141/01m3k8jnrdw509457nhz7w81bq/output/",
      "inputPrefix": null,
      "outputPrefix": null
    },
    "meta": {
      "createdAt": "2026-09-28T05:42:35.534Z",
      "updatedAt": "2026-09-28T05:42:35.534Z",
      "createdBy": {
        "accountId": 141,
        "accountName": "Acme Media",
        "userId": null,
        "userEmail": null,
        "userFullName": null
      },
      "configLocked": false,
      "messages": [],
      "fileCopy": null
    }
  }
}

{
  "message": "<string>",
  "code": "bad_request",
  "errors": {}
}

{
  "message": "Unauthenticated.",
  "code": "unauthenticated"
}

{
  "message": [
    "VOD Express is not enabled for your account."
  ],
  "code": "vod_express_not_enabled"
}

{
  "message": "Project not found.",
  "code": "project_not_found"
}

{
  "message": [
    "A request with this Idempotency-Key is still in progress. Retry it shortly."
  ],
  "code": "idempotency_in_progress"
}

{
  "message": [
    "The request body is too large."
  ],
  "code": "payload_too_large"
}

{
  "message": [
    "Send the body as JSON (Content-Type: application/json) or YAML (Content-Type: application/yaml)."
  ],
  "code": "unsupported_media_type"
}

{
  "code": "validation_failed",
  "message": "No translation has ttsOptions, so there is no dub to add: use copyOriginalAudio for the input’s audio. (and 2 more errors)",
  "errors": {
    "/config/outputs/0/items/0/dubs/0/languages/0/language": [
      "No translation has ttsOptions, so there is no dub to add: use copyOriginalAudio for the input’s audio."
    ],
    "/config/outputs/0/items/0/nameTemplate": [
      "The name template must contain ${name}, or every input would write the same file."
    ],
    "/config/translations/0/language": [
      "Language 'xx' is not supported by engine 'DeepL'"
    ]
  }
}

{
  "message": [
    "Too Many Attempts."
  ],
  "code": "too_many_requests"
}

Authorizations

Authorization

string

header

required

A token from POST /token/create, made with your API key pair.

Headers

Idempotency-Key

string

As on POST /projects: a repeat of the call with the same key, project and body answers what the first call did and creates nothing.

Required string length: 1 - 255

Pattern: ^[!-~]+$

Path Parameters

string

required

The project id, a lowercase ULID.

Pattern: ^[0-9a-z]{26}$

Body

application/json

Every field is optional and replaces what is copied from the project. config is the project’s and is not taken here.

name

string

Default: Copy of <name>, cut to 255 characters.

Maximum string length: 255

description

string | null

Default: the project’s.

Maximum string length: 2000

buildVersion

string

The build the copy runs on, from GET /build-versions. Default: your account’s default, not the project’s build.

startOnNewFiles

boolean

Default: the project’s. See startOnNewFiles on create.

storage

object

Default: the project’s storage connection, with the default folders for the copy. {"connectionId": null} puts the copy on SyncWords’ storage.

Show child attributes

options

object

Instructions for the create (or the duplicate) itself: acted on once, not stored, not returned. Refused on PUT/PATCH.

Show child attributes

Response

Created: the copy.

data

object

required

Show child attributes

Overview

Account

Schema

Projects

Files

Feeds

Uploads

Webhooks

Duplicate a project

Authorizations

Headers

Path Parameters

Body

Response