3Play Media: Docs


APIv3 Errors

This is a list of possible error responses from ApiV3.

API Operational Errors

  • Bad authentication
    {"code":401,"error":{"type":"authentication_error","message":"Invalid API key."}}
  • Missing required parameter
    {"code":400,"error":{"type":"parameter_error","message":"Missing required parameter: 'api_key'","items":["api_key"]}}
  • Unrecognized parameter for requested action
    {"code":400,"error":{"type":"parameter_error","message":"Unrecognized parameters supplied: 'bad_param'","items":["bad_param"]}}
  • Requested resource not found for your project
    {"code":404,"error":{"type":"not_found_error","message":"Not found"}}
  • Protocol error
    {"code":403,"error":{"type":"forbidden_error","message":"The requested route requires https"}}
  • Sort error
    {"code":500,"error":{"type":"argument_error","message":"Can't validate sort params without any valid keys!"}}
  • Disabled API key
    {"code":403,"error":{"type":"forbidden_error","message":"This API key has been disabled."}}
  • Expired signature
    {"code":401,"error":{"type":"authentication_error","message":"Signature has expired."}}
  • Invalid signature
    {"code":401,"error":{"type":"authentication_error","message":"Invalid signature."}}
  • Unknown error
    {"code":500,"error":{"type":"standard_error","message":"Internal server error"}}

Media File Errors

  • Source already exists
    {"code":400,"error":{"type":"parameter_error","message":"You cannot add a source to a file that already has a source_url. Please provide one or the other."}}
  • Invalid language change
    {"code":403,"error":{"type":"forbidden_error","message":"You cannot change the language of this file at this time."}}
  • ViCC Parent not found for ViCC order
    {"code":404,"error":{"type":"not_found_error","message":"Vicc parent file [FILE_ID] not found."}}
  • Batch ID not found
    {"code":404,"error":{"type":"not_found_error","message":"Batch id [BATCH_ID] not found."}}
  • No batches for project
    {"code":404,"error":{"type":"not_found_error","message":"You do not have any batches in this project, someone must have deleted them. Please create a batch first."}}
  • Batch operational error
    {"code":422,"error":{"type":"unprocessable","message":"Something went wrong setting this file's batch!"}}
  • Source operational error
    {"code":422,"error":{"type":"unprocessable","message":"Something went wrong setting this file's source!"}}

Transcript Errors

  • Transcript not found
    {"code":404,"error":{"type":"not_found_error","message": "Transcript not found. Are you sure the id you passed in belongs to a transcribed transcript?"}}
  • Invalid cancellation
    {"code":403,"error":{"type":"forbidden_error","message": "You cannot cancel this transcript at this time."}}
  • Sandbox only
    {"code":403,"error":{"type":"forbidden_error","message": "You can only perform this action in sandbox projects."}}
  • Invalid transcription language
    {"code":400,"error":{"type":"parameter_error","message": "You cannot order transcription for this file because it is in a language we do not support."}}
  • No source text for alignment order
    {"code":400,"error":{"type":"parameter_error","message": "Missing require parameter source_text (text) or source_text_file (upload)"}}
  • Invalid caption import type
    {"code":422,"error":{"type":"unprocessable","message": "Uploaded file type [FILE_TYPE] is not one of the supported types"}}
  • Caption import conversion error
    {"code":422,"error":{"type":"unprocessable","message": "Conversion failed: [DETAILS]"}}
  • Caption import processing error
    {"code":422,"error":{"type":"unprocessable","message": "Could not convert uploaded file"}}
  • Unpublished transcript
    {"code":422,"error":{"type":"unprocessable","message": "This transcript is not ready to be delivered."}}
  • Output Format ID not found
    {"code":404,"error":{"type":"not_found_error","message": "Output Format [ID] not found."}}
  • Translation source transcript unavailable
    {"code":404,"error":{"type":"not_found_error","message": "Transcript [ID] unavailable for media file [FILE_ID]."}}
  • Unavailable transcript Language
    {"code":404,"error":{"type":"not_found_error","message": "No foreign language transcription option is available for this file"}}
  • Invalid import text format
    {"code":422,"error":{"type":"unprocessable","message": "File contains invalid UTF-8 characters."}}
  • Invalid turnaround level update
    {"code":403,"error":{"type":"forbidden_error","message": "Your file's turnaround level is already [TURNAROUND_LEVEL]"}}
  • Turnaround level not upgradable
    {"code":403,"error":{"type":"forbidden_error","message": "2 hour turnaround is the fastest turnaround level 3Play Media currently offers."}}
  • Turnaround level slower
    {"code":403,"error":{"type":"forbidden_error","message": "The requested turnaround level is slower than the current turnaround level."}}
  • Turnaround level upgrade not available
    {"code":403,"error":{"type":"forbidden_error","message": "You can not upgrade the turnaround level for this transcript in its current state"}}
  • Transcript already in progress for transcription order
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order transcription because this file already has a transcript in progress"}}
  • No source media for transcript order
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order transcription for this file because it is not associated with any source media"}}
  • Invalid transcription language
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order transcription for this file because it is in a language we do not support."}}
  • Transcript already in progress for ASR order
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order ASR because this file already has a transcript in progress"}}
  • ASR already ordered
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order ASR for this file because it has already been ordered."}}
  • No source media for ASR order
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order ASR for this file because it is not associated with any source media"}}
  • Unsupported ASR language
    {"code":400,"error":{"type":"invalid_order_error","message": "Unsupported language for ASR"}}
  • Transcript already in progress for alignment order
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order alignment because this file already has a transcript in progress"}}
  • Alignment already ordered
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order alignment for this file because it has already been ordered."}}
  • No source media for alignment order
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order alignment for this file because it is not associated with any source media"}}
  • Unsupported alignment language
    {"code":400,"error":{"type":"invalid_order_error","message": "Unsupported language for alignment"}}
  • Transcript already in progress for ViCC order
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order Video Clip Captinioning because this file already has a transcript in progress"}}
  • ViCC already ordered
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order Video Clip Captioning for this file because it has already been ordered."}}
  • Noo parent media file for ViCC order
    {"code":400,"error":{"type":"invalid_order_error","message": "Media file [FILE_ID] must be assigned parent media file before ordering"}}
  • No source media for ViCC order
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order Video Clip Captioning for this file because it is not associated with any source media"}}
  • No translation profile for Translation order
    {"code":400,"error":{"type":"invalid_order_error","message": "You do not have a translation profile set up. Please create one using the translation profiles route."}}
  • No source media for Translation order
    {"code":400,"error":{"type":"invalid_order_error","message": "You cannot order a translation using Dotsub for this file because it is not associated with any source media"}}
  • Translation already ordered with same service option
    {"code":400,"error":{"type":"invalid_order_error","message": "This translation service option has already been ordered for this media file"}}
  • Transcript language already exists for caption import order
    {"code":400,"error":{"type":"parameter_error","message": "You cannot import caption with language id [ID] because the specified media file already has a transcript with that language id."}}
  • Invalid file type for caption import
    {"code":400,"error":{"type":"parameter_error","message": "[FILE_TYPE] is not a supported file type for this project"}}
  • Unavailable output format
    {"code":400,"error":{"type":"parameter_error","message": "Output format id [ID] is not available for this transcript."}}
  • Invalid transcript retry
    {"code":403,"error":{"type":"forbidden_error","message": "This transcript cannot be retried because it is not currently rejected."}}
  • Retry aleady requested
    {"code":403,"error":{"type":"forbidden_error","message": "This transcript cannot be retried because has already been retried."}}

Audio Description Errors

  • Order validation failures
    {"code":403,"error":{"type":"forbidden_error","message":"Audio Description module must be activated"}}
    {"code":403,"error":{"type":"forbidden_error","message":"Existing audio description in progress"}}
    {"code":403,"error":{"type":"forbidden_error","message":"Missing transcript"}}
    {"code":403,"error":{"type":"forbidden_error","message":"Unavailable source video"}}
    {"code":403,"error":{"type":"forbidden_error","message":"Original service must be Transcription, ASR, Caption Import, or Alignment"}}
    {"code":403,"error":{"type":"forbidden_error","message":"Rejected or cancelled upstream service"}}
    {"code":403,"error":{"type":"forbidden_error","message":"File must be in English"}}
  • Audio description not ready
    {"code":422,"error":{"type":"unprocessable","message":"This audio description is not ready to be delivered."}}
  • Invalid cancellation request
    {"code":403,"error":{"type":"forbidden_error","message":"You cannot cancel this audio description at this time."}}
  • Media file not found
    {"code":404,"error":{"type":"not_found_error","message":"Media File [ID] not found."}}
  • Output format not found
    {"code":404,"error":{"type":"not_found_error","message":"Output Format [ID] not found."}}
  • Invalid output text format
    {"code":400,"error":{"type":"parameter_error","message":"Invalid text format id for audio description data."}}
  • Unavailable for unprocessed video
    {"code":403,"error":{"type":"forbidden_error","message":"Audio Description is unavailable until video track is processed."}}
  • Expedited service unavailable
    {"code":403,"error":{"type":"forbidden_error","message":"You cannot order Audio Description turnaround levels faster than standard without first contacting your account manager to turn this feature on."}}
  • Transcript missing
    {"code":403,"error":{"type":"forbidden_error","message":"Unfortunately, we cannot yet process audio description for a file that does not have a 3Play Media transcript."}}
  • Auto extend unavailable
    {"code":403,"error":{"type":"forbidden_error","message":"You cannot order audio description with extended=auto for this media file because it aleady has [TYPE] audio description. Please use extended=[BOOLEAN]."}}
  • Audio description service type already exists
    {"code":403,"error":{"type":"forbidden_error","message":"The specified media file already has [TYPE] audio description."}}
  • Invalid media format
    {"code":400,"error":{"type":"parameter_error","message":"Invalid format"}}

Live Auto Captioning Errors

  • Event not archivable
    {"code":403,"error":{"type":"forbidden_error","message":"Your event cannot be archived as it is not finished or cancelled."}}
  • Event not unarchivable
    {"code":403,"error":{"type":"forbidden_error","message":"Your event is not currently archived."}}
  • Invalid cancellation request
    {"code":403,"error":{"type":"forbidden_error","message":"Your event cannot be cancelled at this time."}}
  • Invalid finish request
    {"code":403,"error":{"type":"forbidden_error","message":"Your event cannot be finished at this time as it is not currently running."}}
  • Invalid update request
    {"code":403,"error":{"type":"forbidden_error","message":"Your event cannot be updated at this time."}}
  • Too short wait time
    {"code":400,"error":{"type":"invalid_order_error","message":"Event Wait Time must be at least 1 minute."}}
  • Invalid media file ID
    {"code":404,"error":{"type":"not_found_error","message":"Media File [ID] not found."}}
  • Invalid language
    {"code":400,"error":{"type":"invalid_order_error","message":"Live ASR is only supported for English media files"}}
  • Live auto captioning already ordered
    {"code":400,"error":{"type":"invalid_order_error","message":"The specified media file already has a Live ASR order"}}
  • Transcript already exists
    {"code":400,"error":{"type":"invalid_order_error","message":"The specified media file already has a transcript"}}
  • Scheduled time too close
    {"code":400,"error":{"type":"invalid_order_error","message":"The scheduled time must be at least 1 minute in the future."}}
  • Live auto captionining module not activated
    {"code":403,"error":{"type":"forbidden_error","message":"You need to activate the Live ASR module to gain access to this feature. Please see the modules in the 3Play Media account system or talk to your account manager."}}

Admin Errors

  • Insufficient access
    {"code":403,"error":{"type":"forbidden_error","message":"The requested action requires an admin access API key."}}
  • Too many accesses
    {"code":403,"error":{"type":"forbidden_error","message":"For security reasons, you cannot create more than 20 API accesses per day"}}
  • Invalid invoice ID
    {"code":404,"error":{"type":"not_found_error","message":"Invoice [ID] not found for [ACCOUNT_OR_PROJECT]"}}
  • Project ID parameter missing
    {"code":400,"error":{"type":"parameter_error","message":"Missing required parameter: 'project_id'"}}
  • Invalid project ID
    {"code":404,"error":{"type":"not_found_error","message":"Project id [ID] not found"}}
  • No project ID for project level access
    {"code":400,"error":{"type":"parameter_error","message":"You must supply a project_id for project level access"}}
  • Invalid email
    {"code":400,"error":{"type":"parameter_error","message":"Email address given does not match the supplied user id"}}
  • User already has access
    {"code":403,"error":{"type":"forbidden_error","message":"The user with the email address [EMAIL] is already a [ACCESS] user"
  • Email address already in use
    {"code":403,"error":{"type":"forbidden_error","message":"The user with email address [EMAIL] has already been taken."}}
  • Sandbox projects forbidden
    {"code":403,"error":{"type":"forbidden_error","message":"You can only create sandbox projects because your account is configured for project level billing"}}
  • Project creation failure
    {"code":422,"error":{"type":"unprocessable","message":"Could not create project: [DETAILS]"}}

Project Access Errors

  • No read permission
    {"code":403,"error":{"type":"forbidden_error","message":"The requested action requres a project or observer access API key."}}
  • No write permission
    {"code":403,"error":{"type":"forbidden_error","message":"Your API key does not have permission to perform this action; this request has been logged."}}
  • Invalid callback
    {"code":400,"error":{"type":"parameter_error","message":[DETAILS]}}

Source Errors

  • Source already exists
    {"code":403,"error":{"type":"forbidden_error","message":"You cannot upload a source to this file because one already exists."}}
  • Source URL already exists
    {"code":403,"error":{"type":"forbidden_error","message":"You cannot upload a source to this file because it already has a source url"}}
  • Source in use
    {"code":403,"error":{"type":"forbidden_error","message":"You cannot delete this source because it is in use."}}
  • Invalid source file
    {"code":400,"error":{"type":"parameter_error","message":"Source file is not a valid file."}}

Translation Profile Errors

  • Missing setting for Gengo
    {"code":400,"error":{"type":"parameter_error","message":"You must set auto_approve_translation to true or false for a Gengo translation profile"}}
  • Translation profile already exists
    {"code":403,"error":{"type":"forbidden_error","message":"This project already has a translation profile. Please use the edit route to make changes"}}
  • Invalid vendor
    {"code":404,"error":{"type":"not_found_error","message":"Not a valid translation vendor. Please ping v3/translation_profile/profile_options for a list of options"}}
  • Missing translation profile
    {"code":404,"error":{"type":"not_found_error","message":"This project does not have a translation profile. Please create one using the create route."}}

Glossary Errors

  • Glossary already exists
    {"code":422,"error":{"type":"unprocessable","message":"This resource already has a glossary. Please update the existing one."}}
  • Invalid create - service already in progress
    {"code":422,"error":{"type":"unprocessable","message":"A glossary cannot be added at this time because this file is already being processed."}}
  • Invalid update - service already in progress
    {"code":422,"error":{"type":"unprocessable","message":"A glossary cannot be updated at this time because this file is already being processed."}}
  • Resource not found
    {"code":422,"error":{"type":"unprocessable","message":"The resource type and resource id you've provided could not be found. Resource Type: [TYPE], Resource ID: [ID]"}}

Cheat Sheet Errors

  • Cheat sheet already Exists
    {"code":422,"error":{"type":"unprocessable","message":"This resource already has a cheat sheet for this service. Please update the existing one."}}
  • Invalid create - service already in progress
    {"code":403,"error":{"type":"forbidden_error","message":"Cheat sheets cannot be added at this time because this file is already being processed."}}
  • Missing content
    {"code":422,"error":{"type":"unprocessable","message":"You must provide either content or pdf attachment."}}
  • PDF failure
    {"code":422,"error":{"type":"unprocessable","message":"We were unable to read the pdf attachment you provided. Please try again."}}
  • Invalid update - service already in progress
    {"code":403,"error":{"type":"forbidden_error","message":"Cheat sheets cannot be updated at this time because this file is already being processed."}}
  • Invalid resource
    {"code":422,"error":{"type":"unprocessable","message":"The resource type and resource id you've provided could not be found. Resource Type: [TYPE], Resource ID: [ID]"}}

Delivery Route Errors

  • Invalid recipient ID
    {"code":404,"error":{"type":"not_found_error","message": "No user with id [ID] was found."}}
  • Unavailable output format ID
    {"code":404,"error":{"type":"not_found_error","message": "No available output format with id [ID]."}}
  • Invalid user IDs
    {"code":404,"error":{"type":"not_found_error","message":"Unrecognized user ids for project: [DETAILS]"}}
  • Missing user IDs
    {"code":400,"error":{"type":"parameter_error","message":"Must provide user ids for email notifications"}}