Getting Started

Resources

To learn more about the details behind our AI models and capabilities, reference our desktop software application documentation below:

Authentication

You will need a Topaz API key in order to make requests to this API. Make sure you never share your API key with anyone, and you never commit it to a public repository.

Once you have your API key, set it as the X-API-Key header of your requests.

Please contact support if any assistance is needed.

Please visit https://www.topazlabs.com/api to get started with an API key if you have not already.

API Restrictions

  • The API has access rate limits depending on the current load on the servers. If you receive a HTTP 429 response, please try again (soon). We recommend using an exponential backoff for the requests to avoid immediately hitting the limit again.
  • The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
  • The API enforces a request size limit of 500MB. If a request exceeds this limit, the server responds with an HTTP 413. Please ensure that requests stay within the size constraint to avoid this error.

Contact

Please reach out to enterprise@topazlabs.com with any questions.