API Reference | JazzHQ AI

The JazzHQ APIs let you programmatically manage your PartnerOS and integrate partner operations into your existing systems and workflows.

Use the APIs to manage your partnership, build custom integrations, and connect PartnerOS with the tools your business already uses.

Base URL

https://api.jazzhq.ai

Authenticate API requests using your JazzHQ API key. Include your API key in the X-API-KEY header with every request:

X-API-KEY: YOUR_API_KEY

You can generate and manage API keys from your PartnerOS account, or reach out on Support to get one.

Only paths under /api/v1/ are valid for this key type. Requests to any other path are rejected even with a valid key.

All API responses are returned as JSON. Successful responses include the result in the data field. { success, message, data, timestamp }

For error responses and error codes, see Errors.