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

# Quickstart

> Getting Started with the POPPY AI API

<iframe width="560" height="315" src="https://www.youtube.com/embed/2kIoS9vxzPA?si=2aqvH3S8og9fwv_q" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />

## Base URL

The base URL for all API endpoints is `https://api.getpoppy.ai`.

## Authentication

All API endpoints require authentication using an API key. The API key must be included in every request as a query parameter called `api_key`.

```bash theme={null}
curl -X GET https://api.getpoppy.ai/api/conversation?api_key=your_api_key \
```

## How to get your API key

To get your API key, follow these simple steps:

1. Click on a chat on your board, then click the "API" button just above the chat.

<Frame>
  <img src="https://mintcdn.com/getpoppyai/d5VZJxx0NUXD2c7y/api.jpeg?fit=max&auto=format&n=d5VZJxx0NUXD2c7y&q=85&s=b89f985adaff01ad785fa3fce0d49e8a" alt="Click API button" width="2988" height="1848" data-path="api.jpeg" />
</Frame>

2. In the dialog that appears, click on "Show more" and then copy your API key from the "API Key" field.

<Frame>
  <img src="https://mintcdn.com/getpoppyai/d5VZJxx0NUXD2c7y/images/api_key_step_2.png?fit=max&auto=format&n=d5VZJxx0NUXD2c7y&q=85&s=a3d19a46b56efe6a9b4e149045006cb7" alt="Copy your API key" width="1760" height="1390" data-path="images/api_key_step_2.png" />
</Frame>

<Note>
  Enter your API key in the authentication field at the top of each API endpoint page. The API
  playground will automatically include your API key in all requests.
</Note>

<Warning>
  Keep your API key secure. Do not share it in publicly accessible areas such as GitHub, client-side
  code, or public repositories.
</Warning>

## Available Endpoints

### Conversation Endpoints

<CardGroup cols={2}>
  <Card title="POST /api/conversation" icon="message" href="/api-reference/endpoint/conversation-ask-via-post">
    Ask a one-time question using your knowledge base (POST method)
  </Card>

  <Card title="POST /api/conversation/{conversationId}" icon="comments" href="/api-reference/endpoint/conversation-message-via-post">
    Continue an existing conversation thread (POST method)
  </Card>

  <Card title="GET /api/conversation" icon="message" href="/api-reference/endpoint/conversation-ask-via-get">
    Ask a one-time question using your knowledge base (GET method)
  </Card>

  <Card title="GET /api/conversation/{conversationId}" icon="comments" href="/api-reference/endpoint/conversation-message-via-get">
    Continue an existing conversation thread (GET method)
  </Card>
</CardGroup>

### Board and Chat Endpoints

<CardGroup cols={2}>
  <Card title="GET /api/boards" icon="clipboard" href="/api-reference/endpoint/get-boards">
    Retrieve all your knowledge boards
  </Card>

  <Card title="GET /api/chats" icon="message-captions" href="/api-reference/endpoint/get-chat-nodes">
    Retrieve all chat assistants for a board
  </Card>
</CardGroup>