GET
/
v1
/
knowledge-bases
/
{knowledge_base_id}
/
documents
/
{status}
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "summary": "<string>",
      "short_summary": "<string>",
      "doc_type": "<string>",
      "source_type": "Document",
      "source_metadata": {},
      "content_type": "<string>",
      "has_conversion": true,
      "status": "trained",
      "doc_metadata": {},
      "error": {},
      "name": "<string>",
      "prefix": "<string>",
      "uri": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "size": 123,
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
knowledge_base_id
string
required
​
status
string
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

200
application/json
Successful Response
​
items
object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
pages
integer
required
Required range: x >= 0