Create Session - Raydocs

Authentication & Scope

Requires the sessions-write ability.

Request

POST /extractions/sessions HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Q1 2024 Invoices",
  "extraction_template_id": "550e8400-e29b-41d4-a716-446655440000"
}

Body Parameters

Parameter	Type	Required	Description
`name`	string	No	Session name
`extraction_template_id`	uuid	Yes	Template to use for extraction

Response

201 Created – The newly created session.

{
  "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": [],
  "results": []
}

After creating a session, add documents using the Create Document endpoint.