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

# API Introduction

> Integrate Flowyble into your applications with the REST API.

## Overview

The Flowyble API lets you programmatically execute agents and tools, check run statuses, and retrieve results. All endpoints are versioned and return JSON responses.

**Base URL:**

```
https://api.flowyble.com/v1
```

## What you can do

| Endpoint Group | Description                                    |
| -------------- | ---------------------------------------------- |
| **Agents**     | Run agents, check status, get detailed results |
| **Tools**      | Run tools, check status, get results           |
| **Webhooks**   | Receive triggers from external systems         |

## Rate limiting

API requests are rate-limited to **100 requests per 60 seconds** per API key. Webhook endpoints have a separate limit of **30 requests per 60 seconds**.

When you exceed the limit, you'll receive a `429 Too Many Requests` response. Wait and retry after the rate limit window resets.

## Response format

All responses follow a consistent JSON structure:

```json theme={null}
{
  "success": true,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Pending",
  "message": "Agent run started"
}
```

Error responses include details:

```json theme={null}
{
  "success": false,
  "message": "Insufficient credits"
}
```

## Requirements

* **API Access** must be enabled on your subscription plan
* A valid **API Key** (see [Authentication](/api-reference/authentication))
* Sufficient **credits** in your organization balance