Skip to main content
POST
/
extractions
/
sessions
Create Session
curl --request POST \
  --url https://api.raydocs.com/extractions/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "extraction_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Q1 2024 Invoices"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "extraction_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settings": {},
  "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>",
      "source_url": "<string>",
      "parsings": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "config_hash": "<string>",
          "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",
      "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 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

ParameterTypeRequiredDescription
namestringNoSession name
extraction_template_iduuidYesTemplate 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.

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.

Body

application/json
​
extraction_template_id
string<uuid>
required
​
name
string
Example:

"Q1 2024 Invoices"

Response

Created

​
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