Update a Video By Video ID

POST /videos/[id]

Update the properties of a video by its ID. All fields available to be edited are optional, and only the passed fields will be modified. This endpoint will return the full information for the updated video.

Update Request Parameters

• name: (optional) string
• description: (optional) string
• layout: (optional) “2D”, “MVHEVC”, “SBS”, “TB”
• perspective: (optional) “Regular”, “180”, “360”
• isPublished: (optional) boolean

Example request to update a video’s information by ID

updateVideoInfo.js

const updatedVideoData = {
    name: 'new video name',
    description: 'new video description',
    layout: '2D',
    perspective: 'Regular',
    isPublished: true
}

fetch('https://spatialgen.com/api/videos/<yourvideoid>', {
    method: 'POST',
    headers: {
        'X-SPATIALGEN-APPKEY': apiKey,
    },
    body: JSON.stringify(updatedVideoData)
})

Example Response

response.json

{

    "createdAt": string,            // Date in string format
    "description": string,          // Description of the video
    "fileFormat3D": string,         // Format of the 3D file
    "id": number,                   // ID of the video
    "is3D": boolean,                // If the video is in 3D
    "isStreaming": boolean,         // If the video is streaming
    "perspective": number,          // Perspective
    "thumbnailUrl": string,         // Thumbnail URL
    "videoLength": number,          // Length of the video in seconds
    "videoHeight": number,          // Height of the video
    "videoName": string             // Name of the video

}