Skip to main content
GET
/
api
/
r2r
/
v3
/
documents
/
{id}
Retrieve a Document
curl --request GET \
  --url https://api.intelligence.io.solutions/api/r2r/v3/documents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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,
    "chunks": [
      {
        "key": "value"
      }
    ]
  }
}
This endpoint returns the document’s metadata, status, and system information. It does not return the document’s content - use the /documents/{id}/download endpoint for that. Users can only retrieve documents they own or have access to through collections. Superusers can retrieve any document.

Authorizations

​
Authorization
string
header
required

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

Headers

​
token
string

JWT token

​
Authorization
string

io.net provided API Key

​
x-api-key
string

API key set by an SDK client

Path Parameters

​
id
string
required

Document ID

Response

200

​
results
object