Logo
3Play V3 API API Documentation

Audio Description

Number of APIs: 17


1. Download Audio Description Media Audio

GET {{host}}/v3/audio_descriptions/{{audio_description_id}}/audio/?api_key={{api_key}}&format=mp3



2. Download Audio Description Text

GET {{host}}/v3/audio_descriptions/{{audio_description_id}}/text/?api_key={{api_key}}&output_format_id=118



3. List Audio Description Text Formats

GET {{host}}/v3/audio_descriptions/text_formats/?api_key={{api_key}}



4. List Audio Description Mix Formats

GET {{host}}/v3/audio_descriptions/mix_formats/?api_key={{api_key}}



5. List Audio Description Meeting Formats

GET {{host}}/v3/audio_descriptions/audio_formats/?api_key={{api_key}}



6. Get Audio Description by ID

GET {{host}}/v3/audio_descriptions/{{live_auto_caption_id}}/?api_key={{api_key}}



7. List Audio Descriptions

GET {{host}}/v3/audio_descriptions/?api_key={{api_key}}



8. GET audio_descriptions

GET {{host}}/v3/audio_descriptions?api_key={{api_key}}&media_file_id=7078774&status=complete&media_file_batch_id=2160&sort_by=media_file_id&per_page=10&page=1



9. Create Audio Descriptions

POST {{host}}/v3/audio_descriptions/order/?api_key={{api_key}}&media_file_id=9206163



10. Send Immediate Callback

POST {{host}}/v3/audio_descriptions/{{audio_description_id}}/callback/?api_key={{api_key}}



11. Redeliever Audio Description

POST {{host}}/v3/audio_descriptions/{{audio_description_id}}/redeliver/?api_key={{api_key}}



12. Cancel Audio Description

POST {{host}}/v3/audio_descriptions/{{audio_description_id}}/cancel/?api_key={{api_key}}



13. Download Audio Description Media

GET {{host}}/v3/audio_descriptions/{{audio_description_id}}/mix/?api_key={{api_key}}&format=mp4



14. Post Audio Description Delivery Route

POST {{host}}/v3/audio_descriptions/deliveries/?api_key={{api_key}}



15. List Audio Description Delivery Routes

GET {{host}}/v3/audio_descriptions/deliveries/?api_key={{api_key}}&id=2663&name=Test Delievery Route123&created_before=2023-02-25T05:29:35.000-05:00&created_after=2023-02-25T05:29:35.000-05:00&method=callback&enabled=true



16. Edit Audio Description Delivery Route

PUT {{host}}/v3/audio_descriptions/deliveries/{{audio_description_delivery_route_id}}/?api_key={{api_key}}



17. Delete Audio Description Delivery Route

DELETE {{host}}/v3/audio_descriptions/deliveries/{{audio_description_delivery_route_id}}/?api_key={{api_key}}



ENDPOINTS