Responses

Error

API Response Error Schema and Details. Status codes, and ResponseError object examples

Error Response Schema

All the unsuccessful request will return a response based on the ResponseError schema, it contains the error message and type.

status
string

Status indicates the response status "error" Examples: "error"

error
object

Error response details

Example :

{
  "status": "error",
  "error": {
    "type": "ValidationError",
    "code": 400,
    "message": "Invalid request parameters"
  }

Error Status Codes and Examples

Status Code Description Examples
400
Bad Request		 Validation Error Invalid request parameters, invalid video source URL...
401
Unauthorized		 Authentication error Invalid token provided or subcription not active
403
Forbidden		 Unauthorized to perform this action Insufficient funds, Max CPU usage reached, Inadequate credentials to perform an action...
404
Not Found		 The requested resource doesn't exist Invalid Job ID when trying to retrieve one
429
Too Many Requests		 Rate limit exceeded - too many requests in a given time period -
500
Internal Error		 Unexpected internal error -