List knowledge documents

Lists uploaded knowledge documents with optional filtering. Requires L0 authorization.

GET /api/v1/knowledge/documents

List knowledge documents

cURL

curl --request GET \
  --url http://127.0.0.1:4000/api/v1/knowledge/documents \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://127.0.0.1:4000/api/v1/knowledge/documents"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://127.0.0.1:4000/api/v1/knowledge/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4000",
  CURLOPT_URL => "http://127.0.0.1:4000/api/v1/knowledge/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://127.0.0.1:4000/api/v1/knowledge/documents"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://127.0.0.1:4000/api/v1/knowledge/documents")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4000/api/v1/knowledge/documents")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "fileType": "<string>",
      "source": "<string>",
      "projectId": "<string>",
      "version": 123,
      "checksum": "<string>",
      "filePath": "<string>",
      "markdownPath": "<string>",
      "converterCommand": "<string>",
      "converterMeta": {},
      "errorMessage": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "statusCode": 123,
  "code": "<string>",
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

projectId · string

Minimum string length: 1

status · enum<string>

Available options: uploaded, indexing, indexed, failed

limit · integer

Required range: 1 <= x <= 1000

Response

200

application/json

Knowledge document list

items · object[] · required

Show child attributes