Video Plugin

Create video

POST

http://localhost:3000/api/plugins/videos

This API Endpoint allows uploading the video file along with related metadata.

Create video

curl -X POST 'http://localhost:3000/api/plugins/videos' \
  --form-string 'isActive=true' \
  --form-string 'isArchived=false' \
  --form-string 'archivedAt=2018-11-21T06:20:32.232Z' \
  --form-string 'tenantId=string' \
  --form-string 'organizationId=string' \
  --form-string 'title=My Project Demo Video 2024' \
  --form-string 'duration=0' \
  --form-string 'size=0' \
  --form-string 'fullUrl=string' \
  --form-string 'description=string' \
  --form-string 'storageProvider=LOCAL' \
  --form-string 'resolution=string' \
  --form-string 'codec=string' \
  --form-string 'frameRate=0' \
  --form-string 'timeSlotId=string' \
  --form-string 'file={"fieldname":"videoFile","key":"project-demo-2024.mp4","originalname":"project-demo-original.mp4","size":10485760,"encoding":"7bit","mimetype":"video/mp4","filename":"project-demo-2024.mp4","url":"https://example.com/project-demo-2024.mp4","path":"/uploads/project-demo-2024.mp4"}'

const form = new FormData();
form.append('isActive', 'true');
form.append('isArchived', 'false');
form.append('archivedAt', '2018-11-21T06:20:32.232Z');
form.append('tenantId', 'string');
form.append('organizationId', 'string');
form.append('title', 'My Project Demo Video 2024');
form.append('duration', '0');
form.append('size', '0');
form.append('fullUrl', 'string');
form.append('description', 'string');
form.append('storageProvider', 'LOCAL');
form.append('resolution', 'string');
form.append('codec', 'string');
form.append('frameRate', '0');
form.append('timeSlotId', 'string');
form.append('file', '{"fieldname":"videoFile","key":"project-demo-2024.mp4","originalname":"project-demo-original.mp4","size":10485760,"encoding":"7bit","mimetype":"video/mp4","filename":"project-demo-2024.mp4","url":"https://example.com/project-demo-2024.mp4","path":"/uploads/project-demo-2024.mp4"}');
const response = await fetch('http://localhost:3000/api/plugins/videos', {
  method: 'POST',
  headers: {},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
        ('isActive', (None, 'true')),
        ('isArchived', (None, 'false')),
        ('archivedAt', (None, '2018-11-21T06:20:32.232Z')),
        ('tenantId', (None, 'string')),
        ('organizationId', (None, 'string')),
        ('title', (None, 'My Project Demo Video 2024')),
        ('duration', (None, '0')),
        ('size', (None, '0')),
        ('fullUrl', (None, 'string')),
        ('description', (None, 'string')),
        ('storageProvider', (None, 'LOCAL')),
        ('resolution', (None, 'string')),
        ('codec', (None, 'string')),
        ('frameRate', (None, '0')),
        ('timeSlotId', (None, 'string')),
        ('file', (None, '{"fieldname":"videoFile","key":"project-demo-2024.mp4","originalname":"project-demo-original.mp4","size":10485760,"encoding":"7bit","mimetype":"video/mp4","filename":"project-demo-2024.mp4","url":"https://example.com/project-demo-2024.mp4","path":"/uploads/project-demo-2024.mp4"}')),
    ]
    response = requests.request('POST', 'http://localhost:3000/api/plugins/videos', headers={}, files=files)
    print(response.text)

Request Body

{
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "title": "My Project Demo Video 2024",
  "duration": 0,
  "size": 0,
  "fullUrl": "string",
  "description": "string",
  "storageProvider": "LOCAL",
  "resolution": "string",
  "codec": "string",
  "frameRate": 0,
  "timeSlotId": "string",
  "file": {
    "fieldname": "videoFile",
    "key": "project-demo-2024.mp4",
    "originalname": "project-demo-original.mp4",
    "size": 10485760,
    "encoding": "7bit",
    "mimetype": "video/mp4",
    "filename": "project-demo-2024.mp4",
    "url": "https://example.com/project-demo-2024.mp4",
    "path": "/uploads/project-demo-2024.mp4"
  }
}

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "title": "string",
  "file": "string",
  "duration": 0,
  "size": 0,
  "fullUrl": "string",
  "description": "string",
  "storageProvider": "LOCAL",
  "resolution": "string",
  "codec": "string",
  "frameRate": 0,
  "timeSlotId": "string"
}

Body

multipart/form-data

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

titlestringrequired

The title of the video

Example

My Project Demo Video 2024

recordedAttimestamptz

Date when the video was recorded

durationnumberrequired

Duration of the video in seconds

sizenumberrequired

Size of the video file in bytes

fullUrlstringrequired

Full URL to access the video

descriptionstringrequired

Video description

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

resolutionstring

Video resolution in format WIDTH:HEIGHT (e.g., 1920:1080, 3840:2160)

codecstring

Video codec used for encoding (e.g., libx264, libx265, vp9)

frameRatenumberrequired

Video frame rate

timeSlotIdstring

The UUID of the associated TimeSlot

fileFileDTOrequired

The uploaded video file object containing metadata and properties

Show child attributes

fieldnamestringrequired

The field name associated with the file

Example

videoFile

keystringrequired

The file path or identifier of the video

Example

project-demo-2024.mp4

originalnamestringrequired

The original file name

Example

project-demo-original.mp4

sizenumberrequired

The size of the file in bytes

Example

10485760

encodingstringrequired

The file encoding (if available)

Example

7bit

mimetypestringrequired

The MIME type of the file (if available)

Example

video/mp4

filenamestringrequired

The file name

Example

project-demo-2024.mp4

urlstringrequired

The public URL of the file

Example

https://example.com/project-demo-2024.mp4

pathstringrequired

The full path of the file

Example

/uploads/project-demo-2024.mp4

Response

200OKVideo

Video successfully.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

titlestringrequired

Title of the video

filestringrequired

Video file path or identifier

recordedAttimestamptz

Date when the video was recorded

durationnumberrequired

Duration of the video in seconds

sizenumberrequired

Size of the video file in bytes

fullUrlstringrequired

Full URL to access the video

descriptionstringrequired

Video description

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEAN

resolutionstring

Video resolution in format WIDTH:HEIGHT (e.g., 1920:1080, 3840:2160)

codecstring

Video codec used for encoding (e.g., libx264, libx265, vp9)

frameRatenumberrequired

Video frame rate

timeSlotIdstring

The UUID of the associated TimeSlot

400Bad Request

Invalid input provided. Check the response body for error details.

Stack Overflow Website Demo