Quickstart

Get started with running your API environments using MAXIMIZEAI.

Upcoming API Features in Progress

Generate an API Key

To use MAXIMIZEAI Services, you’ll need an API key. Here’s how to generate one:

1. Login to your MAXIMIZEAI account

2. Go to the API Keys Dashboard ( Coming Soon )

3. Click on the ”+ API Key” button to create a new key.

4. Name your key something descriptive (e.g., “Development Key”) to keep things organized.

5. Copy and save your API key in a secure place — you won’t be able to view it again later!

6. On the API Keys list, click the "More" button next to your new key, then select "IP Whitelist".

7. Enter your IP address to add it to the whitelist for secure access.

Never expose your API key publicly or include it in your version control (e.g., GitHub). To keep your key safe, we strongly recommend storing it in environment variables or a secure secrets management tool.

Using Your API Key to run a API

Once you have your API key, you can start using MAXIMIZEAI services. Here’s how to authenticate your requests:

Currently, the MAXIMIZEAI API only supports JavaScript for running code. Support for other languages may be added in the future.

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY_HERE'
  }
};

fetch('https://openapi.maximizeai.org/v1/balance', options)
  .then(response => {
    if (!response.ok) {
      throw new Error(HTTP error! Status: ${response.status});
    }
    return response.json();
  })
  .then(data => console.log('Balance:', data))
  .catch(err => console.error('Error fetching balance:', err));

The output of the above code will be the following JSON Response:

{

  status: 200,
  balance: {
    credits: 1200,
    plan: "Pro",
    
  }
  
}

Running low on credits? You can easily buy more from your Credits page.