Public Beta API Changes

Originally published on the Clarify.io blog. View archived copy.

First, thank you to all of our participants in our Private Beta. We’ve received a ton of feedback on everything from the documentation to the helper libraries to individual parameter names. In addition, we’ve learned a great deal about the use cases that people want to accomplish.

We’ve learned so much so far that we are making some changes to the API to make certain use cases easier, parameters more logical, and to leave room for a number of things on our roadmap. Without further ado, here are a number of changes that go live as of 26 August 2014:

Breaking changes:

• Renamed the “language” property in Tracks to “audio_language”
• Renamed the “size” property in Tracks to “media_size”
• Renamed the “code” property in Tracks to “fetch_response_code”
• Renamed the “message” property in Tracks to “fetch_response_message”
• Made tracks immutable (Removed PUT /v1/bundle/<bundle_id>/tracks)
• Implemented the 409 Conflict response code if you attempt to add tracks beyond the current maximum

New features:

• Added Tracks properties “media_code” and “media_message”
• Added items link relation in Tracks responses to get each individual track
• Implemented the GET and DELETE for individual tracks
• Implemented notifications using the bundle’s “notify_url” property. Notifications include “bundle_name”, “external_id”, “processing_cost” as well as track status data
• Bundles can contain an optional “external_id” which can be used to store your own IDs

The helper libraries are already being updated so those should be available shortly. Also, in the coming weeks, we’ll add blog posts showing some common use cases and explanations for each of these things.

If you have any questions, don’t hesitate to drop us a note via email at support@clarify.io or tweet us via @ClarifyAPI