Skip to main content
GET
/
extract
/
documents
/
{document_id}
Get Document
curl --request GET \
  --url https://api.contextual.ai/v1/extract/documents/{document_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.contextual.ai/v1/extract/documents/{document_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.contextual.ai/v1/extract/documents/{document_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.contextual.ai/v1/extract/documents/{document_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.contextual.ai/v1/extract/documents/{document_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.contextual.ai/v1/extract/documents/{document_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.contextual.ai/v1/extract/documents/{document_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
{
  "document_id": "<string>",
  "file_name": "<string>",
  "file_size": 123,
  "page_count": 123,
  "uploaded_at": "<string>",
  "status": "<string>",
  "signed_url": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

document_id
string
required

Response

Successful Response

Response model for document information.

document_id
string
required

Unique ID of the document

file_name
string
required

Original filename

file_size
integer
required

File size in bytes

page_count
integer
required

Number of pages in the document

uploaded_at
string
required

Timestamp when the document was uploaded

status
string
required

Document status

signed_url
string | null

Presigned download URL for the document (valid for 1 hour). Only available for GCS and S3 storage backends.