FAQ

Answers to the questions we hear most often about API integration.

Can I start integrating right now?

The album ingest API spec is published in the endpoint reference. Any detailed changes are announced in Announcements. We recommend using the Quickstart and the spec to prepare your integration up front — server-side calls, key storage, and resend handling.

How do I get an API key?

Self-service issuance in the partner console is still in the works. In the meantime, request a key through the contact page or by email (partner@muzlive.com), whichever is easier, and we will walk you through it. See Issue an API key for the full procedure.

Do I need an API key if I only want member integration?

No. Member integration uses a token handoff (redirect) flow with no API calls, so no API key is required. All you need is the JWT signing secret and landing URL issued during onboarding. An API key is only required when your server calls the data APIs directly (for example, sending album or artist metadata). See Integration channels in the overview for the difference between the two channels.

How do I know when an ingest has finished?

A 201 from the create call means the album has been created in production; audio, image, and other resource files are loaded asynchronously afterwards. Poll ingest status (GET /ddex/ingests/{ingestId}) until status becomes completed. We recommend a first check about 30 seconds after the ingest, then every 30 seconds to 1 minute; the resources field in the response also shows progress (total, completed, failed). To be notified of completion or failure in real time, register a webhook.

What happens if I send the same album (releaseId) again?

You always get a 409, and the existing ingest is left unchanged. Once an album has been ingested it cannot be modified through the API — contact us if you need a change. That said, the 409 response carries the existing ingest (ingestId, status) in error.details, so if you are retrying after a timeout you can treat it as a success response. A 422 (XML processing failure) is different: no ingest was created, so you can resend once the cause is fixed — see the resend policy in the Create an album ingest reference.

What are the rate limits?

Whatever your limit is, exceeding it returns a 429 with a Retry-After header, so implementing retries with exponential backoff up front keeps you safe.

What should I do when I get a 429 or 500 response?

For 429, retry after the wait time in the Retry-After header; for 500, retry with exponential backoff. If it keeps happening, check Error codes for guidance, and if that does not resolve it, contact us with the requestId.

Where do I report an error during integration?

Submit it through the contact page (see contact channels). Including the time it occurred, the endpoint you called, and the requestId helps us investigate faster. Never include your API key value in a support request.