Skip to main content
GET
/
extractions
/
sessions
/
{sessionId}
Get Session
curl --request GET \
  --url https://api.raydocs.com/extractions/sessions/{sessionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "extraction_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settings": {},
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspace_id": 123,
      "filename": "<string>",
      "mime": "<string>",
      "size": 123,
      "sha256": "<string>",
      "status": "uploaded",
      "source_type": "upload",
      "source_url": "<string>",
      "parsings": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "config_hash": "<string>",
          "status": "queued",
          "parser_version": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "results": [
    {
      "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/sessions/770e8400-e29b-41d4-a716-446655440000 HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeRequiredDescription
sessionIduuidYesThe session ID

​
Response

200 OK – Session with related data. 
{
  "id": "770e8400-e29b-41d4-a716-446655440000",
  "name": "Q1 2024 Invoices",
  "extraction_template_id": "550e8400-e29b-41d4-a716-446655440000",
  "settings": {},
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "documents": [
    {
      "id": "880e8400-e29b-41d4-a716-446655440000",
      "filename": "invoice_001.pdf",
      "status": "ready",
      "meta": {
        "page_count": 2
      }
    }
  ],
  "results": [
    {
      "id": "990e8400-e29b-41d4-a716-446655440000",
      "status": "completed",
      "title": "Invoice #12345"
    }
  ]
}
404 Not Found – Session 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

​
sessionId
string<uuid>
required

Response

Successful

​
id
string<uuid>
​
name
string
​
extraction_template_id
string<uuid>
​
settings
object
​
status
enum<string>
Available options:
pending,
processing,
completed,
failed
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
documents
object[]
​
results
object[]