Skip to main content
GET
/
public
/
v1
/
knowledge-base
/
documents
List documents
curl --request GET \
  --url https://api.callin.io/api/public/v1/knowledge-base/documents \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.callin.io/api/public/v1/knowledge-base/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://api.callin.io/api/public/v1/knowledge-base/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.callin.io/api/public/v1/knowledge-base/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 => [
"x-api-key: <api-key>"
],
]);

$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.callin.io/api/public/v1/knowledge-base/documents"

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

req.Header.Add("x-api-key", "<api-key>")

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.callin.io/api/public/v1/knowledge-base/documents")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.callin.io/api/public/v1/knowledge-base/documents")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": [
    {
      "documentId": "<string>",
      "type": "url",
      "name": "<string>",
      "details": {
        "url": "<string>"
      },
      "metadata": {
        "createdAt": "2023-11-07T05:31:56Z",
        "createdBy": {
          "userId": "<string>",
          "userEmail": "<string>"
        }
      }
    }
  ],
  "pagination": {
    "pageSize": 123,
    "hasMore": true,
    "nextCursor": "<string>",
    "sortBy": "name",
    "sortDirection": "asc"
  }
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"fields": [
{}
]
}
}

Authorizations

x-api-key
string
header
required

Send your Callin API key in the x-api-key header.

Query Parameters

cursor
string

Used for fetching next page. Cursor is returned in the response.

pageSize
integer
default:30

How many documents to return at maximum. Can not exceed 100, defaults to 30.

Required range: 1 <= x <= 100

Search for documents by name

sortBy
enum<string>

The field to sort the results by

Available options:
name,
created_at
sortDirection
enum<string>

The direction to sort the results

Available options:
asc,
desc

Response

Documents list

Paginated knowledge documents (URL and file types).

success
boolean
Example:

true

data
object[]

A list of documents and their metadata

URL-sourced document. details holds only url; file fields live only on file documents.

pagination
object