List documents in collection

Get all documents in a collection with pagination and sorting options.

GET /api/r2r/v3/collections/{id}/documents

List documents in collection

cURL

curl --request GET \
  --url https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/documents \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/documents"

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

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

print(response.text)

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

fetch('https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/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.intelligence.io.solutions/api/r2r/v3/collections/{id}/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 := "https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/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("https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/documents")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/documents")

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

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

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

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "collection_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "owner_id": "123e4567-e89b-12d3-a456-426614174000",
      "document_type": "pdf",
      "metadata": {
        "title": "Sample Document"
      },
      "version": "1.0",
      "title": "Sample Document",
      "size_in_bytes": 123456,
      "ingestion_status": "pending",
      "extraction_status": "pending",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "ingestion_attempt_number": 0,
      "summary": "A summary of the document",
      "summary_embedding": [
        0.1,
        0.2,
        0.3
      ],
      "total_tokens": 1000
    }
  ],
  "total_entries": 1
}

{}

This endpoint retrieves a paginated list of documents associated with a specific collection. It supports sorting options to customize the order of returned documents.

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string · required

Collection ID

Query Parameters

offset · integer<int32> · default: 0

Specifies the number of objects to skip. Defaults to 0. >=0

limit · integer<int32> · default: 100

Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100. >=1 <=1000

Response

200

application/json

200

results · object[]

Show child attributes

total_entries · integer · default: 0

Example:

1