Get a private video

GET 
/api/video/:id/private/:expirationSeconds

This end point retrieves a signed url for a private video that can only be accessed for a set amount of time (expirationSeconds)

Request

Path Parameters

id uuidrequired

The id of the video

expirationSeconds stringrequired

Possible values: non-empty and <= 31536000 characters

The number of seconds the url will be valid for

Header Parameters

X-API-KEY stringrequired

Hyperserve api key

Responses

200

Private video found

application/json

Schema

Schema

id uuidrequired
status stringrequired

Possible values: [pending, ready, fail]

isPublic booleanrequired

variants

object

required

144p

object

id uuidrequired

status stringrequired

Possible values: [pending, ready, fail]

video_url urirequired

thumbnail_image_urls uri[]required

240p

object

id uuidrequired

status stringrequired

Possible values: [pending, ready, fail]

video_url urirequired

thumbnail_image_urls uri[]required

360p

object

id uuidrequired

status stringrequired

Possible values: [pending, ready, fail]

video_url urirequired

thumbnail_image_urls uri[]required

480p

object

id uuidrequired

status stringrequired

Possible values: [pending, ready, fail]

video_url urirequired

thumbnail_image_urls uri[]required

720p

object

id uuidrequired

status stringrequired

Possible values: [pending, ready, fail]

video_url urirequired

thumbnail_image_urls uri[]required

1080p

object

id uuidrequired

status stringrequired

Possible values: [pending, ready, fail]

video_url urirequired

thumbnail_image_urls uri[]required

1440p

object

id uuidrequired

status stringrequired

Possible values: [pending, ready, fail]

video_url urirequired

thumbnail_image_urls uri[]required

4k

object

id uuidrequired

status stringrequired

Possible values: [pending, ready, fail]

video_url urirequired

thumbnail_image_urls uri[]required

8k

object

id uuidrequired

status stringrequired

Possible values: [pending, ready, fail]

video_url urirequired

thumbnail_image_urls uri[]required

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "pending",
  "isPublic": true,
  "variants": {
    "144p": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "video_url": "string",
      "thumbnail_image_urls": [
        "string"
      ]
    },
    "240p": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "video_url": "string",
      "thumbnail_image_urls": [
        "string"
      ]
    },
    "360p": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "video_url": "string",
      "thumbnail_image_urls": [
        "string"
      ]
    },
    "480p": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "video_url": "string",
      "thumbnail_image_urls": [
        "string"
      ]
    },
    "720p": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "video_url": "string",
      "thumbnail_image_urls": [
        "string"
      ]
    },
    "1080p": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "video_url": "string",
      "thumbnail_image_urls": [
        "string"
      ]
    },
    "1440p": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "video_url": "string",
      "thumbnail_image_urls": [
        "string"
      ]
    },
    "4k": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "video_url": "string",
      "thumbnail_image_urls": [
        "string"
      ]
    },
    "8k": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "video_url": "string",
      "thumbnail_image_urls": [
        "string"
      ]
    }
  }
}

Loading...