Getting Started
Integers
Floats
Hex
Strings

Getting Started

To start using the Quantumize API, you'll need a Quantumize account, which will provide you with an API key required to make any requests. If you don't have an account yet, you can sign up here.

Generating API Key

Once you have registered for an account, you need to create a new application here. Each application you create will be provided with its own unique API key.

Including API Key in Requests

With your API key in hand, you are now ready to make API requests. Ensure that you include the API key in the x-api-key HTTP header of each request. This header allows the API to authenticate and authorize your application to access its resources.

Keeping your API Key Secure

Your API key is a critical piece of information that grants access to your Quantumize account and its associated resources. Treat it like a password and keep it private at all times. Sharing your API key with unauthorized individuals or third-party services poses a significant security risk and potential misuse of your account.

To safeguard your application and data, follow these best practices:

Never include your API key directly in client-side code, such as JavaScript or React components. Malicious actors can easily extract exposed API keys from client-side code.
Use server-side code or a backend service to make API requests, securely storing and managing your API key on the server.
If you suspect that your API key has been compromised, regenerate it immediately through your Quantumize account dashboard.
Create separate API keys for different applications or environments, allowing you to control access and revoke individual keys if needed.

By following these best practices, you can ensure the security and integrity of your Quantumize account and API access, protecting your application and data from potential threats. Regularly review API key usage and audit access logs to detect any suspicious activities.

Rate Limits

To maintain the stability and performance of the API, we have rate limits in place. If you exceed the rate limit for your API key, you will receive a status code of 429 (Too Many Requests). Rate limits vary by plan, and you can view your current rate limit per application here.

Now that you have the basics, you can explore the different API endpoints and functionalities available in the Quantumize API. Use the navigation bar on the left to find more specific examples and information.