Skip to main content
GET
Get Session

Authentication & Scope

Requires the sessions-read ability.

Request

Path Parameters

Response

200 OK – Session with related data.
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>
read-only
name
string
extraction_template_id
string<uuid>
settings
object
status
enum<string>
read-only
Available options:
pending,
processing,
completed,
failed
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only
documents
object[]
read-only
results
object[]
read-only