Skip to main content
POST
/
extractions
/
templates
Create Template
curl --request POST \
  --url https://api.raydocs.com/extractions/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Invoice Extraction",
  "workspace_id": 123,
  "description": "<string>",
  "schema_json": {
    "config": {
      "reasoning_enabled": true,
      "system_message": "<string>"
    },
    "definitions": {},
    "groups": {}
  },
  "settings": {
    "parsing": {
      "contextual_embedding": false
    }
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "schema_json": {
    "config": {
      "reasoning_enabled": true,
      "system_message": "<string>"
    },
    "definitions": {},
    "groups": {}
  },
  "settings": {
    "parsing": {
      "contextual_embedding": true
    }
  },
  "workspace_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

​
Authentication & Scope

Requires the templates-write ability.

​
Request

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

{
  "name": "Invoice Extraction",
  "description": "Extract key fields from invoices",
  "workspace_id": 1,
  "schema_json": {
    "config": {
      "reasoning_enabled": true
    },
    "groups": {
      "invoice_details": {
        "search_query": "invoice number, date, amount",
        "fields": {
          "invoice_number": {
            "type": "string",
            "extraction_prompt": "Extract the invoice number"
          },
          "total_amount": {
            "type": "number",
            "extraction_prompt": "Extract the total amount"
          }
        }
      }
    }
  },
  "settings": {
    "parsing": {
      "contextual_embedding": false
    }
  }
}

​
Body Parameters

ParameterTypeRequiredDescription
namestringYesTemplate name
descriptionstringNoTemplate description
workspace_idintegerYesWorkspace to create in
schema_jsonobjectNoExtraction schema definition
settingsobjectNoParsing and processing settings
See the Extraction Schema Guide for detailed schema documentation.

​
Response

201 Created – The newly created template. 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Invoice Extraction",
  "description": "Extract key fields from invoices",
  "schema_json": { ... },
  "settings": { ... },
  "workspace_id": 1,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Personal Access Token

Body

application/json
​
name
string
required
Example:

"Invoice Extraction"

​
workspace_id
integer
required
​
description
string
​
schema_json
object

JSON schema defining extraction fields and groups

​
settings
object

Response

Created

​
id
string<uuid>
​
name
string
​
description
string
​
schema_json
object

JSON schema defining extraction fields and groups

​
settings
object
​
workspace_id
integer
​
created_at
string<date-time>
​
updated_at
string<date-time>