Skip to main content
GET
/
api
/
v1
/
knowledge
/
documents
List Documents
curl --request GET \
  --url https://api.example.com/api/v1/knowledge/documents
import requests

url = "https://api.example.com/api/v1/knowledge/documents"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/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_URL => "https://api.example.com/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",
]);

$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 := "https://api.example.com/api/v1/knowledge/documents"

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/knowledge/documents")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/knowledge/documents")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "request_id": "<string>",
  "data": {
    "documents": [
      {
        "doc_id": "<string>",
        "category_id": "<string>",
        "title": "<string>",
        "topic_count": 123,
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 123,
    "page": 123,
    "page_size": 123
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Query Parameters

app_id
string
default:default
project_id
string
default:default
category_id
string | null
page
integer
default:1
Required range: x >= 1
page_size
integer
default:20
Required range: 1 <= x <= 100
sort_by
enum<string>
default:created_at
Available options:
created_at,
updated_at,
title
sort_order
enum<string>
default:desc
Available options:
asc,
desc

Response

Successful Response

request_id
string
required
data
DocumentListResponse · object
required

Response for GET /documents.