Auphonic API by Example

Welcome to the Auphonic API documentation!

Please see http://auphonic.com/developers for further examples and information.

Contents:

General Notes

The Auphonic REST API can be used by any tool or programming language which is able to perform HTTP requests. However, all examples in this documentation utilize the command line tool curl for demonstration purpose.

Resources (presets, productions, services, etc.) are always referenced using an UUID, which is a unique string of 22 characters out of [a-zA-Z0-9].

A simple version of the API is available and discussed at Auphonic Simple API. It can save and start productions in a single request by referencing an existing preset, without storing an internal state. This makes it ideal for quick shell scripts and batch processing of multiple files. If you want to have full control, like detailed file formats or outgoing services without the use of predefined presets, please use the JSON-based API. The JSON API requires multiple requests and parsing the JSON response. See JSON API: Start Productions using Presets and the following pages.

Authentication is possible with HTTP Basic Authentication and OAuth 2.0 Authentication. All documentation examples use HTTP Basic Authentication, where username and password is the Auphonic username and password.

Warning

All third party applications with multiple users should always use OAuth 2.0 Authentication!

Some common API examples can be found at our Common Examples page and auphonic-api-examples github repository.

All API changes will be announced over the Auphonic-API mailing list (low traffic), so that developers can adjust their code and are informed about important updates.

If you have any further questions or need a special feature, don’t hesitate to contact us at feedback _at_ auphonic.com!

Table Of Contents

Next topic

Auphonic Simple API

This Page