> For the complete documentation index, see [llms.txt](https://developers.bloomcredit.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.bloomcredit.io/getting-started/readme.md).

# Introduction to the API

This page will help you get started with Bloom Credit. You'll be up and running in a jiffy!

To get started with Bloom Credit, follow these next simple steps:

## 1. Get your Credentials

Once you complete your onboarding process, Bloom will provide you with two credentials: **Client ID** and **Client Secret**.

If you have not started your onboarding process, please [contact us](https://www.bloomcredit.io/contact-us) to obtain your credentials to access.

{% hint style="info" %}
**TIP**

We encourage users to get acquainted with our API in our sandbox. [Contact us](https://www.bloomcredit.io/contact-us) if you're interested in obtaining credentials to access to our sandbox.
{% endhint %}

***

## 2. Set up the API Authentication

All requests to the Bloom API must be authenticated. Check out the [API Authentication](https://developers.bloomcredit.io/reference/) page to learn how to retrieve and use an access token to authenticate your API requests.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.bloomcredit.io/getting-started/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.