Skip to main content
GET
/
knowledge
/
v1alpha
/
{name}
Get knowledge
curl --request GET \
  --url https://api.inworld.ai/knowledge/v1alpha/{name} \
  --header 'Authorization: <api-key>'
{
  "name": "<string>",
  "records": [
    {
      "text": "<string>"
    }
  ],
  "language": "LANGUAGE_CODE_UNSPECIFIED"
}

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

​
name
string
required

The name of the knowledge collection to retrieve. Format: workspaces/{workspace}/knowledge/{knowledge}.

Response

A successful response.

Represents a knowledge collection, which contains multiple knowledge records.

​
name
string

Resource name that is provided by user and can contain only lowercase letters, digits, underscores, or hyphens and has length up to 61 symbols

​
records
object[]

List of knowledge records in the collection.

​
language
enum<string>
default:LANGUAGE_CODE_UNSPECIFIED

Language codes following the format of Language_Locale. Language is defined per ISO 639-1. Locale is defined per ISO 3166-1. Current protobuf value: 3. Please update with each revision.

  • LANGUAGE_CODE_UNSPECIFIED: Unspecified.
  • EN_US: English - US.
  • ZH_CN: Chinese - China.
  • KO_KR: Korean - Korea.
  • JA_JP: Japanese - Japan.
  • RU_RU: Russian - Russia.
  • AUTO: Auto-detect language.
Available options:
LANGUAGE_CODE_UNSPECIFIED,
EN_US,
ZH_CN,
KO_KR,
JA_JP,
RU_RU,
AUTO