Create Project Video

Add a new video to an existing project

POST /api/v1/projects/{projectId}/videos/create

cURL (Dubbing)

curl -X POST \
  https://studio.dubformer.ai/api/v1/projects/proj_5f83a14b2ec1b/videos/create \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "New Marketing Video",
    "workflowType": "dubbing",
    "sourceArtifactId": "artifact_1234567890",
    "sourceLanguage": "en",
    "targetLanguages": ["es-ES", "fr-FR"],
    "pipelineOptions": {
      "shouldAutomateTranscription": true,
      "shouldAutomateTranslation": true,
      "shouldAutomateVoiceSelection": false
    },
    "remark": "Optional comment",
    "stringVariables": [
      { "key": "storyTitleId", "value": "12345" },
      { "key": "storyDeeplink", "value": "https://pyramid.dalet.euronews.tech?titleId=12345&kanbanViewId=7KV6cv" }
    ]
  }'

Response

{
  "id": "vid_7a92c36d4fe3c",
  "videoUrl": "https://studio.dubformer.ai/api/v1/projects/proj_5f83a14b2ec1b/videos/vid_7a92c36d4fe3c",
  "name": "New Marketing Video",
  "status": "new",
  "workflowType": "dubbing",
  "srcLang": "en",
  "dstLangs": ["es-ES", "fr-FR"],
  "videoDuration": 123.45,
  "remark": "Optional comment",
  "stringVariables": [
    { "key": "storyTitleId", "value": "12345" },
    { "key": "storyDeeplink", "value": "https://pyramid.dalet.euronews.tech?titleId=12345&kanbanViewId=7KV6cv" }
  ],
  "createdAt": "2024-06-30T12:00:00.000Z",
  "updatedAt": "2024-06-30T12:00:00.000Z"
}

This endpoint allows you to add a new video to an existing project. The video will be uploaded to the pipeline for processing.

Path Parameters

projectId · string · required

The unique identifier of the project.

Request Body

name · string · required

Name of the video.

workflowType · string · required

Type of video processing (e.g., dubbing, voiceover, audio_description, transcription, translation, subtitling).

sourceArtifactId · string · required

Artifact ID of the source video (must be uploaded beforehand).

sourceLanguage · string · required

Source language code in ISO 639-1 format (e.g., en, ru, de).

You can also pass multi to enable multi-language source mode, where the source video contains speech in multiple languages. In this mode, the system will automatically detect the language of each segment.

The multi option must be enabled for your organization by an administrator. Contact your account manager to activate multi-language source support.

targetLanguages · array · required

Array of target language codes in BCP 47 format — a combination of an ISO 639-1 language code and an ISO 3166-1 Alpha-2 region code (e.g., es-ES, fr-FR, en-US).

backgroundWavArtifactId · string

Artifact ID of the background audio (optional).

internationalMixWavArtifactId · string

Artifact ID of the international mix audio (optional).

vocalsHitlWavArtifactId · string

Artifact ID of the vocals HITL audio (optional).

remark · string

Additional remarks about the video (optional).

stringVariables · array

Optional array of key-value pairs for storing video metadata. Useful for storing external system references like backlinks, identifiers, or other custom metadata.

Each item should be an object with key and value properties (both strings).

Example:

[
  { "key": "storyTitleId", "value": "12345" },
  { "key": "storyDeeplink", "value": "https://..." }
]

pipelineOptions · object

Pipeline configuration options (see below, all fields optional):

• shouldAutomateTranscription: boolean
• shouldAutomateTranslation: boolean
• shouldAutomateVoiceSelection: boolean

subtitlingParams · object

Subtitling parameters per destination language. Used only when workflowType is subtitling.

This is an object where keys are language codes (e.g., ‘en-US’, ‘es-ES’) and values are objects with the following optional fields:

• maxLinesPerSubtitle (number): Maximum number of lines per subtitle (default: 2, range: 1-5)
• maxCharsPerLine (number): Maximum number of characters per line (CPL) (default: 30, range: 1-1000)
• maxCharsPerSecond (number): Maximum reading speed in characters per second (CPS) (default: 20, range: 1-100)
• minDurationMs (number): Minimum subtitle duration in milliseconds (default: 1000, range: 100-60000)
• maxDurationMs (number): Maximum subtitle duration in milliseconds (default: 6000, range: 100-60000)

Example:

{
  "en-US": {
    "maxLinesPerSubtitle": 2,
    "maxCharsPerLine": 30,
    "maxCharsPerSecond": 20,
    "minDurationMs": 1000,
    "maxDurationMs": 6000
  },
  "es-ES": {
    "maxLinesPerSubtitle": 2,
    "maxCharsPerLine": 35,
    "maxCharsPerSecond": 18,
    "minDurationMs": 1000,
    "maxDurationMs": 6000
  }
}

If you automate transcription, you won’t be able to edit the generated transcription in the future. The transcription phase will be skipped, and the result of the AI’s work will be used.

cURL (Dubbing)

curl -X POST \
  https://studio.dubformer.ai/api/v1/projects/proj_5f83a14b2ec1b/videos/create \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "New Marketing Video",
    "workflowType": "dubbing",
    "sourceArtifactId": "artifact_1234567890",
    "sourceLanguage": "en",
    "targetLanguages": ["es-ES", "fr-FR"],
    "pipelineOptions": {
      "shouldAutomateTranscription": true,
      "shouldAutomateTranslation": true,
      "shouldAutomateVoiceSelection": false
    },
    "remark": "Optional comment",
    "stringVariables": [
      { "key": "storyTitleId", "value": "12345" },
      { "key": "storyDeeplink", "value": "https://pyramid.dalet.euronews.tech?titleId=12345&kanbanViewId=7KV6cv" }
    ]
  }'

Response

id · string

Unique identifier of the created video.

videoUrl · string

URL to the created video resource.

name · string

Name of the video.

status · string

Status of the video (e.g., ‘new’).

workflowType · string

Type of the video processing (e.g., ‘dubbing’).

srcLang · string

Source language code.

dstLangs · array

Array of target language codes.

videoDuration · number

Duration of the video in seconds (if available).

remark · string

Additional remarks about the video (if any).

stringVariables · array | null

Array of key-value pairs containing video metadata, if provided.

createdAt · string

ISO timestamp of creation.

updatedAt · string

ISO timestamp of last update.

Response

{
  "id": "vid_7a92c36d4fe3c",
  "videoUrl": "https://studio.dubformer.ai/api/v1/projects/proj_5f83a14b2ec1b/videos/vid_7a92c36d4fe3c",
  "name": "New Marketing Video",
  "status": "new",
  "workflowType": "dubbing",
  "srcLang": "en",
  "dstLangs": ["es-ES", "fr-FR"],
  "videoDuration": 123.45,
  "remark": "Optional comment",
  "stringVariables": [
    { "key": "storyTitleId", "value": "12345" },
    { "key": "storyDeeplink", "value": "https://pyramid.dalet.euronews.tech?titleId=12345&kanbanViewId=7KV6cv" }
  ],
  "createdAt": "2024-06-30T12:00:00.000Z",
  "updatedAt": "2024-06-30T12:00:00.000Z"
}

Error Response

{
  "error": "Bad Request"
}