Skip to main content

Introduction

Welcome to the OMNI API documentation.

Use the sidebar to navigate through the available API endpoints.

Authentication​

To make authenticated requests, you should send your API key in the x-api-key header. Contact support to obtain your API key.

API Rate Limits​

API calls are subject to a limit of 300 quota units in any one-minute window. Each API call takes up 1 quota unit, unless otherwise noted in the endpoint's description.

Requests exceeding the imposed limits receive a 429 Too Many Requests response, with the following header:

  • Retry-After: The number of seconds that you should wait before making the same request again.

In addition, all responses (including non-429 ones) include the following headers:

  • X-RateLimit-Limit: The maximum quota units that you can have.
  • X-RateLimit-Remaining: The remaining quota units that you have.

The rate limit is shared by all API keys of a customer. Please contact support if you need a higher limit.