Read the whole API before you apply
The Engine reference is open. Resources, fields and errors are documented with examples, and none of it sits behind a form. When you want to try a call, apply for an account and create a sandbox key.
- To read
- No account needed
- Format
- REST reference with examples
- Sandbox keys
- With an approved account
Start with a request
The quickest way to read an API is to call it. These four requests make a good first hour: check that your key works, list what is there, create a release and subscribe to events.
- Each endpoint is shown with a request and a response
- Errors are listed with their cause and the fix
- Examples run against the sandbox as written
First requests
Example requestsGET/v1/me
Response
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}The reference, by resource
- Releases
- Create, update, submit and take down releases, with their territories and dates.
- Tracks and assets
- Add tracks, upload audio and artwork, and set credits, codes and splits.
- Deliveries
- Send a release to stores and follow each destination from queued to live or refused.
- Analytics
- Read streams and downloads by store, territory, release, track and day.
- Royalties
- List statements, read their lines and see what each payee is owed.
- Webhooks
- Register an endpoint, choose the events it receives and review what was sent.
Quick start, against the sandbox
- 1
Create a sandbox key
Apply for an account, and copy the key from it once it is approved.
- 2
Make your first request
Call /v1/me with the key in the Authorization header to confirm it works.
- 3
Create a test release
Post a release with a title and an artist, then add a track to it.
- 4
Simulate a delivery
Deliver it in the sandbox and watch the status move, with no store involved.
One header, and you are in
Authentication is an API key sent as a bearer token. There is no handshake and no session to keep alive. Copy this, swap in your key and run it.
- Sandbox and production use separate keys
- A key can be revoked at any time
List your releases
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"