Developers

Welcome to the Audio Audit developer documentation. Here you'll find everything you need to integrate with our platform programmatically.

Two APIs, both supported. The REST API is the one to start with: it covers the whole loop — list your shows and episodes, create a report from a feed or your own audio, poll it, and read the results — it describes itself with an OpenAPI spec, and automation platforms can consume it directly. The GraphQL API is what our earliest API customers built on; it is not going anywhere, and there is no forced migration.

Both use the same API keys and the same Authorization: Bearer header.

API Resources

  • Authentication — How to create and manage API keys and add headers
  • REST API — The full v1 reference: endpoints, pagination, errors, rate limits and worked curl examples
  • GraphQL API Documentation — The GraphQL endpoint, worked curl examples and our support statement
  • Integrations — Make.com, Zapier, and how to write a poller that never drops a finished report

Getting Started

  1. Create an API key in your account settings
  2. Check it works: curl https://audioaudit.io/api/rest/v1/me -H "Authorization: Bearer YOUR_KEY"
  3. Work through the REST API reference, or browse the live API explorer and try the endpoints against your own workspace

Planned

Not built yet, and listed here so you know where we are going rather than so you can call them:

  • Webhooks — be told when a report finishes, instead of polling for it
  • Packaged Zapier and Make.com apps — no custom-app setup
  • Client SDKs — generated from the OpenAPI spec, which you can already point a generator at yourself

Support

Need help with your integration, or want to tell us what you need from the API next? Email us at info@audioaudit.io.