Skip to main content
GET
/
extractions
/
documents
/
{documentId}
Get Document
curl --request GET \
  --url https://api.raydocs.com/extractions/documents/{documentId} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

​
Authentication & Scope

Requires the sessions-read ability.

​
Request

GET /extractions/documents/880e8400-e29b-41d4-a716-446655440000 HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeRequiredDescription
documentIduuidYesThe document ID

​
Response

200 OK – Document details. 
{
  "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"
}
404 Not Found – Document does not exist or you don’t have access.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
documentId
string<uuid>
required

Response

Successful

​
id
string<uuid>
​
filename
string
​
mime_type
string
​
size
integer

File size in bytes

​
status
enum<string>
Available options:
pending,
parsing,
parsed,
failed
​
extraction_session_id
string<uuid>
​
created_at
string<date-time>