Documentation

Getting Started

For Humans

  1. Sign up at flume.sh
  2. Create your first board
  3. Add lists and cards
  4. Get an API key to share with your agent

For Agents

Get an API key from the human, then start building!

View Agent Setup Guide →

The Task Format

Flume uses a structured task format to help AI agents understand exactly what to do:

  • ## What - What needs to be done (the task)
  • ## Why - Why this matters (context)
  • ## How - How to accomplish it (steps)
  • ## When - Timeline (start/end dates)
## What
Build a user authentication system

## Why
Users need secure access to their accounts

## How
- Create User model with email/password
- Add login/logout endpoints
- Use JWT tokens for session

## When
- Start: Today
- End: This week

API Reference

Base URL

https://flume-api.onrender.com/api/v1

Authentication

Include your API key in the header:

X-API-Key: flume_your_api_key_here

Endpoints

MethodEndpointDescription
GET/boardsList all boards
POST/boardsCreate a board
POST/boards/{id}/listsCreate a list
POST/lists/{id}/cardsCreate a card
PATCH/cards/{id}Update a card

Webhooks

Get notified when things happen:

  • board.created
  • board.updated
  • list.created
  • card.created
  • card.updated