Skip to main content
POST
/
knowledge
/
v1alpha
/
{parent}
/
knowledge:find
Query knowledge
curl --request POST \
  --url https://api.inworld.ai/knowledge/v1alpha/{parent}/knowledge:find \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "knowledge": [
    "workspaces/example/knowledge/faq"
  ],
  "searchQuery": {
    "textQuery": "refund policy"
  }
}
'
{
  "records": [
    {
      "text": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.inworld.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Should follow the format Basic {credentials}. The {credentials} consists of the Base64-encoded string of the API key and the secret in the format key:secret

Path Parameters

​
parent
string
required

The workspace that owns the knowledge collections. Format: workspaces/{workspace}.

Pattern: workspaces/[^/]+

Body

application/json

Request to retrieve knowledge records based on a search query.

​
knowledge
string[]
required

The list of knowledge collection resource names to search within. Format: workspaces/{workspace}/knowledge/{knowledge}.

​
searchQuery
object
required

Query used to retrieve knowledge.

Response

A successful response.

Response containing the retrieved knowledge records.

​
records
object[]

List of retrieved knowledge records.