API documentation
Coconut's API is a config-based API built with simplicity and flexibility in mind.
Encode your first video in less than 5 minutes.
API Reference
Docs
API errors
Code | Message |
config_not_valid | The config file must specify the `source' video location, a `webhook' URL and at least 1 output |
outputs_out_of_range | You can't submit more than 30 Outputs |
params_out_of_range | You can't set more than 15 params in a request |
output_must_have_one_parameter | An output must contains at least one parameter |
authentication_failed | Authentication failed, check your API key |
account_suspended | Account temporarily suspended, contact us for more info |
Common errors
Code | Message |
unknown_error | Unknown error |
output_url_not_valid | Output URL is not valid. Supported schemes are s3 ftp sftp http https cf az |
Errors by section
Source errors
Code | Message |
source_http_404_error | HTTP status code: 404 |
source_bad_address_error | Bad address |
source_http_401_error | HTTP status code: 401 |
source_http_403_error | HTTP status code: 403 |
source_http_500_error | HTTP status code: 500 |
source_url_not_valid | URL is not valid |
source_is_not_a_valid_file | Video is not a valid video file |
source_video_too_long__free_plan_limitation | Source video is too long (> 5min). Please upgrade your plan |
Video encoding errors
Code | Message |
transcoding_unsupported_audio_codec | Unsupported audio codec |
transcoding_unsupported_video_codec | Unsupported video codec |
transcoding_cant_be_encoded | This video cannot be encoded in this format |
transcoding_wrong_audio_settings | Wrong settings for audio |
transcoding_wrong_video_settings | Wrong settings for video |
transcoding_cant_retrieve_info | Cannot retrieve info from this video |
transcoding_not_a_video_file | Not a video file |
transcoding_video_too_long | Video too long |
transcoding_container_not_supported | The container of this video is not supported yet |
transcoding_audio_cant_be_resampled | The audio can't be resampled |
transcoding_format_doesnt_exist | Format doesn't exist |
HTTPStream errors
Code | Message |
httpstream_unknown_error | Unknown error |
httpstream_packaging_error | Error while packaging |
httpstream_upload_error | Couldn't upload the the media files |
Thumbnail errors
Code | Message |
thumbnail_not_uploaded | Thumbnails not uploaded successfully |
thumbnail_creation_failed | Thumbnail generation failed |
thumbnail_filename_has_no_num_var | Filename parameter needs to have the special var #num# |
thumbnail_image_format_must_be_png_or_jpg | Image Format must be png or jpg |
Animated GIF errors
Code | Message |
gif_not_uploaded | GIF animation not uploaded successfully |
gif_creation_failed | GIF generation failed |
gif_width_out_of_range | Width must be > 0px and < 500px |
Storyboard errors
Code | Message |
storyboard_not_uploaded | Storyboard not uploaded successfully |
storyboard_creation_failed | Storyboard generation failed |
storyboard_width_out_of_range | Width must be between 100px and 1280px |
Format ID errors
Code | Message |
format_width_not_in_range | Width value is not between 0 and 1920 |
format_height_not_in_range | Height value is not between 0 and 1080 |
format_video_bitrate_not_in_range | Video bitrate value is not between 30 and 10000 |
format_audio_bitrate_not_in_range | Audio bitrate value is not between 8 and 512 |
format_wrong_container | Wrong video container |
format_wrong_video_codec | Wrong video codec |
format_wrong_fps | Wrong FPS value |
format_wrong_audio_codec | Wrong audio codec |
format_wrong_sample_rate | Wrong sample rate value |