Web API

Task-oriented guides. how to authenticate, send audio, read results, search, and integrate MusiMap into your product.

Start the quickstart OpenAPI reference

How it's organised

The Web API section is task-oriented. Each guide walks you through an end-to-end integration: authentication, submitting work, reading results, handling edge cases. If you instead need to understand what a specific value means, that is the job of the References section.

Every guide follows the same shape:

  • When to use it: the product question this feature answers.
  • What you need: credentials, scopes, and any prerequisites.
  • End-to-end example: copy/paste code in cURL where applicable.
  • Response shape: with a link to the full reference in the OpenAPI spec.
  • Gotchas: the mistakes we see most often in real integrations.

Three main V1 workflows

Most products combine the same building blocks. Start with the workflow that matches your job, then deepen with the linked guides.

1. Live tagging

Tag audio without catalogue persistence

OAuth token, presigned S3 upload, then POST /v1/audio/tagging.

 2. Catalogue ingestion

Deliver metadata and audio at scale

Inbound storage, POST /v1/ingestions, then inventory and stored tags.

 3. Search and profile

Discover tracks and build aggregates

Taxonomy tag IDs, MusiSearch, then MusiProfile over catalogue tracks.

Full end-to-end narrative: Integration guide.

MusiMap V1 workflows OAuth token, then storage upload, then live tagging or ingestion into inventory, then search and profiling. OAuth token Storage Live tagging Ingestion Inventory Search Profiling
Token and storage unlock live tagging. Ingestion fills inventory for MusiSearch and MusiProfile.

Get started

5 minutes

Quickstart

OAuth token, presigned S3 upload, and your first live MusiTag call.

Integration guide

How V1 endpoints combine into live tagging, ingestion, and search workflows.

Authentication (OAuth2)

Client-credentials flow, token lifecycle and documented scopes.

Sign in with MusiMap

OIDC Authorization Code + PKCE for end-user identity in your product.

Status & versioning

/v1 versioning, /openapi/v1.json, and public status endpoints.

OpenAPI reference

Interactive browse of every V1 endpoint plus raw JSON download.

Core features (V1)

Catalogue management and technical inventory. Each card links to a full guide.

Catalogues

List catalogues available to your OAuth client.

 Catalogue

Ingestions

Create ingestions and inspect delivery status, entities, items, and stats.

Storage

Presigned inbound uploads, object listing, delete, and optional storage credentials.

Tracks

Technical catalogue inventory for ingested tracks.

Artists

Technical inventory for ingested artists.

Releases

Technical inventory for ingested releases.

Works

Technical inventory for ingested musical works.

Product features (V1)

MusiTag, MusiSearch, and MusiProfile capabilities.

MusiTag

Tagging

Live tagging from S3 and stored tagging lookup for catalogued tracks.

Taxonomy

Stable tag IDs grouped by category for MusiSearch filters.

 MusiSearch

Catalogue search

Track discovery with text, tag ID filters, and audio attributes.

 MusiProfile

Profiling

Aggregate listener profiles for a list of analysed catalogue tracks.
  • References: error shapes, pagination, scopes, and OpenAPI.
  • SDKs: official client libraries.
  • Status: current platform health and past incidents.

Building beyond the guides?

For fingerprinting, webhooks, advanced discovery, or custom integration paths, contact the MusiMap team; we'll help you map the right workflow for your product.

Contact the team Integration guide