Get Session
curl --request GET \
--url https://api.raydocs.com/extractions/sessions/{sessionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.raydocs.com/extractions/sessions/{sessionId}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.raydocs.com/extractions/sessions/{sessionId}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"extraction_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settings": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"documents": [
{
"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"
}
],
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"extraction_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config_hash": "<string>",
"document_refs": [
{
"kind": "documentRef",
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": 123,
"filename": "<string>",
"mime": "<string>",
"size": 123,
"sha256": "<string>",
"source": {
"url": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z"
}
],
"data": {},
"audit_data": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}Extraction Sessions
Get Session
Get session details including documents and results.
GET
/
extractions
/
sessions
/
{sessionId}
Get Session
curl --request GET \
--url https://api.raydocs.com/extractions/sessions/{sessionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.raydocs.com/extractions/sessions/{sessionId}"
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}', 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}",
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}"
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}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.raydocs.com/extractions/sessions/{sessionId}")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"extraction_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"settings": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"documents": [
{
"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"
}
],
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"extraction_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"config_hash": "<string>",
"document_refs": [
{
"kind": "documentRef",
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": 123,
"filename": "<string>",
"mime": "<string>",
"size": 123,
"sha256": "<string>",
"source": {
"url": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z"
}
],
"data": {},
"audit_data": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}Authentication & Scope
Requires thesessions-read ability.
Request
GET /extractions/sessions/770e8400-e29b-41d4-a716-446655440000 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 with related data.
{
"id": "770e8400-e29b-41d4-a716-446655440000",
"name": "Q1 2024 Invoices",
"extraction_template_id": "550e8400-e29b-41d4-a716-446655440000",
"settings": {},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"documents": [
{
"id": "880e8400-e29b-41d4-a716-446655440000",
"filename": "invoice_001.pdf",
"status": "ready",
"meta": {
"page_count": 2
}
}
],
"results": [
{
"id": "990e8400-e29b-41d4-a716-446655440000",
"status": "completed",
"title": "Invoice #12345"
}
]
}
404 Not Found – Session does not exist or you don’t have access.Authorizations
Path Parameters
Response
Successful
Available options:
pending, processing, completed, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
