Update Project Video

curl -X PATCH \
  https://studio.dubformer.ai/api/projects/PROJECT_ID/videos/VIDEO_ID \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "New video name",
    "dstLangs": ["en", "fr"],
    "processingType": "standard",
    "status": "in_progress",
    "remark": "Updated video description"
  }'

import axios from 'axios';

const response = await axios.patch(
  'https://studio.dubformer.ai/api/projects/PROJECT_ID/videos/VIDEO_ID',
  {
    name: 'New video name',
    dstLangs: ['en', 'fr'],
    processingType: 'standard',
    status: 'in_progress',
    remark: 'Updated video description'
  },
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data); // updated video object

{
  "id": "vid_7a92c36d4fe3c",
  "name": "New video name",
  "status": "in_progress",
  "processingType": "standard",
  "srcLang": "ru",
  "dstLangs": ["en", "fr"],
  "videoUrl": "https://...",
  "remark": "Updated video description",
  "createdAt": "2024-06-01T12:00:00.000Z",
  "updatedAt": "2024-06-01T12:34:56.000Z"
}

PATCH

api

projects

{projectId}

videos

{videoId}

curl -X PATCH \
  https://studio.dubformer.ai/api/projects/PROJECT_ID/videos/VIDEO_ID \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "New video name",
    "dstLangs": ["en", "fr"],
    "processingType": "standard",
    "status": "in_progress",
    "remark": "Updated video description"
  }'

import axios from 'axios';

const response = await axios.patch(
  'https://studio.dubformer.ai/api/projects/PROJECT_ID/videos/VIDEO_ID',
  {
    name: 'New video name',
    dstLangs: ['en', 'fr'],
    processingType: 'standard',
    status: 'in_progress',
    remark: 'Updated video description'
  },
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data); // updated video object

{
  "id": "vid_7a92c36d4fe3c",
  "name": "New video name",
  "status": "in_progress",
  "processingType": "standard",
  "srcLang": "ru",
  "dstLangs": ["en", "fr"],
  "videoUrl": "https://...",
  "remark": "Updated video description",
  "createdAt": "2024-06-01T12:00:00.000Z",
  "updatedAt": "2024-06-01T12:34:56.000Z"
}

This endpoint allows you to update various properties of a video in a project: name, translation languages, processing type, status, and remark.

Path Parameters

string

required

The unique identifier of the project.

string

required

The unique identifier of the video to update.

Request Body

string

New name for the video.

string[]

New translation languages for the video.

string

New processing type for the video.

string

New status for the video.

string

New remark for the video.

array

Array of key-value pairs for storing video metadata. Useful for storing external system references like backlinks, identifiers, or other custom metadata. Replaces the entire array when provided.Each item should be an object with key and value properties (both strings).Example:

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

object

Extra translation guidance passed to the translation engine. Replaces the stored value when provided.

common (string): Guidance applied to all target languages.
byLang (object): Per-language guidance, keyed by target language code. Each key must be one of the video’s target languages (the dstLangs sent in the same request, or the video’s existing ones).

Example:

{
  "common": "Keep brand names in English and use a friendly tone.",
  "byLang": {
    "de-DE": "Use the formal register (Sie)."
  }
}

curl -X PATCH \
  https://studio.dubformer.ai/api/projects/PROJECT_ID/videos/VIDEO_ID \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "New video name",
    "dstLangs": ["en", "fr"],
    "processingType": "standard",
    "status": "in_progress",
    "remark": "Updated video description"
  }'

import axios from 'axios';

const response = await axios.patch(
  'https://studio.dubformer.ai/api/projects/PROJECT_ID/videos/VIDEO_ID',
  {
    name: 'New video name',
    dstLangs: ['en', 'fr'],
    processingType: 'standard',
    status: 'in_progress',
    remark: 'Updated video description'
  },
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data); // updated video object

Response

string

required

The unique identifier of the video.

string

required

The name of the video.

string

required

The status of the video.

string

required

The processing type of the video.

string

required

The source language of the video.

string[]

required

The translation languages of the video.

string

required

The URL of the video file.

string

The remark for the video.

array | null

Array of key-value pairs with video metadata, or null if not set.

object | null

The translation guidance stored for the video (common and/or byLang), or null if not set.

string

required

Creation timestamp.

string

required

Last update timestamp.

{
  "id": "vid_7a92c36d4fe3c",
  "name": "New video name",
  "status": "in_progress",
  "processingType": "standard",
  "srcLang": "ru",
  "dstLangs": ["en", "fr"],
  "videoUrl": "https://...",
  "remark": "Updated video description",
  "createdAt": "2024-06-01T12:00:00.000Z",
  "updatedAt": "2024-06-01T12:34:56.000Z"
}

{
  "error": "No valid fields to update"
}

Notes

You can update one or several fields in a single request
The video must exist and belong to a project that you have access to
The response format matches the get-project-video endpoint

Getting Started

Artifacts

Projects

Project Videos

Path Parameters

Request Body

Response

Notes

​Path Parameters

​Request Body

​Response

​Notes

Path Parameters

Request Body

Response

Notes