New error messages described in this article will be operational October 22nd.


When the API finds a problem with a request, it produces an error. Find a list of errors Idomoo's platform produces in this article.


Error Message Structure

All error messages follow the same basic structure:

  • "status"- The status of the request, which can be one of the following:
    • Error - for other failed calls.
  • "errors"- An array of error objects.
    • error_code - A number for the error, for easy identification.
    • error_message - A title for the error.
    • error_description - A full description of the error.
  • "request_id" - An identification number specific to this API call.


Any code you write to catch errors should only refer to the Error Code. Idomoo reserves the right to change the Error Description at any time.


Here's an example:

{
    "status": "Error",
    "errors": [
        {
            "error_code": 2000,
            "error_message": "Data Validation",
            "error_description": "No scene has matched the storyboard business logic."
        }
    ],
    "request_id": "2953.1543493394.410.437.5142054",
}

As our API is asynchronous, error might happen even after a successful call. Read more about that in this article.

Schema Error Descriptions

Schema error descriptions are automatically generated and follow a strict set of rules. They only apply to video generation calls and refer to the body of the call. Simply put, they point the user to a specific location in the json body and give information as to what's wrong with it. Here's an example:

{
    "status": "GENERATION_FAILED",
    "errors": [
        {
            "error_code": 3300,
            "error_message": "Request Error",
            "error_description": "Schema error: $.output.video[0].video_type: is missing but it is required"
        }
    ],
    "request_id": "2958.1543488224.525.487.4159582"
}

API Errors Reference

1. Message Code2. Message Category3. Message
20GeneralBummer! We do try to get good error messages, but sometimes the unexpected happens. Please wait a few moments and try again. If the problem persists, contact Idomoo support.
1000Authorization ErrorWrong authorization credentials.
1100Authorization ErrorThis account does not have permission to use storyboard '<<storyboardId>>' or this storyboard doesn't exist.
1103Authorization ErrorThis account does not have permission to use storage '<<storageID>>'.
1106Authorization ErrorThis account does not have permission to use the landing page '<<landingPageID>>'.
1109Authorization ErrorThis account does not have permission to use scene '<<scene_id>>' or this scene doesn't exist.
1200Authorization ErrorThis account is inactive and can not perform the requested action.
1203Authorization ErrorThis account does not have enough credits to perform this request.
1206Authorization ErrorThe request arrived from an unauthorized IP address.
1209Authorization ErrorThis request was blocked because it exceeded your account concurrency limit.
1212Authorization ErrorThis request was blocked because it exceeded your account daily allowance.
1215Authorization ErrorThis account does not have permission to upload to, delete or rename scene library '<<scene_library_id>>'.
2000Data ValidationNo scene has matched the storyboard business logic.
2003Data ValidationThe value '<<value>>' for parameter '<<parameter_name>>' can't be validated using the condition '<<condition>>'.
2006Data ValidationThe value for parameter '<<parameter_name>>' has to be in the format defined in calendar properties.
2009Data ValidationKey '<<name>>' with value '<<value>>' raises the error: '<<condition>>' key '<<name2>>' with value '<<value2>>'
2012Data ValidationParameter '<<parameter_name>>' with value '<<value>>' raises the error: '<<condition>>' '<<static_value>>'.
2015Data ValidationThe parameter '<<parameter_name>>' used for validation is missing from the call.
2018Data ValidationThe font pointed by key '<<parameter>>' is inaccessible or corrupt.
2021Data ValidationThe character/s '<<text>>' in key '<<key>>' do not exist in font '<<font_name>>'.
2024Data ValidationThe character/s '<<text>>' in parameter '<<key>>' can't be rendered with any of the fonts provided.
2027Data ValidationInput value '<<value>>' is not in the expected format: '<<format>>'.
2100Data ValidationThe value of the key '<<key>>' is mapped to a non existing mapping value and fallback is not set.
3000Request ErrorMethod not allowed for the requested resource.
3003Request ErrorRequest 'Accept' header should be 'application/json'.
3006Request ErrorWrong endpoint. Check the value of the URL path to make sure it is correct.
3009Request ErrorUnsupported media type. Please check your request headers.
3012Request ErrorWrong type for query parameter '<<name>>'.
3015Request ErrorThe IDM file is corrupt or not an IDM.
3018Request ErrorForm data parameter 'file' is missing.
3200Request ErrorThe API request's JSON is malformed.
3300Request ErrorJSON schema error: <<schema_error>>
3400Request ErrorThe value for 'video_file_name' was formatted incorrectly. It can only be made of 0-9, A-Z and a-z characters, and be 2-128 characters long.
3403Request ErrorSame 'suffix' appears more than once for output type '<<parameter>>'.
3406Request ErrorThe value for 'statistic_id' was formatted incorrectly. It can only be made of 0-9, A-Z and a-z characters.
3408Request ErrorNo output has been sent in the API call.
3409Request ErrorThe configuration file '<<value>>' specified in 'output_config' does not exist.
3500Request ErrorThere is more than one output of the type: '<<output_type>>' in the call. Please add 'suffix' to differentiate between them.
3503Request ErrorThis API mode does not allow for this output type: '<<output_type>>'.
3506Request ErrorThough 'overlay_alignment' exists, the 'overlay' property is missing in one of the '<<output>>' output objects.
3509Request ErrorThe valid range for 'gif > start' is from 0 and up to video duration.
3512Request ErrorThe valid range for 'gif > duration' is above 0 and up to video duration, but subtracting the start time.
3515Request ErrorThe valid range for 'jpg > time' is from 0 and up to video duration.
3518Request Errorcrop_to_ratio of one of the '<<output>>' output objects produces an output resolution smaller than a pixel.
3521Request ErrorThe highest possible output resolution is 1920 X 1920. The resulting width is <<width>> pixels wide. Change the 'height' value.
3600Request ErrorThe 'scenes' array must hold at least one scene.
3603Request ErrorScene aspect ratio does not match in all requested scenes.
3606Request ErrorFrame per second property (fps) does not match in all requested scenes.
3612Request ErrorAll scenes in a video must be created in either Scene Tools or Space Tools. Not a combination of the two.
3615Request ErrorThe value specified in 'unique_scene_id' property in scene '<<sceneId>>' is not unique.
3618Request ErrorThe specified unique_scene_id '<<unique_scene_id>>' must be one of the requested scenes on this call's list of scenes.
3621Request ErrorThe properties 'start_time_in_seconds' and 'start_time_offset_unique_scene_id' or 'start_time_offset_seconds' are in conflict.
3624Request ErrorThe properties 'duration_upto_unique_scene_id' and 'duration_in_seconds' or 'duration_referrer' are in conflict.
3627Request ErrorScene '<<sceneId>>' starts after the end of the unique scene, so duration can't be set.
3630Request Errorstart_time_offset_in_seconds' property in scene '<<scene_id>>' must have a 'start_time_offset_unique_scene_id' definition.
3633Request ErrorScene '<<sceneId1>>' and scene '<<sceneId2>>' are pointing to each other to shorten their duration.
3636Request ErrorIn scene '<<sceneID>>' the following keys: '<<durationReferrerKeys>>' are defined as 'duration_referrer'. Only one can be used.
3639Request ErrorScene '<<sceneId1>>' and scene '<<sceneId2>>' can't share the same z_index and timing.
3642Request ErrorScene '<<sceneId>>' has a 'scene_start_in_seconds' that's higher than the duration of the scene.
3700Request ErrorThe resource pointed by key '<<parameter>>' is inaccessible or corrupt.
3703Request ErrorAudio '<<key>>' start time is after the end of the unique scene.
3706Request ErrorThe 'start_referrer' value: '<<start_referrer>>' specified for key '<<key>>' does not exist in another placeholder in the scene.
3709Request ErrorThe media used for '<<key_name>>' is larger than 2048 X 2048.
3712Request ErrorThe file format '<<format>>' used as an asset for key '<<parameter>>' is unsupported.
3715Request ErrorSupported values for alignment can only be: [[left, center, right], [top, middle, bottom]]. You used '<<value>>'.
3718Request ErrorWhen 'alignment_scale_type' is 'custom', 'alignment_scale' is mandatory.
3900Request ErrorThe storyboard extension raised an error. Please contact support.



 Next Idomoo API v2 
 Back API Reference