# Bluebricks API Overview

Programmatic access to the Bluebricks control plane.

{% hint style="info" %}
Only users with appropriate permissions can create API tokens. See [Authentication](/docs/api/authenticate/authentication.md) for details on managing API tokens.
{% endhint %}

## Base URL

All API requests should be made to:

```
https://api.bluebricks.co/api/v1
```

## Common Use Cases

The Bluebricks API enables you to:

* Manage collections and their properties
* Deploy and manage blueprints across collections
* Retrieve environment status and logs
* Configure cloud account connections
* Automate infrastructure provisioning workflows

## Getting Started

To use the Bluebricks API:

1. **Authenticate** - Create a long-lived API token or use CLI-generated tokens
2. **Explore endpoints** - Browse the API Reference for detailed specifications
3. **Test requests** - Use the interactive API documentation to test endpoints

### Authentication Options

**Long-lived API Tokens** (Recommended for automation) Create persistent tokens for automated workflows. See [Authentication](/docs/api/authenticate/authentication.md) for details.

**JWT Tokens** (For personal authentication) Use your JWT token obtained from the CLI or UI for testing. See [Authentication](/docs/api/authenticate/authentication.md) for details on extracting JWT tokens.

### Quick Example

List all collections in your organization:

```bash
curl -X 'GET' \
  'https://api.bluebricks.co/api/v1/collections' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'
```

## Next Steps

* [Authentication](/docs/api/authenticate/authentication.md) - Learn how to create and manage API tokens
* [Webhooks](https://github.com/bluebricks-dev/Bluebricks-Documentation/blob/main/workflows/webhooks.md) - Set up event-driven integrations


---

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

```
GET https://bluebricks.co/docs/api/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.