> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> BoostGPT REST API documentation

## Base URL

[https://api.boostgpt.co](https://api.boostgpt.co)

## Authentication

All API requests require authentication using your API key in the `Authorization` header:

```bash theme={null}
curl https://api.boostgpt.co/v1/bot/read \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "YOUR_PROJECT_ID",
    "bot_id": "YOUR_BOT_ID"
  }'
```

## Getting Started

**1. Get API credentials**

Sign up at [app.boostgpt.co](https://app.boostgpt.co) and generate an API key

**2. Create a project**

Create a project and copy your Project ID

**3. Make your first request**

Use the endpoints documented in the API Reference tab above

## SDKs

We recommend using our official SDKs instead of making direct API calls:

> [card] [Node.js Core SDK](/docs/sdk/core/installation.md)
>
> Official JavaScript/TypeScript SDK for bot management and chat

> [card] [Router SDK](/docs/sdk/router/installation.md)
>
> Multi-channel deployment SDK for Discord, Telegram, Slack, etc.

## Response Format

All endpoints return JSON responses in this format:

### Success Response

```json theme={null}
{
  "success": true,
  "data": {
    // Response data
  }
}
```

### Error Response

```json theme={null}
{
  "success": false,
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE"
  }
}
```

## Rate Limits

> [card] Free Tier
>
> 1,000 requests per day

> [card] Paid Plans
>
> Higher limits based on your plan

If you exceed rate limits, you'll receive a `429 Too Many Requests` response.

## Error Codes

| Code | Description |
| - | - |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid API key |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |

## API Endpoints

All available endpoints are documented in the **API Reference** endpoints section. They are automatically generated from our OpenAPI specification.

## Support

> [card] [Discord Community](https://discord.gg/KGhz5SnyXM)
>
> Get help from our community

> [card] [GitHub](https://github.com/boostgpt)
>
> Report issues or contribute


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.