This guide walks you through the full journey — from first contact to running similarity queries against your own catalog. Each step notes whether you or Resomix is responsible, so you always know what to do next.
Step 1 — Request access
Get in touch with Resomix to start onboarding. You'll complete a short partner intake form describing your catalog and how you intend to use the API.
Responsibility: you. (The intake form is coming soon — until then, contact your Resomix point of contact directly.)
Step 2 — Receive your credentials
Once your account is provisioned, Resomix emails you two sets of credentials:
- SFTP connection details — the host, username, and key/password you'll use to upload your catalog.
- Your partner API key — an
rmx_…key used to authenticate every API request.
These credentials are secret and tied to your organization. Store them in a secrets manager, never commit them to source control, and never expose them in client-side code. If you suspect a key has leaked, contact us immediately to rotate it.You are responsible for safeguarding them.
Responsibility: you (safeguarding). Resomix issues the credentials.
Step 3 — Upload your catalog
Connect over SFTP using the details from Step 2 and upload, in this order:
- Your audio files — FLAC, WAV, or MP3.
- A manifest CSV — one row per track, describing your catalog (see the format below).
- A
.donemarker file — upload this last.
The .done file signals that your batch is complete. Upload it only after all audio files and the manifest have finished transferring.
Nothing is processed until the.donefile arrives, so a partial or interrupted upload will never be ingested by mistake. If you need to start over, just re-upload and place a fresh.doneat the end.
Manifest CSV format
The manifest tells Resomix what you uploaded. Use a UTF-8 CSV with a header row.
Required columns
| Column | Description |
|---|---|
isrc | The track's ISRC (e.g. USRC17607839). Must be unique within your catalog. |
title | Track title. |
display_artist | Primary artist name as it should be displayed. |
audio_filename | Exact filename of the uploaded audio (must match what you sent over SFTP). |
Optional columns
| Column | Description |
|---|---|
mix_name | Mix/version label (e.g. Radio Edit, Extended Mix). |
version_title | Additional version descriptor. |
genre | Genre tag. |
duration_ms | Track duration in milliseconds. |
Responsibility: you.
Step 4 — Wait for the confirmation email
After your .done file is received, Resomix processes your catalog and makes it searchable. When it's ready, you'll get a confirmation email. Processing time scales with the size of your catalog.
Responsibility: Resomix. You simply wait for the email — no action needed.
To add more tracks later, just repeatStep 3: upload the new audio plus a manifest for them, then a fresh.donefile. New tracks are added on top of your existing catalog.
Step 5 — Query your catalog
Once you've received the confirmation email, your API key can query your catalog three ways. Try them live in the API Playground, or copy ready-made curl commands from the API Reference.
- Search — find tracks in your catalog by title and/or artist. Each result includes a Resomix track ID.
- Similarity by ID — pass a track ID (from a search result) to get the most similar tracks in your catalog, ranked by score.
- Similarity by upload — upload an audio file to find the most similar tracks. The upload is a one-shot probe — it is not added to your catalog.
All three are authenticated with your partner key and scoped to your catalog only. See the Quickstart for your first end-to-end call.
Responsibility: you.