NEWDolby Media Processing APIs are now the Dolby.io Media APIs Learn More >
X

Versioning

How Dolby.io Media APIs manage versions

During the lifecycle of a Media API we will release incremental improvements, bug fixes and feature updates.

The version number may not change unless:

  • backward compatibility could not be preserved in order to support a new feature or bugfix
  • significant changes to sound quality or results were achieved

You will not need to specify which version of an API you wish to use and will use the latest by default. You should check the Release Notes to learn about recent changes.

api_version

The api_version is returned in the response whenever calling a Media API.

{
    "api_version": "v1.0",
    "path": "/media/enhance",
    "progress": 100,
    "result": { },
    "status": "Success"
}

If you observe a change in behavior, please review the Release Notes and note the date of recent releases. If an underlying algorithm changed it may not be reflected in the version number alone.

x-api-version

To request a specific version of the API you can pass an x-api-version header in your request.

For example:

curl -X POST https://api.dolby.com/media/analyze \
     --header "x-api-key: $DOLBYIO_API_KEY" \
     --header "x-api-version: v1.0" \
     --data '{
         "input": "dlb://in/example.mp3",
         "output": "dlb://out/example-metadata.json"
     }'

Did this page help you?