Create Request

This section allows you to create a request and estimate costs

Create Video Request

post

Create a new video enhancement request.

Send information about the video and desired enhancements then receive cost and time estimates.

Calling this endpoint does NOT consume credits.

Calling this endpoint does NOT start processing.

Estimations are based on values provided, and the calculation is rerun once the system receives the source video. If the second estimate is significantly different than the initial values, the request is failed and the credits are fully refunded.

The lower bound value of the cost estimate is billed.

Time estimates are in development and may not be accurate.

Response body

Property	Type	Description
requestId	UUID	Unique request identifier
estimates	Object	Refer to RequestEstimates below

RequestEstimates

cost and time are arrays with two integers each, representing lower and upper bounds of the estimate.

Property	Type	Description
cost	Array	Cost range (in credits)
time	Array	Time range (in seconds)

Authorizations

apiKey

X-API-KeystringRequired

Body

application/json

Responses

200

Successful response

application/json

requestIdstring · uuidOptionalExample: c1f96dc2-c448-00e6-82ed-14ecb6403c62

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

503

Service unavailable

application/json

post

/video/

HTTPcURLJavaScriptPython

POST /video/ HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1601

{
  "source": {
    "container": "mp4",
    "size": 123456000,
    "duration": 600,
    "frameCount": 18000,
    "frameRate": 30,
    "resolution": {
      "width": 1920,
      "height": 1080
    },
    "external": {
      "provider": "s3",
      "presignedUrl": "https://videocloud.s3.amazonaws.com/0193893a-a2ba-799e-b258-928f02c0f419/output.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256...x-id=PutObject",
      "awsCredentials": {
        "roleArn": "arn:aws:iam::123456789:role/topazlabs",
        "externalId": "MSTnuGztXtTU25XKjVfMJCsujv6VtAGtv1TGSjtOL6M="
      },
      "bucketName": "galaxies",
      "key": "milky_way/%06d.tiff"
    }
  },
  "filters": [
    {
      "model": "prob-4",
      "videoType": "Progressive",
      "auto": "Auto",
      "fieldOrder": "Auto",
      "focusFixLevel": "Normal",
      "compression": 0.1,
      "details": 0.2,
      "prenoise": 0.01,
      "noise": 0.3,
      "halo": 0.4,
      "preblur": 0.5,
      "blur": 0.6,
      "grain": 0.02,
      "grainSize": 1,
      "recoverOriginalDetailValue": 0.7
    },
    {
      "model": "apo-8",
      "slowmo": 2,
      "fps": 60,
      "duplicate": true,
      "duplicateThreshold": 0.01
    }
  ],
  "output": {
    "resolution": {
      "width": 7680,
      "height": 4320
    },
    "frameRate": 30,
    "audioBitrate": "320",
    "audioCodec": "AAC",
    "audioTransfer": "Copy",
    "codecId": "h265-main-win-nvidia",
    "videoEncoder": "H265",
    "videoBitrate": "1k",
    "dynamicCompressionLevel": "Mid",
    "videoProfile": "Main",
    "cropToFit": true,
    "container": "mp4"
  },
  "destination": {
    "external": {
      "provider": "s3",
      "presignedUrl": "https://videocloud.s3.amazonaws.com/0193893a-a2ba-799e-b258-928f02c0f419/output.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256...x-id=PutObject",
      "awsCredentials": {
        "roleArn": "arn:aws:iam::123456789:role/topazlabs",
        "externalId": "MSTnuGztXtTU25XKjVfMJCsujv6VtAGtv1TGSjtOL6M="
      },
      "bucketName": "galaxies",
      "key": "milky_way/%06d.tiff"
    }
  },
  "notifications": {
    "webhookUrl": "https://www.myvideos.com/webhooks/topazlabs"
  }
}

{
  "requestId": "c1f96dc2-c448-00e6-82ed-14ecb6403c62",
  "estimates": {
    "cost": [
      10,
      12
    ],
    "time": [
      600,
      700
    ]
  }
}