Base URL

The base URL of all API requests is:

https://api.omnystudio.com

Authentication

Authentication against the OmnyStudio API is performed by means of the Authorization header. The authorization scheme should be of type OmnyToken. The value should be the token exactly as it appears on the API Keys page in Omny Studio.

For example if your OmnyStudio API Key Token was "SampleAPIKeyToken" all your requests would include the header:

Authorization: OmnyToken SampleAPIKeyToken

You may also supply the API Key Token as part of the request URL, using the apikey query parameter. For example: /test/ping?apikey=SampleAPIKeyToken

Generating clients

The API provides a Swagger compatible specification available at /api-spec/v0. Check this list of tools and editor to generate an API client library for your programming environment.

Data format

Name Format

date-time

A specific time on a specific date in UTC timezone

yyyy-MM-ddTHH:mm:ss.fffZ

e.g. 2016-07-06T07:44:34.888Z

uuid

A unique identifier

wwwwwwww-wwww-wwww-wwww-wwwwwwwwwwww

e.g. 21EC2020-3AEA-4069-A2DD-08002B30309D

Consumer API

If you need to use an API to integrate your published audio and metadata in an app or website, consider the consumer API instead which does not allow edits or require an API key.

Operations

Some API calls initiate an asynchronous operation to calculate a response. For these calls, the API returns an OperationResult that contains a UUID, the status of the operation, and the result of the operation. If the operation status is not complete, you must poll the operations endpoint to retrieve the status and result of the operation.

The valid status codes include:

  • Busy - Indicates the Operation is currently queued or being processed
  • Success - Indicates the Operation has completed Successfully and the result of the Operation is included in the result field
  • Failed - Indicates the Operation has failed. You can try re-performing the operation again.

The response for any API call that initiates an operation will contain a Location header containing a URL that can be polled to retrieve the status and result of the operation. You can also use the id property in the API response to poll the operation endpoint.

Try the API