API docs example

Get Upload Url

Request pre-signed URL for uploading video to S3 Bucket.

GET/v1/videos/upload_url

Query parameters

Response

200422

Successful Response

Body

application/json

uuid*Uuid

Unique video reference key

url*Url

Upload URL

form_data_fields*Form Data Fields

Form data fields for multipart upload

Request

JavaScriptCurlPython

const response = await fetch('/v1/videos/upload_url?signature=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "uuid": "text",
  "url": "text"
}

Video Exists

Check if a video is present on our upload storage and ready for processing

GET/v1/videos/exists/{uuid}

Path parameters

uuid*Uuid

Unique reference key

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/v1/videos/exists/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Process

Start processing an uploaded video using its unique reference key.

POST/v1/videos/process/{uuid}

Path parameters

uuid*Uuid

Unique reference key

Query parameters

Response

202422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/v1/videos/process/{uuid}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Check

Perform quality check on given image.

POST/v1/videos/check

Body

multipart/form-data

image*Image

JPG or PNG image file

Response

200422

Successful Response

Body

application/json

quality_score*Quality Score

Quality score

quality_error_code*Quality Error Code

Quality error code

prompt*Prompt

Example prompt

signatureSignature

quality_error_typeQuality Error Type

Request

JavaScriptCurlPython

const response = await fetch('/v1/videos/check', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "image": "binary"
    }),
});
const data = await response.json();

Response

200422

{
  "prompt": "text",
  "signature": "text",
  "quality_error_type": "text"
}