Skip to main content
POST
/
extractions
/
sessions
/
{sessionId}
/
results
Run Extraction
curl --request POST \
  --url https://api.raydocs.com/extractions/sessions/{sessionId}/results \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "job_id": "<string>"
}

​
Authentication & Scope

Requires the sessions-write ability.

​
Request

POST /extractions/sessions/770e8400-e29b-41d4-a716-446655440000/results HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeRequiredDescription
sessionIduuidYesThe session ID

​
Response

201 Created – Extraction started. 
{
  "id": "990e8400-e29b-41d4-a716-446655440000",
  "extraction_session_id": "770e8400-e29b-41d4-a716-446655440000",
  "status": "pending",
  "title": null,
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": null
}
Extraction runs asynchronously. Poll the Get Result endpoint to check status and retrieve data when complete.
422 Unprocessable Entity – No documents in session or documents not ready.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
sessionId
string<uuid>
required

Response

Extraction started

​
message
string
​
job_id
string