> For the complete documentation index, see [llms.txt](https://maximize-ai.gitbook.io/maximize-ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://maximize-ai.gitbook.io/maximize-ai/developer/quickstart.md).

# Quickstart

{% hint style="info" %}
Upcoming API Features in Progress
{% endhint %}

### 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](https://maximizeai.org/) ( 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.

{% hint style="info" %}
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.
{% endhint %}

### 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:

{% hint style="info" %}
Currently, the MAXIMIZEAI API only supports **JavaScript** for running code. Support for other languages may be added in the future.
{% endhint %}

```javascript
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:

```json
{

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

{% hint style="info" %}
Running low on credits? You can easily buy more from your **Credits** page.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://maximize-ai.gitbook.io/maximize-ai/developer/quickstart.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.