Get Video Info

This endpoint is used to get video info like dimensions, thumbnail, source url, etc.

POST /meta/get_video_info

Get Video Info

cURL

curl --request POST \
  --url https://public.plai.io/meta/get_video_info \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userId": "<string>",
  "videoId": "<string>"
}
'

200

{
  "success": true,
  "results": {
    "success": true,
    "video": {
      "thumbnails": {
        "data": [
          {
            "id": "<string>",
            "height": 123,
            "scale": 123,
            "uri": "<string>",
            "width": 123,
            "is_preferred": true
          }
        ]
      },
      "source": "<string>",
      "status": {
        "video_status": "<string>",
        "uploading_phase": {
          "status": "<string>"
        },
        "processing_phase": {
          "status": "<string>"
        },
        "publishing_phase": {
          "status": "<string>",
          "publish_status": "<string>",
          "publish_time": "<string>"
        }
      },
      "id": "<string>"
    },
    "error": "<string>"
  }
}

Request Body

userId · string · required

User ID, If not already created, make a user on create user page first. If already created, retrieve the user ID from get profile page.

videoId · string · required

Video ID, If not already created, make a video on upload video page first.

Response

success · boolean

Indicates that the HTTP response was successful (status code 200 OK).

results · object

Show Results Object

success · boolean

Indicates whether the specific operation or API action was successful.

video · object

Show Video Object

thumbnails · object

Show Thumbnails Object

data · object[]

Show Thumbnail Data Array

Show Thumbnail Object

id · string

Unique identifier for the thumbnail.

height · number

Height of the thumbnail in pixels.

scale · number

Scale factor of the thumbnail.

uri · string

URL where the thumbnail can be accessed.

width · number

Width of the thumbnail in pixels.

is_preferred · boolean

Indicates if this is the preferred thumbnail.

source · string

The source URL of the video file.

status · object

Show Status Object

video_status · string

Current status of the video (e.g., “ready”).

uploading_phase · object

Show Uploading Phase Object

status · string

Status of the uploading phase (e.g., “complete”).

processing_phase · object

Show Processing Phase Object

status · string

Status of the processing phase (e.g., “complete”).

publishing_phase · object

Show Publishing Phase Object

status · string

Status of the publishing phase (e.g., “complete”).

publish_status · string

Current publish status (e.g., “published”).

publish_time · string

Timestamp when the video was published (ISO 8601 format).

id · string

The unique identifier for the video.

error · string

Error string if something went wrong