Skip to main content
GET
/
workspaces
/
{workspaceId}
/
extractions
/
templates
List Templates
curl --request GET \
  --url https://api.raydocs.com/workspaces/{workspaceId}/extractions/templates \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "current_page": 123,
    "last_page": 123,
    "per_page": 123,
    "total": 123
  }
}

Authentication & Scope

Requires the templates-read ability.

Request

GET /workspaces/1/extractions/templates HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdintegerYesThe workspace ID

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number for pagination

Response

200 OK – Paginated list of templates.
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Invoice Extraction",
      "description": "Extract invoice details",
      "workspace_id": 1,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1
  }
}

Authorizations

Authorization
string
header
required

Personal Access Token

Path Parameters

workspaceId
integer
required

Query Parameters

page
integer
default:1

Response

Successful

data
object[]
meta
object