Skip to main content
GET
/
extractions
/
results
/
{resultId}
Get Result
curl --request GET \
  --url https://api.raydocs.com/extractions/results/{resultId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "extraction_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "created",
  "config_hash": "<string>",
  "document_refs": [
    {
      "kind": "documentRef",
      "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspaceId": 123,
      "filename": "<string>",
      "mime": "<string>",
      "size": 123,
      "sha256": "<string>",
      "source": {
        "type": "upload",
        "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-read ability.

Request

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

Path Parameters

ParameterTypeRequiredDescription
resultIduuidYesThe result ID

Response

200 OK – Result with extracted data and audit trail.
{
  "id": "990e8400-e29b-41d4-a716-446655440000",
  "extraction_session_id": "770e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "config_hash": "cfg_9eeae65063f17f55",
  "document_refs": [
    {
      "kind": "documentRef",
      "documentId": "880e8400-e29b-41d4-a716-446655440000",
      "workspaceId": "660e8400-e29b-41d4-a716-446655440000",
      "filename": "invoice.pdf",
      "sha256": "6de7f6f5894c9f3fd1f6f8a4d1b3115d0d9b4b19d7a8a661f9fe90f9c2d80c3b"
    }
  ],
  "title": "Invoice #INV-2024-001",
  "data": {
    "invoice_details": {
      "invoice_number": "INV-2024-001",
      "date": "2024-01-15",
      "total_amount": 8800
    }
  },
  "audit_data": {
    "invoice_details": {
      "invoice_number": {
        "reasoning": "Found invoice number in header section, formatted as 'Invoice Number: INV-2024-001'",
        "sources": [
          {
            "chunk_id": "aa0e8400-e29b-41d4-a716-446655440000",
            "text": "Invoice Number: INV-2024-001",
            "page": 1
          }
        ]
      },
      "total_amount": {
        "reasoning": "Calculated from subtotal $8,000 plus 10% tax ($800) = $8,800",
        "sources": [
          {
            "chunk_id": "aa0e8400-e29b-41d4-a716-446655440001",
            "text": "Total: $8,800",
            "page": 2
          }
        ]
      }
    }
  },
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:32:00Z"
}

Response Structure

PropertyDescription
document_refsDocument snapshot used as run inputs
config_hashParsing/extraction config fingerprint used for cacheability and re-runs
dataClean extracted values organized by group
audit_dataReasoning and source references for each field
The audit_data is only populated when reasoning_enabled: true in the template config.
404 Not Found – Result does not exist or you don’t have access.

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

resultId
string<uuid>
required

Response

Successful

id
string<uuid>
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>
updated_at
string<date-time>