Skip to main content

​
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 either as a query parameter called api_key or as a header called x-api-key. 
curl -X GET https://api.getpoppy.ai/api/conversation?api_key=your_api_key \
OR: 
curl -X GET https://api.getpoppy.ai/api/conversation \
  -H "x-api-key: your_api_key"

​
How to get your API key

To get your API key, follow these simple steps:
  1. Click on the “Connect API” button in the top-right corner of your POPPY AI interface.
Click Connect API button
  1. In the dialog that appears, click on “Show more” and then copy your API key from the “API Key” field.
Copy your API key
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.
Keep your API key secure. Do not share it in publicly accessible areas such as GitHub, client-side code, or public repositories.

​
Available Endpoints

​
Conversation Endpoints

POST /api/conversation

Ask a one-time question using your knowledge base (POST method)

POST /api/conversation/{conversationId}

Continue an existing conversation thread (POST method)

GET /api/conversation

Ask a one-time question using your knowledge base (GET method)

GET /api/conversation/{conversationId}

Continue an existing conversation thread (GET method)

​
Board and Chat Endpoints

GET /api/boards

Retrieve all your knowledge boards

GET /api/chats

Retrieve all chat assistants for a board
⌘I