API Documentation

Twaud.io has a very simple REST based API that is very similar to the Twitter and Twitpic APIs.

Response Formats

Twaud.io can return responses as JSON, JSON-P and XML. To specify a format just append a .xml or .json extension to the URL. To turn a JSON response into a JSON-P response just add a 'callback' parameter specifying the name of the JavaScript function you want to call.

https://twaud.io/api/v1/34r3.xml # returns XML
https://twaud.io/api/v1/34r3.json # returns json
https://twaud.io/api/v1/34r3.json&callback=funcName # returns JSON-P

Methods

There are a handful of methods available at this time:

Sound clip (GET /api/v1/:sound_id.:format)

Returns information for a single sound clip.

User's clips (GET /api/v1/:user.:format)

Returns a list of the 20 most recent clips submitted by a user.

Upload a clip (POST /api/v1/upload.:format)

Uploads a new clip to twaud.io. The request must be multipart/form-data with these parameters:

• username Your twitter username (required)
• password Your twitter password (required)
• sound[message] The message associated with the clip (required)
• sound[file] The audio file data (required, MP3, M4A, AIFF or WAV < 10MB)
• sound[location] A text represention of the location where clip was recorded (eg, London, UK) we can use this to geocode if you don't provide lat/lng
• sound[lat] Latitude of where the clip was recorded
• sound[lng] Longitude of where the clip was recorded
• tweet_this Set to 'true' if you want us to tweet the clip on your behalf

If successful the clip info for the new clip is returned.

OEmbed Support

twaudio now supports OEmbed as JSON, JSON-P and XML. Our OEmbed endpoint is http://twaud.io/oembed.:format.

Example request: http://twaud.io/oembed.json?url=http://twaud.io/7&callback=test

SSL Support

Although it's not required at this time we highly recommend that you make API upload requests via HTTPS (https://twaud.io/api/v1/upload) to avoid sending login information in the clear.