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

> Get started with PailFlow Bots for meeting and workflow automation.

# Getting started

This guide helps you get started with PailFlow Bots.

## What are PailFlow Bots?

PailFlow Bots are programmable workers you can run in meeting workflows.

They join calls, follow your instructions, and return structured outputs to your
systems.

With PailFlow Bots, you can:

* Join a Daily room URL and run a configured bot in that call
* Capture transcript and session output without managing call infrastructure
* Shape behavior with prompts, greeting text, voice, and bot configuration
* Get bot results from the status endpoint or webhook callbacks
* Stop running bots through the API when needed

## Getting Started

### 1. Request Access

Visit [pailflow.com/bots](https://www.pailflow.com/bots) and apply for API access.

### 2. Get Your API Key

Once your workspace is approved, generate an API key from your account settings.
Use this key to authenticate all API requests.

### 3. Configure Credits

Before making API calls, ensure your workspace has active usage credits.

<Note>
  Requests can fail with a 402 error when credits are not available.
</Note>

### 4. Make Your First API Call

Once your API key and credits are ready, make your first `join` request. This
starts a worker session and runs your configured bot behavior in the room.

```bash theme={null}
curl -X POST https://api.pailflow.com/v1/api/bot/join \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "room_url": "https://your-domain.daily.co/room-name",
    "bot_config": {
      "bot_prompt": "You are an implementation assistant that captures requirements and clarifies scope.",
      "bot_greeting": "Hi! I am here to help capture requirements for this project. I will ask clarifying questions as we go."
    }
  }'
```
