Skip to main content
GET
/
extractions
/
sessions
/
{sessionId}
/
documents
List Session Documents
curl --request GET \
  --url https://api.raydocs.com/extractions/sessions/{sessionId}/documents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "filename": "<string>",
      "mime_type": "<string>",
      "size": 123,
      "status": "pending",
      "extraction_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 123,
    "last_page": 123,
    "per_page": 123,
    "total": 123
  }
}
List all documents in an extraction session.

​
Authentication & Scope

Requires the sessions-read ability.

​
Request

GET /extractions/sessions/{sessionId}/documents HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeRequiredDescription
sessionIduuidYesThe session ID

​
Response

200 OK – Array of documents. 
[
  {
    "id": "880e8400-e29b-41d4-a716-446655440000",
    "filename": "invoice_001.pdf",
    "status": "ready",
    "extraction_session_id": "770e8400-e29b-41d4-a716-446655440000",
    "meta": {
      "page_count": 2,
      "file_size": 125000
    },
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": "880e8400-e29b-41d4-a716-446655440001",
    "filename": "invoice_002.pdf",
    "status": "processing",
    "extraction_session_id": "770e8400-e29b-41d4-a716-446655440000",
    "meta": {},
    "created_at": "2024-01-15T10:35:00Z"
  }
]

​
Document Status Values

StatusDescription
uploadedDocument uploaded, awaiting processing
processingDocument is being parsed and chunked
readyDocument processed and ready for extraction
failedProcessing failed

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
sessionId
string<uuid>
required

Query Parameters

​
page
integer
default:1

Response

Successful

​
data
object[]
​
meta
object