List Session Documents
curl --request GET \
--url https://api.raydocs.com/extractions/sessions/{sessionId}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.raydocs.com/extractions/sessions/{sessionId}/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.raydocs.com/extractions/sessions/{sessionId}/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.raydocs.com/extractions/sessions/{sessionId}/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.raydocs.com/extractions/sessions/{sessionId}/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.raydocs.com/extractions/sessions/{sessionId}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.raydocs.com/extractions/sessions/{sessionId}/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{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": 123,
"filename": "<string>",
"mime": "<string>",
"size": 123,
"sha256": "<string>",
"source_url": "<string>",
"parsings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config_hash": "<string>",
"parser_version": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 123,
"last_page": 123,
"per_page": 123,
"total": 123
}
}Extraction Sessions
List Session Documents
List all workspace documents attached to an extraction session.
GET
/
extractions
/
sessions
/
{sessionId}
/
documents
List Session Documents
curl --request GET \
--url https://api.raydocs.com/extractions/sessions/{sessionId}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.raydocs.com/extractions/sessions/{sessionId}/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.raydocs.com/extractions/sessions/{sessionId}/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.raydocs.com/extractions/sessions/{sessionId}/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.raydocs.com/extractions/sessions/{sessionId}/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.raydocs.com/extractions/sessions/{sessionId}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.raydocs.com/extractions/sessions/{sessionId}/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{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": 123,
"filename": "<string>",
"mime": "<string>",
"size": 123,
"sha256": "<string>",
"source_url": "<string>",
"parsings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config_hash": "<string>",
"parser_version": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"current_page": 123,
"last_page": 123,
"per_page": 123,
"total": 123
}
}List all workspace-scoped documents attached to an extraction session.
Authentication & Scope
Requires thesessions-read ability.
Request
GET /extractions/sessions/{sessionId}/documents HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
sessionId | uuid | Yes | The session ID |
Response
200 OK – Session document list.
{
"data": [
{
"id": "880e8400-e29b-41d4-a716-446655440000",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000",
"filename": "invoice_001.pdf",
"sha256": "6de7f6f5894c9f3fd1f6f8a4d1b3115d0d9b4b19d7a8a661f9fe90f9c2d80c3b",
"status": "processed",
"source": {
"type": "upload"
},
"meta": {
"page_count": 2,
"file_size": 125000
},
"created_at": "2024-01-15T10:30:00Z"
},
{
"id": "880e8400-e29b-41d4-a716-446655440001",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000",
"filename": "invoice_002.pdf",
"sha256": "bcf478e0af3f2aa34ad3f6c20d43d9e7ab332cd0ab471f6b4ea1986d8f97d5ab",
"status": "processing",
"source": {
"type": "upload"
},
"meta": {},
"created_at": "2024-01-15T10:35:00Z"
}
]
}
The same document can appear in multiple sessions. Session membership is managed through an attachment relation, not document ownership.
Document Status Values
| Status | Description |
|---|---|
uploaded | Document uploaded, awaiting processing |
processing | Document is being parsed and chunked |
processed | Document processed and ready for extraction |
failed | Processing failed |
Authorizations
Path Parameters
Query Parameters
⌘I
