Omny Studio has a set of management APIs to allow developers to integrate third-party content management systems to manage the content in Omny Studio. The Management API supports create, read, update, and delete operations for most items in Omny, including networks, programs, and other objects.
Omny Studio also provides a separate read-only Consumer API suitable for mobile apps and websites. For details, see Consumer API.
Versions
There are two versions of the Management API which are called V0 and V1. V0 continues to be supported and will not be removed, but will no longer have any new feature development.
We recommend V1 for new development. It exposes a number of new endpoints including more detailed download analytics and reporting, audit events, as well as user management to name a few. It also exposes a number of properties for clips, playlists, programs and networks that were not previously available in the V0 API and were only accessiable via the UI.
Documentation
API V0 documentation: https://api.omnystudio.com/docs/management-api-v0
API V1 documentation: https://api.omnystudio.com/docs/management-api-v1
Manage API Keys
Requests to the Omny Studio Management API require an API key. You can create, see, edit, and revoke API keys in Organization Settings > API keys. Your Omny Studio account needs the Manage API Keys permission.
You can assign permissions to an API key at the organization, network, or program levels.
Assign only necessary access and permissions
To avoid security problems, avoid assigning permissions and access that the API key doesn’t need.
Treat API keys like passwords
You should never reveal or publish your API keys where unauthorized people may find them. Omny shows you the access key only when you create it, you can’t retrieve it after you’ve created it.
Create an API Key
Go to Organization Settings > API keys.
Select New API key.
In New API key, fill in Name and select Create API key.
In API key created, select Copy to clipboard, paste and save the API key in a secure place, then select Close and manage permissions.
In Are you sure?, select OK to continue.
Select the permissions and access to assign to the API key then select Save changes.
Edit an API Key
You can change an API key’s permissions and access. You cannot change its name and you cannot access the API key itself.
Go to Organization Settings > API keys.
Find the API key you want to edit.
Select Edit API key permissions.
In Edit API key permissions, change the permissions and access then select Save changes.
Revoke an API Key
You can delete an API key so that the Management API rejects requests that use it.
You cannot undo a revoked API key
Go to Organization Settings > API keys.
Find the API key you want to revoke.
Select Revoke.
To confirm your decision, select Revoke API key.
Export Details About API Keys
You can see details about your API keys by exporting a CSV (comma-separated values) file. This file does not contain API keys, only information about them.
Go to Organization Settings > API keys.
Select Export CSV to download the file.
Open the downloaded CSV file in your spreadsheet application.
Rate limits
The API is rate-limited to ensure service reliability and performance. Rate limits are applied organization-wide across all API keys. You can find the organization's rate limit in the API Keys settings page in Omny Studio.
If you require a higher API limit, please contact support with a technical reason for the increase.
CORS
CORS requests are not allowed by default on the management API for security reasons as it is not possible to secure management API keys in client-side JavaScript running in a browser environment.
There is considerable risk if bad actors retrieve a management API keys as it can be used to create, modify and delete data in your organization.
As an alternative you may consider the Consumer API which allows CORS requests.
However if you believe you have an exceptional use case where the security risks are mitigated and would like CORS requests to be allowed for a specific management API key, please contact support.