Skip to main content
GET
/
api
/
conversation
Ask knowledge base
curl --request GET \
  --url https://api.getpoppy.ai/api/conversation \
  --header 'x-api-key: <api-key>'
{
  "text": "Based on the information available, your favorite number is 444.",
  "credits_used": 0.04975,
  "credits_remaining": 1853.74585
}
This endpoint allows you to ask a question and get an answer that incorporates all your connected knowledge sources and documents.

​
Query Parameters

​
api_key
string
Your API key for authentication
​
board_id
string
required
The ID of the board where the chat is located
​
chat_id
string
required
The ID of the chat assistant
​
prompt
string
required
The user’s question or prompt for the AI
​
model
string
default:"claude-4-sonnet-20250514"
The AI model to use. Allowed values: claude-4-sonnet-20250514, o3-mini, gpt-4o, grok-2-1212, gpt-4o-mini
​
plaintext
string
default:false
Force the AI response to use plain text instead of markdown. Allowed values are “true” or “active”. Any other value will disable plaintext.
​
streaming
string
default:false
Return the answer as a stream instead of a JSON. Allowed values are “true” or “active”. Any other value will disable streaming.
​
additional_context
string
default:" "
Additional information to provide as context to the AI

​
Response

​
text
string
The AI-generated response to the prompt
​
credits_used
number
The number of credits used for this request
​
credits_remaining
number
The total number of credits remaining in your account within this month period
{
  "text": "Based on the information available, your favorite number is 444.",
  "credits_used": 0.04975,
  "credits_remaining": 1853.74585
}
This endpoint is functionally equivalent to the POST /api/conversation endpoint, but allows for easier testing and integration in contexts where POST requests are difficult to implement.
⌘I