Skip to main content
GET
/
api
/
r2r
/
v3
/
documents
List documents
curl --request GET \
  --url https://api.intelligence.io.solutions/api/r2r/v3/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": "<string>",
  "offset": 0,
  "limit": 100,
  "include_summary_embeddings": false,
  "owner_only": false
}'
{
  "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
}
Results can be filtered by providing specific document IDs. Regular users will only see documents they own or have access to through collections. Superusers can see all documents. The documents are returned in order of last modification, with most recent first.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
ids
string

A list of document IDs to retrieve. If not provided, all documents will be returned.

​
offset
integer
default:0

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

​
limit
integer
default:100

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

​
include_summary_embeddings
boolean
default:false

Specifies whether or not to include embeddings of each document summary.

​
owner_only
boolean
default:false

If true, only returns documents owned by the user, not all accessible documents.

Response

200

​
results
object[]
​
total_entries
integer
default:0
Example:

1

⌘I