Skip to content

API Status Codes

This document elaborates the Indee status/error codes to be included in the responses for all of Indee's APIs.

Overview

Every response status code will be of the following format - a letter followed by 4 digits. For example E2103

  • The letter will indicate the API to which the request is being made.

    • Indee Watch API endpoints : W.
    • Indee Admin API endpoints : A,

  • The numerical part of it will indicate the nature of the response.

Entity codes

Typical API response

An error API response will be of the following format

HTTP 400

{
    "status_code" : "A1123",
    "detail" : "During the creation of a video, a disk space overflow occurred"
}

API Response Status Codes

Status code classification approach

Status Code Pattern Meaning
0xxx Success
1xxx Entity management
10xx Project management
11xx Video management
12xx screener management
13xx Audience management
2xxx Authentication and Authorization related
20xx Authentication failure
21xx Authorization issue
3xxx Async access / processing related
4xxx Client input validation related
40xx Project input validation issue
41xx Video input validation issue
42xx Screener input validation issue
49xx Miscellaneous input validation issue
5xxx Server related

Last two digits

The last two digits have no special meaning and typically tend to be error codes for various scenarios.

Specific Error Code under various series

The specific does and their meaning are captured in the lists below. When a particular code is returned, its associated HTTP status code is also provided.

0xxx

Status Code HTTP Status Code Meaning
A0000 200 Success

1xxx

Status Code HTTP Status Code Meaning
1000 200 Project Created Successfully
1001 200 Project Updated Successfully
1002 200 Project Deleted Successfully
1100 200 Video Created Successfully
1101 200 Video Updated Successfully
1102 200 Video Deleted Successfully

2xxx

Status Code HTTP Status Code Meaning
2000 401 Authorization header is either missing or malformed
2001 401 Invalid API key
2002 401 Invalid credentials
2003 401 Invalid auth token
2004 401 This login was overriden, concurrent logins are not allowed
2005 401 User account disabled
2006 401 User email not verified
2100 403 API key not authorized to perform action
2101 403 User not authorized to perform action
2201 400 Missing required parameter
2013 400 Invalid user

3xxx

Status Code HTTP Status Code Meaning
3000 200 Request for adding project poster submitted
3001 200 Project poster validation and harmonization in progress
3002 200 Project poster added successfully
3003 400 Project poster processing failed
3004 200 Request for adding project banner submitted
3005 200 Project banner validation and harmonization in progress
3006 200 Project banner added successfully
3007 400 Project banner processing failed
3100 200 Request for video creation submitted
3101 200 Assets are being downloaded by Indee servers (ID requests)
3102 200 Video validation and harmonization in progress
3103 200 Video is Ready
3104 400 Video processing failed
3105 200 Video media not uploaded
3111 200 Subtitle file processing in progress
3112 200 Subtitle file uploaded successfully
3113 400 Subtitle file processing failed
3121 200 Audio file processing in progress
3122 200 Audio file uploaded successfully
3123 400 Audio file processing failed
3131 200 Request for adding video poster submitted
3132 200 Video poster validation and harmonization in progress
3133 200 Video poster added successfully
3134 400 Video poster processing failed
3200 200 Screener generation completed successfully
3201 200 Screener generation in progress

4xxx

Status Code HTTP Status Code Meaning
4900 400 Malformed request body
4001 400 Another project with the specified external_client_id exists within Indee
4002 400 The specified project key does not exist in Indee
4003 400 The role of for project cannot be assigned to
4004 400 The specified genre is unknown to Indee
4101 400 Another video with the speicfied external_client_id exists in Indee
4102 400 The specified video key does not exist in Indee
4104 400 Unable to access the video URL provided. See status_message for additional details
4105 400 The video is not in a format that can be processed by Indee. See status_message for additional details
4106 400 Values for one or more of season, episode, original_air_date, cast_and_crew are present for a project that is not of type series
4107 400 The role of for video cannot be assigned to
4109 400 Filename/Filesize provided does not match the uploaded file
4111 400 The specified subtitle file is Invalid
4112 400 The subtitle URL provided could not be accessed. See status_message for additional details.
4113 400 A maximum of 25 subtitles are allowed for a single video.
4114 400 Only one subtitle file is allowed as default.
4121 400 The specified audio file could not be processed by Indee. See status_message for additional details.
4122 400 Unable to access the audio track URL. See status_message for additional details
4123 400 A maximum of 7 audio tracks can be present for a single video
4124 400 Only one audio track is allowed as default.
4307 403 The specified product key does not exist in Indee
4323 400 Action not supported for the specified product key
4322 400 Invalid expiry date for publish
4325 400 Invalid start date for publish
4326 400 The specified publish key does not exist in Indee
4327 400 Action not supported for the specified video key

5xxx

Status Code HTTP Status Code Meaning
5000 500 Unknown server error
5001 429 Request throttled