List Documents

List all knowledge documents.

GET /api/v1/documents

List Documents

cURL

curl --request GET \
  --url https://{tenant_id}.api.useago.com/api/v1/documents \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/documents"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant_id}.api.useago.com/api/v1/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "object": "document",
      "page_id": "<string>",
      "status": "<string>",
      "public_display": true,
      "default_language": "en",
      "source_id": "<string>",
      "source_name": "<string>",
      "parent_id": "<string>",
      "position": 0,
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "has_more": true,
  "total": 123,
  "object": "list"
}

Authorizations

X-API-Key · string · header · required

Query Parameters

page · integer · default: 1

page_size · integer · default: 50

source_name · string | null

search_title · string | null

include_content · boolean · default: false

Response

200 - application/json

OK

Paginated list of document summaries.

data · DocumentSummaryOut · object[] · required

Show child attributes

has_more · boolean · required

total · integer · required

object · string · default: list