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

# Overview

> Interact with Bananaflow programmatically via the REST API

## Base URL

All API requests are made to:

```
https://app.bananaflow.ai/api/v1
```

## Versioning

The current API version is `v1`. The version is included in the URL path.

## Request format

All request bodies must be sent as JSON with the `Content-Type: application/json` header.

```bash theme={null}
curl -X POST https://app.bananaflow.ai/api/v1/workflow/create/definition \
  -H "Content-Type: application/json" \
  -H "X-API-Key: bnf_your_api_key" \
  -d '{"name": "My Agent", "workflow_definition": {}}'
```

## Response format

All responses are JSON. Successful responses return the relevant resource object. Error responses follow a consistent shape:

```json theme={null}
{
  "detail": "Error message describing what went wrong"
}
```

For validation errors (422), the detail may be a list:

```json theme={null}
{
  "detail": [
    {
      "loc": ["body", "name"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}
```


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