Skip to content
Amity SolutionsAmity SolutionsAmity Solutions Docs

List knowledge bases

GET
/knowledge
curl --request GET \
  --url 'https://api.amitysolutions.com/api/v1/knowledge?pagination%5Bpage%5D=1&pagination%5BpageSize%5D=25' \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
pagination[page]
integer
default: 1 >= 1

Page number of the query

pagination[pageSize]
integer
default: 25 >= 1 <= 100

Number of items to include in each page

Responses

Section titled “ Responses ”

200

Section titled “200”

A list of knowledge bases and pagination metadata

Media typeapplication/json
object
data
Array<object>
object
id

Numeric ID of the knowledge

number
name

The name of the knowledge

string
source

Type of knowledge base. internal will search the content from uploaded files and external will send a request to target endpoint for search.

string
Allowed values: internal external
supportedLanguages

List of supported languages for the knowledge. Files uploaded to this knowledge will have a copy of the document with each supported language translated.

Array<string>
Allowed values: en th
target

Search endpoint for external knowledge bases

string
enableSemanticSearch

If set to true, search will use semantic search on top of full-text search.

boolean
createdAt

Timestamp of creation for knowledge

string format: ISOString
updatedAt

Last updated timestamp for knowledge

string format: ISOString
total

Total number of items that can be found with current filters

number
pagination
object
page

Current page

number
pageCount

Total number of pages available with current filters

number
pageSize

Number of items included in each page

number
Example
{
  "data": [
    {
      "source": "internal",
      "supportedLanguages": [
        "en"
      ],
      "createdAt": "2023-11-09T00:00:00.000Z",
      "updatedAt": "2023-11-09T00:00:00.000Z"
    }
  ]
}

401

Section titled “401”

Unauthorized Error. ASAP will return this error when there is either no api key, invalid api key or the client`s IP address is not whitelisted.

Media typeapplication/json
object
name
string
code
number
status
number
message
string
errors
Array<object>
object
Example
{
  "name": "UnauthorizedException",
  "code": 401001,
  "status": 401,
  "message": "Unauthorized",
  "errors": []
}

422

Section titled “422”

Validation Error

Media typeapplication/json
object
name

Name of the error

string
code

ASAP platform specific error code

number
status

HTTP status code

number
message

Error message details

string
errors
Array<object>
object
type
required

Type of error

string
field
required

Name of the field having the error

string
value

Input value

string
message
required

Error message

string
Example
{
  "name": "UnprocessableEntityException",
  "code": 422001,
  "status": 422,
  "message": "request payload validation failed",
  "errors": [
    {
      "type": "isNotEmpty",
      "field": "name",
      "message": "name must not be empty"
    },
    {
      "type": "min",
      "field": "limit",
      "value": -1,
      "message": "limit must not be less than 1"
    }
  ]
}

429

Section titled “429”

Too Many Requests

Media typeapplication/json
object
name

Name of the error

string
code

ASAP platform specific error code

number
status

HTTP status code

number
message

Error message details

string
errors
Array<object>
object
Example
{
  "name": "RateLimitExceededException",
  "code": 429001,
  "status": 429,
  "message": "Rate limit exceeded",
  "errors": []
}