Retrieve a document

Retrieves detailed information about a specific document by its ID.

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

Retrieve a Document

cURL

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

import requests

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

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/documents/{id}', 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/documents/{id}",
  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/documents/{id}"

	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/documents/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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,
    "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

application/json

200

results · object

Show child attributes