Skip to content
RX
Resomix Docs
B2B API
Guide
•
1 MIN_READ

Authentication & Scopes

Resomix sonic index protocol parameters

All B2B Partner endpoints (with the exception of /health) require authentication and authorization.

The X-Api-Key Header

Every request to the Resomix API must transmit a valid API key in the standard HTTP header:

http // format_parameters
X-Api-Key: <your_api_key>

Your API Key

  • Onboarding-issued key: Your secure, high-throughput API key is generated and issued during onboarding, scoped to your catalog.
  • Header format: Pass it on every request as shown below (or as an Authorization: Bearer rmx_… token).

Example Header:

http // format_parameters
X-Api-Key: rmx_your_partner_key

Scopes & Permissions

B2B API keys are assigned permission scopes at the time of issuance. If your key lacks a required scope, the server returns a 401 Unauthorized response with detail indicating the missing permission.

  • search:read — Required to search your catalog and run similarity queries (by track ID or by upload).

Additional scopes may be granted per contract. Your issued key already carries everything your integration needs — if you hit a 401 for a missing scope, contact your Resomix point of contact.