Join Community
DocsDeveloper GuideAPI DocumentationChangelog
Project API Integration

Query Knowledgebase

Search your project's trained knowledgebase using semantic search. Returns the most relevant document chunks matching your query.

Search your project's trained knowledgebase using semantic search. Returns the most relevant document chunks matching your query.

POST
/searchIndexDocument

Authorization

apiKey

api-key<token>

API key for authentication. Generate your API key from the Integration settings in your YourGPT dashboard.

In: header

Request Body

application/json

query*string

The search query to find relevant documents in your knowledgebase

limit*integer

Maximum number of results to return (max 100)

Default10
Rangevalue <= 100
offset?integer

Number of results to skip for pagination. Defaults to 0

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.yourgpt.ai/chatbot/v1/searchIndexDocument" \  -H "Content-Type: application/json" \  -d '{    "query": "string",    "limit": 10  }'
{
  "type": "RXSUCCESS",
  "message": "string",
  "data": [
    {
      "point_id": "string",
      "doc_id": "string",
      "score": 0,
      "content": "string"
    }
  ]
}
{
  "type": "RXERROR",
  "message": "string"
}
{
  "type": "RXERROR",
  "message": "string"
}
{
  "type": "RXERROR",
  "message": "Query Knowledgebase API is not available on your current plan. Please upgrade to Professional or above."
}
{
  "type": "RXERROR",
  "message": "Rate limit exceeded. Your plan allows 100 requests per hour."
}