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>'
{
  "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 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 run started. 
{
  "id": "990e8400-e29b-41d4-a716-446655440000",
  "extraction_session_id": "770e8400-e29b-41d4-a716-446655440000",
  "status": "created",
  "config_hash": "9eeae65063f17f552f4f95fe8c23d0aa8b697f91df5e8dd4a7214be4d6a7aa62",
  "document_refs": [
    {
      "kind": "documentRef",
      "documentId": "880e8400-e29b-41d4-a716-446655440000",
      "workspaceId": "660e8400-e29b-41d4-a716-446655440000",
      "sha256": "6de7f6f5894c9f3fd1f6f8a4d1b3115d0d9b4b19d7a8a661f9fe90f9c2d80c3b",
      "filename": "invoice.pdf"
    }
  ],
  "title": null,
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": null
}
201 Created - Extraction run created in deferred mode while parsing completes. 
{
  "id": "990e8400-e29b-41d4-a716-446655440001",
  "extraction_session_id": "770e8400-e29b-41d4-a716-446655440000",
  "status": "parsing_pending",
  "config_hash": "9eeae65063f17f552f4f95fe8c23d0aa8b697f91df5e8dd4a7214be4d6a7aa62",
  "audit_data": {
    "_pending_manual_run": {
      "pending_document_ids": [
        "880e8400-e29b-41d4-a716-446655440000"
      ]
    }
  },
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": null
}
Each ExtractionSessionResult represents one run snapshot for the documents attached to the session at trigger time. The output is aggregated across those documents. 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 created from the Raydocs dashboard. Include in the Authorization header: Bearer <your_token> See API Keys for token creation and management.

Path Parameters

​
sessionId
string<uuid>
required

Response

Extraction run created

​
id
string<uuid>
read-only
​
extraction_session_id
string<uuid>
​
status
enum<string>
Available options:
created,
parsing_pending,
processing,
completed,
failed
​
config_hash
string | null
​
document_refs
object[]
​
data
object

Extracted data matching the template schema

​
audit_data
object

Verification/reasoning traces and run audit payload

​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only