rossum-mcp 0.3.5

MCP server for AI-powered Rossum orchestration: document workflows, debug pipelines automatically, and configure intelligent document processing through natural language.

Rossum MCP Server

A Model Context Protocol (MCP) server that provides tools for uploading documents and retrieving annotations using the Rossum API. Built with Python and the official rossum-api.

[!NOTE] This is not an official Rossum project. It is a community-developed integration built on top of the Rossum API.

[!WARNING] This project is in early stage development. Breaking changes to both implementation and agent behavior are expected.

Features

Document Processing

• upload_document: Upload a document to Rossum for processing
• get_annotation: Retrieve annotation data for a previously uploaded document
• list_annotations: List all annotations for a queue with optional filtering
• start_annotation: Start annotation to move it to 'reviewing' status
• bulk_update_annotation_fields: Bulk update annotation field values using JSON Patch operations
• confirm_annotation: Confirm annotation to move it to 'confirmed' status

Queue & Schema Management

• get_queue: Retrieve queue details including schema_id
• list_queues: List all queues with optional filtering by workspace or name
• get_schema: Retrieve schema details and content
• list_schemas: List all schemas with optional filtering by name or queue
• get_schema_tree_structure: Get lightweight tree view of schema with only ids, labels, categories, and types
• get_queue_schema: Retrieve complete schema for a queue in a single call
• get_queue_engine: Retrieve engine information for a queue
• create_queue: Create a new queue with schema and optional engine assignment
• create_schema: Create a new schema with sections and datapoints
• update_queue: Update queue settings including automation thresholds
• update_schema: Update schema with field-level automation thresholds
• patch_schema: Add, update, or remove individual schema nodes without replacing entire content
• prune_schema_fields: Efficiently remove multiple fields from schema at once (for organization setup)

Workspace Management

• get_workspace: Retrieve workspace details by ID
• list_workspaces: List all workspaces with optional filtering
• create_workspace: Create a new workspace

User Management

• get_user: Retrieve user details by ID
• list_users: List users with optional filtering by username, email, etc.
• list_user_roles: List all user roles (permission groups) in the organization

Engine Management

• get_engine: Retrieve engine details by ID
• list_engines: List all engines with optional filters
• create_engine: Create a new engine (extractor or splitter)
• update_engine: Update engine settings including learning and training queues
• create_engine_field: Create engine fields and link them to schemas
• get_engine_fields: Retrieve engine fields for a specific engine or all engine fields

Extensions & Rules

• get_hook: Get hook/extension details
• list_hooks: List webhooks and serverless functions (extensions)
• create_hook: Create webhooks or serverless function hooks for custom logic
• update_hook: Update existing hook properties (name, queues, config, events, settings)
• list_hook_templates: List available hook templates from Rossum Store
• create_hook_from_template: Create a hook from a Rossum Store template
• list_hook_logs: List hook execution logs for debugging and monitoring
• get_rule: Get business rule details
• list_rules: List business rules with trigger conditions and actions

Email Templates

• get_email_template: Retrieve email template details by ID
• list_email_templates: List email templates with optional filtering by queue, type, or name
• create_email_template: Create email templates for automated or manual email sending

Relations Management

• get_relation: Retrieve relation details by ID
• list_relations: List all relations between annotations (edit, attachment, duplicate)
• get_document_relation: Retrieve document relation details by ID
• list_document_relations: List all document relations (export, einvoice)

Prerequisites

• Python 3.12 or higher
• Rossum account with API credentials
• A Rossum queue ID

Installation

Docker (Recommended)

git clone https://github.com/stancld/rossum-mcp.git
cd rossum-mcp

# Set up environment variables
export ROSSUM_API_TOKEN="your-api-token"
export ROSSUM_API_BASE_URL="https://api.elis.rossum.ai/v1"
export ROSSUM_MCP_MODE="read-write"  # Optional: "read-only" or "read-write" (default)

# Run the MCP server
docker-compose up rossum-agent

Install from source (alternative)

git clone https://github.com/stancld/rossum-mcp.git
cd rossum-mcp/rossum-mcp
uv sync

Install with extras:

uv sync --extra all  # All extras (docs, tests)
uv sync --extra docs  # Documentation only
uv sync --extra tests  # Testing only

Environment Variables

• ROSSUM_API_TOKEN (required): Your Rossum API authentication token
• ROSSUM_API_BASE_URL (required): Base URL for the Rossum API
• ROSSUM_MCP_MODE (optional): Controls which tools are available
  • read-write (default): All tools available (GET, LIST, CREATE, UPDATE operations)
  • read-only: Only read operations available (GET and LIST operations only)

Read-Only vs Read-Write Mode

When ROSSUM_MCP_MODE is set to read-only, only read operations are available:

• Annotations: get_annotation, list_annotations
• Queues: get_queue, list_queues, get_queue_schema, get_queue_engine
• Schemas: get_schema, list_schemas
• Engines: get_engine, list_engines, get_engine_fields
• Hooks: get_hook, list_hooks, list_hook_templates, list_hook_logs
• Email Templates: get_email_template, list_email_templates
• Users: get_user, list_users, list_user_roles
• Rules: get_rule, list_rules
• Relations: get_relation, list_relations
• Document Relations: get_document_relation, list_document_relations
• Workspaces: get_workspace, list_workspaces

All CREATE, UPDATE, and UPLOAD operations are disabled in read-only mode for security purposes.

Usage

Running the MCP Server

Start the server using:

python server.py

Or using the installed script:

rossum-mcp

Claude Desktop Configuration

Configure your MCP client to use this server. In Claude Desktop's config:

Read-write mode:

{
  "mcpServers": {
    "rossum": {
      "command": "python",
      "args": ["/path/to/rossum-mcp/rossum-mcp/rossum_mcp/server.py"],
      "env": {
        "ROSSUM_API_TOKEN": "your-api-token",
        "ROSSUM_API_BASE_URL": "https://api.elis.rossum.ai/v1",
        "ROSSUM_MCP_MODE": "read-write"
      }
    }
  }
}

Read-only mode:

{
  "mcpServers": {
    "rossum-readonly": {
      "command": "python",
      "args": ["/path/to/rossum-mcp/rossum-mcp/rossum_mcp/server.py"],
      "env": {
        "ROSSUM_API_TOKEN": "your-api-token",
        "ROSSUM_API_BASE_URL": "https://api.elis.rossum.ai/v1",
        "ROSSUM_MCP_MODE": "read-only"
      }
    }
  }
}

Available Tools

Document Processing

upload_document

Uploads a document to Rossum for processing. Returns a task ID. Use list_annotations to get the annotation ID.

Parameters:

• file_path (string, required): Absolute path to the document file
• queue_id (integer, required): Rossum queue ID where the document should be uploaded

Returns:

{
  "task_id": "12345",
  "task_status": "created",
  "queue_id": 12345,
  "message": "Document upload initiated. Use `list_annotations` to find the annotation ID for this queue."
}

get_annotation

Retrieves annotation data for a previously uploaded document. Use this to check the status of a document.

Parameters:

• annotation_id (integer, required): The annotation ID obtained from list_annotations
• sideloads (array, optional): List of sideloads to include. Use ['content'] to fetch annotation content with datapoints

Returns:

{
  "id": "12345",
  "status": "to_review",
  "url": "https://elis.rossum.ai/api/v1/annotations/12345",
  "schema": "67890",
  "modifier": "11111",
  "document": "22222",
  "content": [...],
  "created_at": "2024-01-01T00:00:00Z",
  "modified_at": "2024-01-01T00:00:00Z"
}

list_annotations

Lists all annotations for a queue with optional filtering. Useful for checking the status of multiple uploaded documents.

Parameters:

• queue_id (integer, required): Rossum queue ID to list annotations from
• status (string, optional): Filter by annotation status (default: 'importing,to_review,confirmed,exported')

Returns:

{
  "count": 42,
  "results": [
    {
      "id": "12345",
      "status": "to_review",
      "url": "https://elis.rossum.ai/api/v1/annotations/12345",
      "document": "67890",
      "created_at": "2024-01-01T00:00:00Z",
      "modified_at": "2024-01-01T00:00:00Z"
    }
  ]
}

start_annotation

Starts an annotation to move it from 'importing' to 'reviewing' status. This is required before you can update annotation fields.

Parameters:

• annotation_id (integer, required): Rossum annotation ID to start

Returns:

{
  "annotation_id": 12345,
  "message": "Annotation 12345 started successfully. Status changed to 'reviewing'."
}

bulk_update_annotation_fields

Bulk update annotation field values using JSON Patch operations. This is the correct way to update annotation field values. Must be called after start_annotation.

Parameters:

• annotation_id (integer, required): Rossum annotation ID to update
• operations (array, required): List of JSON Patch operations with format:

  [
    {
      "op": "replace",
      "id": 1234,
      "value": {
        "content": {
          "value": "new_value",
          "page": 1,
          "position": [x, y, w, h]
        }
      }
    }
  ]
  

Important: Use the numeric datapoint id from annotation.content, NOT the schema_id.

Returns:

{
  "annotation_id": 12345,
  "operations_count": 1,
  "message": "Annotation 12345 updated with 1 operations successfully."
}

confirm_annotation

Confirms an annotation to move it to 'confirmed' status. Can be called after bulk_update_annotation_fields.

Parameters:

• annotation_id (integer, required): Rossum annotation ID to confirm

Returns:

{
  "annotation_id": 12345,
  "message": "Annotation 12345 confirmed successfully. Status changed to 'confirmed'."
}

Queue & Schema Management

get_queue

Retrieves queue details including the schema_id.

Parameters:

• queue_id (integer, required): Rossum queue ID to retrieve

list_queues

Lists all queues with optional filtering by workspace or name.

Parameters:

• workspace_id (integer, optional): Filter by workspace ID
• name (string, optional): Filter by queue name

Returns:

[
  {
    "id": 12345,
    "name": "Invoice Processing",
    "url": "https://elis.rossum.ai/api/v1/queues/12345",
    "workspace": "https://elis.rossum.ai/api/v1/workspaces/100",
    "schema": "https://elis.rossum.ai/api/v1/schemas/200",
    "inbox": "https://elis.rossum.ai/api/v1/inboxes/300",
    "status": "active",
    "locale": "en_GB",
    "automation_enabled": true
  }
]

Example usage:

# List all queues
all_queues = list_queues()

# List queues in a specific workspace
workspace_queues = list_queues(workspace_id=100)

# List queues by name
named_queues = list_queues(name="Invoice Processing")

# Combine filters
filtered_queues = list_queues(workspace_id=100, name="Invoice")

get_schema

Retrieves schema details including the schema content/structure.

Parameters:

• schema_id (integer, required): Rossum schema ID to retrieve

list_schemas

Lists all schemas with optional filtering by name or queue.

Parameters:

• name (string, optional): Filter by schema name
• queue_id (integer, optional): Filter by queue ID

Returns:

[
  {
    "id": 12345,
    "name": "Invoice Schema",
    "url": "https://elis.rossum.ai/api/v1/schemas/12345",
    "queues": ["https://elis.rossum.ai/api/v1/queues/100"],
    "content": "<omitted>",
    "metadata": {},
    "modified_at": "2025-01-15T10:00:00Z"
  }
]

Example usage:

# List all schemas
all_schemas = list_schemas()

# List schemas by name
named_schemas = list_schemas(name="Invoice Schema")

# List schemas used by a specific queue
queue_schemas = list_schemas(queue_id=100)

# Combine filters
filtered_schemas = list_schemas(name="Invoice", queue_id=100)

get_queue_schema

Retrieves the complete schema for a queue in a single call. This is the recommended way to get a queue's schema.

Parameters:

• queue_id (integer, required): Rossum queue ID

get_queue_engine

Retrieves the complete engine information for a given queue in a single call.

Parameters:

• queue_id (integer, required): Rossum queue ID

create_queue

Creates a new queue with schema and optional engine assignment.

Parameters:

• name (string, required): Name of the queue to create
• workspace_id (integer, required): Workspace ID where the queue should be created
• schema_id (integer, required): Schema ID to assign to the queue
• engine_id (integer, optional): Optional engine ID to assign for document processing
• Additional optional parameters for automation, locale, training, etc.

update_queue

Updates an existing queue's settings including automation thresholds.

Parameters:

• queue_id (integer, required): Queue ID to update
• queue_data (object, required): Dictionary containing queue fields to update

create_schema

Creates a new schema with sections and datapoints.

Parameters:

• name (string, required): Schema name
• content (array, required): Schema content array containing sections with datapoints. Must follow Rossum schema structure with sections containing children.

Example content structure:

[
  {
    "category": "section",
    "id": "document_info",
    "label": "Document Information",
    "children": [
      {
        "category": "datapoint",
        "id": "document_type",
        "label": "Document Type",
        "type": "enum",
        "rir_field_names": [],
        "constraints": {"required": false},
        "options": [
          {"value": "invoice", "label": "Invoice"},
          {"value": "receipt", "label": "Receipt"}
        ]
      }
    ]
  }
]

Returns:

{
  "id": 12345,
  "name": "My Schema",
  "url": "https://elis.rossum.ai/api/v1/schemas/12345",
  "content": [...],
  "message": "Schema 'My Schema' created successfully with ID 12345"
}

update_schema

Updates an existing schema, typically used to set field-level automation thresholds.

Parameters:

• schema_id (integer, required): Schema ID to update
• schema_data (object, required): Dictionary containing schema fields to update

patch_schema

Patch a schema by adding, updating, or removing individual nodes without replacing the entire content. This is particularly useful for making incremental changes to schemas.

Parameters:

• schema_id (integer, required): Schema ID to patch
• operation (string, required): One of "add", "update", or "remove"
• node_id (string, required): ID of the node to operate on
• node_data (object, optional): Data for add/update operations. Required for "add" and "update"
• parent_id (string, optional): Parent node ID for add operation. Required for "add"
• position (integer, optional): Position for add operation (appends if not specified)

Operations:

• add: Add a new datapoint/multivalue to a parent (section or tuple). Requires parent_id and node_data.
• update: Update properties of an existing node. Requires node_data with fields to update.
• remove: Remove a node from the schema. Only node_id is required.

Returns:

{
  "id": 123,
  "name": "Invoice Schema",
  "content": [
    {
      "id": "header_section",
      "label": "Header",
      "category": "section",
      "children": [
        {"id": "invoice_number", "label": "Invoice Number", "category": "datapoint"},
        {"id": "vendor_name", "label": "Vendor Name", "category": "datapoint"}
      ]
    }
  ]
}

Example usage:

# Add a new datapoint to a section
patch_schema(
    schema_id=123,
    operation="add",
    node_id="vendor_name",
    parent_id="header_section",
    node_data={"label": "Vendor Name", "type": "string", "category": "datapoint"}
)

# Update a field's label and threshold
patch_schema(
    schema_id=123,
    operation="update",
    node_id="invoice_number",
    node_data={"label": "Invoice #", "score_threshold": 0.9}
)

# Remove a field
patch_schema(
    schema_id=123,
    operation="remove",
    node_id="old_field"
)

Engine Management

get_engine

Retrieves detailed information about a specific engine by its ID.

Parameters:

• engine_id (integer, required): Engine ID to retrieve

Returns:

{
  "id": 12345,
  "name": "Invoice Extractor",
  "url": "https://elis.rossum.ai/api/v1/engines/12345",
  "type": "extractor",
  "learning_enabled": true,
  "training_queues": ["https://elis.rossum.ai/api/v1/queues/100", "https://elis.rossum.ai/api/v1/queues/200"],
  "description": "Extracts invoice data",
  "agenda_id": "agenda-123",
  "organization": "https://elis.rossum.ai/api/v1/organizations/10",
  "message": "Engine 'Invoice Extractor' (ID 12345) retrieved successfully"
}

Example usage:

# Get engine details
engine = get_engine(engine_id=12345)

list_engines

Lists all engines with optional filtering.

Parameters:

• id (integer, optional): Filter by engine ID
• engine_type (string, optional): Filter by engine type ('extractor' or 'splitter')
• agenda_id (string, optional): Filter by agenda ID

Returns:

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "name": "My Engine",
      "url": "https://elis.rossum.ai/api/v1/engines/12345",
      "type": "extractor",
      "learning_enabled": true,
      "training_queues": ["https://elis.rossum.ai/api/v1/queues/100"],
      "description": "Engine description",
      "agenda_id": "abc123",
      "organization": "https://elis.rossum.ai/api/v1/organizations/123"
    }
  ],
  "message": "Retrieved 2 engine(s)"
}

Example usage:

# List all engines
all_engines = list_engines()

# List specific engine by ID
engine = list_engines(id=12345)

# List extractors only
extractors = list_engines(engine_type="extractor")

# List engines by agenda
agenda_engines = list_engines(agenda_id="abc123")

create_engine

Creates a new engine for document processing.

Parameters:

• name (string, required): Engine name
• organization_id (integer, required): Organization ID where the engine should be created
• engine_type (string, required): Engine type - either 'extractor' or 'splitter'

Returns:

{
  "id": 12345,
  "name": "My Engine",
  "url": "https://elis.rossum.ai/api/v1/engines/12345",
  "type": "extractor",
  "organization": "https://elis.rossum.ai/api/v1/organizations/123",
  "message": "Engine 'My Engine' created successfully with ID 12345"
}

update_engine

Updates an existing engine's settings including learning and training queues.

Parameters:

• engine_id (integer, required): Engine ID to update
• engine_data (object, required): Dictionary containing engine fields to update
  • name (string): Engine name
  • description (string): Engine description
  • learning_enabled (boolean): Enable/disable learning
  • training_queues (array): List of queue URLs for training

Example:

{
  "learning_enabled": true,
  "training_queues": [
    "https://elis.rossum.ai/api/v1/queues/12345",
    "https://elis.rossum.ai/api/v1/queues/67890"
  ]
}

Returns:

{
  "id": 12345,
  "name": "My Engine",
  "url": "https://elis.rossum.ai/api/v1/engines/12345",
  "type": "extractor",
  "learning_enabled": true,
  "training_queues": [...],
  "description": "Engine description",
  "message": "Engine 'My Engine' (ID 12345) updated successfully"
}

get_hook

Retrieves details of a specific hook/extension by its ID.

Parameters:

• hook_id (integer, required): Hook ID

Returns:

{
  "id": 12345,
  "name": "Validation Hook",
  "url": "https://elis.rossum.ai/api/v1/hooks/12345",
  "type": "webhook",
  "active": true,
  "queues": ["https://elis.rossum.ai/api/v1/queues/100"],
  "events": ["annotation_status", "annotation_content"],
  "config": {
    "url": "https://example.com/webhook",
    "secret": "***"
  },
  "settings": {},
  "extension_source": "rossum_store"
}

Example usage:

# Get hook details
hook = get_hook(hook_id=12345)

list_hooks

Lists all hooks/extensions configured in your organization. Hooks (also called extensions) are webhooks or serverless functions that respond to Rossum events.

Parameters:

• queue_id (integer, optional): Filter hooks by queue ID
• active (boolean, optional): Filter by active status (true for active hooks, false for inactive)

Returns:

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "name": "Validation Hook",
      "url": "https://elis.rossum.ai/api/v1/hooks/12345",
      "type": "webhook",
      "active": true,
      "queues": ["https://elis.rossum.ai/api/v1/queues/100"],
      "events": ["annotation_status", "annotation_content"],
      "config": {
        "url": "https://example.com/webhook",
        "secret": "***"
      },
      "extension_source": "rossum_store"
    }
  ]
}

Example usage:

# List all hooks
all_hooks = list_hooks()

# List hooks for a specific queue
queue_hooks = list_hooks(queue_id=12345)

# List only active hooks
active_hooks = list_hooks(active=True)

# List inactive hooks for a queue
inactive_queue_hooks = list_hooks(queue_id=12345, active=False)

create_hook

Creates a new hook (webhook or serverless function). Hooks respond to Rossum events and can be used for custom validation, data enrichment, or integration with external systems.

Parameters:

• name (string, required): Hook name
• type (string, required): Hook type - either 'webhook' or 'function'
• queues (array, optional): List of queue URLs to attach the hook to. If not provided, hook applies to all queues
  • Format: ["https://api.elis.rossum.ai/v1/queues/12345"]
• events (array, optional): List of events that trigger the hook. Common events:
  • annotation_content.initialize - When annotation is first created
  • annotation_content.confirm - When annotation is confirmed
  • annotation_content.export - When annotation is exported
  • annotation_status - When annotation status changes
  • annotation_content - When annotation content changes
  • datapoint_value - When individual field value changes
• config (object, optional): Hook configuration
  • For webhook: {"url": "https://example.com/webhook"}
  • For function: {"runtime": "python3.12", "function": "import json\ndef rossum_hook_request_handler(payload):\n return {}"}
• settings (object, optional): Specific settings included in the payload when executing the hook
• secret (string, optional): Secret key for securing webhook requests

Returns:

{
  "id": 12345,
  "name": "My Hook",
  "url": "https://elis.rossum.ai/api/v1/hooks/12345",
  "enabled": true,
  "queues": ["https://elis.rossum.ai/api/v1/queues/100"],
  "events": ["annotation_content.initialize"],
  "config": {"runtime": "python3.12", "function": "..."},
  "settings": {"custom_key": "custom_value"},
  "message": "Hook 'My Hook' created successfully with ID 12345"
}

Example usage:

# Create a serverless function hook
create_hook(
    name="Splitting & Sorting",
    type="function",
    queues=["https://api.elis.rossum.ai/v1/queues/12345"],
    events=["annotation_content.initialize", "annotation_content.confirm"],
    config={"runtime": "python3.12", "function": "import json\ndef rossum_hook_request_handler(payload):\n    return {}"},
    settings={"sorting_queues": {"A": 1, "B": 2}}
)

# Create a webhook hook
create_hook(
    name="External Validation",
    type="webhook",
    queues=["https://api.elis.rossum.ai/v1/queues/12345"],
    events=["annotation_content.confirm"],
    config={"url": "https://example.com/validate"},
    secret="webhook_secret_123"
)

update_hook

Updates an existing hook. Use this to modify hook properties like name, queues, config, events, or settings. Only provide the fields you want to change - other fields will remain unchanged.

Parameters:

• hook_id (integer, required): The ID of the hook to update
• name (string, optional): New hook name
• queues (array, optional): New list of queue URLs
• events (array, optional): New list of events that trigger the hook
• config (object, optional): New hook configuration
• settings (object, optional): New hook settings
• active (boolean, optional): Enable or disable the hook

Returns:

{
  "id": 12345,
  "name": "Updated Hook Name",
  "url": "https://elis.rossum.ai/api/v1/hooks/12345",
  "active": true,
  "queues": ["https://elis.rossum.ai/api/v1/queues/100"],
  "events": ["annotation_content.initialize", "annotation_content.confirm"],
  "config": {"runtime": "python3.12", "function": "..."},
  "settings": {"updated_key": "updated_value"}
}

Example usage:

# Update hook name and add a new event
update_hook(
    hook_id=12345,
    name="Renamed Hook",
    events=["annotation_content.initialize", "annotation_content.confirm"]
)

# Disable a hook
update_hook(hook_id=12345, active=False)

# Update hook settings
update_hook(hook_id=12345, settings={"new_setting": "value"})

list_hook_templates

Lists available hook templates from Rossum Store. Hook templates provide pre-built extension configurations (e.g., data validation, field mapping, notifications) that can be used to quickly create hooks instead of writing code from scratch.

Parameters: None

Returns:

[
  {
    "id": 5,
    "url": "https://elis.rossum.ai/api/v1/hook_templates/5",
    "name": "Document Splitting",
    "description": "Automatically split multi-page documents into separate annotations",
    "type": "function",
    "events": ["annotation_content.initialize"],
    "config": {"runtime": "python3.12", "function": "..."},
    "settings_schema": {"type": "object", "properties": {...}},
    "guide": "https://knowledge-base.rossum.ai/docs/..."
  }
]

Example usage:

# List all available hook templates
templates = list_hook_templates()

# Find a template by name
for template in templates:
    if "splitting" in template.name.lower():
        print(f"Found: {template.name} (ID: {template.id})")

create_hook_from_template

Creates a hook from a Rossum Store template. Use list_hook_templates first to find available templates and their IDs. This is the recommended way to create hooks as it uses battle-tested configurations from the Rossum Store.

Parameters:

• name (string, required): Name for the new hook
• hook_template_id (integer, required): ID of the hook template to use (from list_hook_templates)
• queues (array, required): List of queue URLs to attach the hook to
• events (array, optional): List of events to trigger the hook (overrides template defaults if provided)
• token_owner (string, optional): User URL for token ownership. Required when the hook template has use_token_owner=True. Use list_users to find the user URL by username.

Important: If the hook template has use_token_owner=True, you must provide the token_owner parameter with a valid user URL. Ask the user for their username and use list_users to find the correct user URL.

Returns:

{
  "id": 12345,
  "name": "My Document Splitting Hook",
  "url": "https://elis.rossum.ai/api/v1/hooks/12345",
  "hook_template": "https://elis.rossum.ai/api/v1/hook_templates/5",
  "type": "function",
  "queues": ["https://elis.rossum.ai/api/v1/queues/100"],
  "events": ["annotation_content.initialize"],
  "config": {...},
  "settings": {...}
}

Example usage:

# Create a hook from template
create_hook_from_template(
    name="Invoice Splitting",
    hook_template_id=5,
    queues=["https://api.elis.rossum.ai/v1/queues/12345"],
    settings={"split_by": "barcode", "target_queue": 67890}
)

# Create a hook with token_owner (for templates with use_token_owner=True)
create_hook_from_template(
    name="Data Export Hook",
    hook_template_id=17,
    queues=["https://api.elis.rossum.ai/v1/queues/12345"],
    token_owner="https://api.elis.rossum.ai/v1/users/456"
)

list_hook_logs

Lists hook execution logs for debugging, monitoring performance, and troubleshooting errors. Logs are retained for 7 days and at most 100 logs are returned per call.

Parameters:

• hook_id (integer, optional): Filter by hook ID
• queue_id (integer, optional): Filter by queue ID
• annotation_id (integer, optional): Filter by annotation ID
• email_id (integer, optional): Filter by email ID
• log_level (string, optional): Filter by log level - 'INFO', 'ERROR', or 'WARNING'
• status (string, optional): Filter by execution status
• status_code (integer, optional): Filter by HTTP status code
• request_id (string, optional): Filter by request ID
• timestamp_before (string, optional): ISO 8601 timestamp, filter logs triggered before this time
• timestamp_after (string, optional): ISO 8601 timestamp, filter logs triggered after this time
• start_before (string, optional): ISO 8601 timestamp, filter logs started before this time
• start_after (string, optional): ISO 8601 timestamp, filter logs started after this time
• end_before (string, optional): ISO 8601 timestamp, filter logs ended before this time
• end_after (string, optional): ISO 8601 timestamp, filter logs ended after this time
• search (string, optional): Full-text search across log messages
• page_size (integer, optional): Number of results per page (default 100, max 100)

Returns:

{
  "count": 2,
  "results": [
    {
      "log_level": "INFO",
      "action": "initialize",
      "event": "annotation_content",
      "request_id": "abc123",
      "organization_id": 100,
      "hook_id": 12345,
      "hook_type": "function",
      "queue_id": 200,
      "annotation_id": 300,
      "message": "Hook executed successfully",
      "start": "2024-01-01T00:00:00Z",
      "end": "2024-01-01T00:00:01Z",
      "status": "success",
      "status_code": 200,
      "timestamp": "2024-01-01T00:00:00Z",
      "uuid": "uuid-here"
    }
  ]
}

Example usage:

# List all logs for a specific hook
logs = list_hook_logs(hook_id=12345)

# List error logs only
error_logs = list_hook_logs(log_level="ERROR")

# List logs for a specific annotation
annotation_logs = list_hook_logs(annotation_id=300)

# Search logs by message content
search_logs = list_hook_logs(search="validation failed")

# List logs from the last hour
from datetime import datetime, timedelta
one_hour_ago = (datetime.utcnow() - timedelta(hours=1)).isoformat() + "Z"
recent_logs = list_hook_logs(timestamp_after=one_hour_ago)

create_engine_field

Creates a new engine field and links it to schemas. Engine fields define what data the engine extracts and must be created for each field in the schema when setting up an engine.

Parameters:

• engine_id (integer, required): Engine ID to which this field belongs
• name (string, required): Field name (slug format, max 50 chars)
• label (string, required): Human-readable label (max 100 chars)
• field_type (string, required): Field type - 'string', 'number', 'date', or 'enum'
• schema_ids (array, required): List of schema IDs to link this engine field to (at least one required)
• tabular (boolean, optional): Whether this field is in a table (default: false)
• multiline (string, optional): Multiline setting - 'true', 'false', or '' (default: 'false')
• subtype (string, optional): Optional field subtype (max 50 chars)
• pre_trained_field_id (string, optional): Optional pre-trained field ID (max 50 chars)

Returns:

{
  "id": 12345,
  "name": "invoice_number",
  "label": "Invoice Number",
  "url": "https://elis.rossum.ai/api/v1/engine_fields/12345",
  "type": "string",
  "engine": "https://elis.rossum.ai/api/v1/engines/123",
  "tabular": false,
  "multiline": "false",
  "schema_ids": [456, 789],
  "message": "Engine field 'Invoice Number' created successfully with ID 12345 and linked to 2 schema(s)"
}

get_engine_fields

Retrieves engine fields for a specific engine or all engine fields.

Parameters:

• engine_id (integer, optional): Engine ID to filter fields by. If not provided, retrieves all engine fields.

Returns:

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "url": "https://elis.rossum.ai/api/v1/engine_fields/12345",
      "engine": "https://elis.rossum.ai/api/v1/engines/123",
      "name": "invoice_number",
      "label": "Invoice Number",
      "type": "string",
      "subtype": null,
      "tabular": false,
      "multiline": "false",
      "pre_trained_field_id": null,
      "schemas": ["https://elis.rossum.ai/api/v1/schemas/456"]
    },
    {
      "id": 12346,
      "url": "https://elis.rossum.ai/api/v1/engine_fields/12346",
      "engine": "https://elis.rossum.ai/api/v1/engines/123",
      "name": "invoice_date",
      "label": "Invoice Date",
      "type": "date",
      "subtype": null,
      "tabular": false,
      "multiline": "false",
      "pre_trained_field_id": null,
      "schemas": ["https://elis.rossum.ai/api/v1/schemas/456"]
    }
  ]
}

Example usage:

# Get all engine fields for a specific engine
engine_fields = get_engine_fields(engine_id=123)

# Get all engine fields
all_fields = get_engine_fields()

User Management

get_user

Retrieves a single user by ID. Use list_users first to find users by username or email.

Parameters:

• user_id (integer, required): The user ID to retrieve

Returns:

{
  "id": 12345,
  "url": "https://elis.rossum.ai/api/v1/users/12345",
  "username": "[e-mail]",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[e-mail]",
  "organization": "https://elis.rossum.ai/api/v1/organizations/100",
  "is_active": true,
  "date_joined": "2024-01-01T00:00:00Z",
  "last_login": "2024-01-15T10:30:00Z"
}

list_users

Lists users in the organization. Use this to find a user's URL when you need it for token_owner in create_hook_from_template.

Parameters:

• username (string, optional): Filter by exact username
• email (string, optional): Filter by email address
• first_name (string, optional): Filter by first name
• last_name (string, optional): Filter by last name
• is_active (boolean, optional): Filter by active status
• is_organization_group_admin (boolean, optional): Filter by organization group admin role. Use false to exclude admin users (e.g., when finding users for token_owner)

Returns:

[
  {
    "id": 12345,
    "url": "https://elis.rossum.ai/api/v1/users/12345",
    "username": "[e-mail]",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[e-mail]",
    "organization": "https://elis.rossum.ai/api/v1/organizations/100",
    "is_active": true
  }
]

Example usage:

# Find user by username to get their URL for token_owner
users = list_users(username="[e-mail]")
if users:
    user_url = users[0].url
    # Use user_url in create_hook_from_template

# Find non-admin users suitable for token_owner
non_admin_users = list_users(is_organization_group_admin=False)

list_user_roles

Lists all user roles (groups of permissions) in the organization. Useful for understanding what roles are available and identifying users with specific permissions.

Parameters: None

Returns:

[
  {
    "id": 12345,
    "url": "https://elis.rossum.ai/api/v1/groups/12345",
    "name": "admin",
    "organization": "https://elis.rossum.ai/api/v1/organizations/100"
  },
  {
    "id": 12346,
    "url": "https://elis.rossum.ai/api/v1/groups/12346",
    "name": "annotator",
    "organization": "https://elis.rossum.ai/api/v1/organizations/100"
  }
]

Example usage:

# List all available roles
roles = list_user_roles()

Rules Management

get_rule

Retrieves details of a specific business rule by its ID.

Parameters:

• rule_id (integer, required): Rule ID

Returns:

{
  "id": 12345,
  "name": "Auto-calculate Total",
  "url": "https://elis.rossum.ai/api/v1/rules/12345",
  "enabled": true,
  "organization": "https://elis.rossum.ai/api/v1/organizations/100",
  "schema": "https://elis.rossum.ai/api/v1/schemas/200",
  "trigger_condition": "field.amount_total.changed",
  "created_by": "https://elis.rossum.ai/api/v1/users/300",
  "created_at": "2024-01-01T00:00:00Z",
  "modified_by": "https://elis.rossum.ai/api/v1/users/300",
  "modified_at": "2024-01-01T00:00:00Z",
  "rule_template": null,
  "synchronized_from_template": false,
  "actions": [
    {
      "id": 54321,
      "type": "set_datapoint_value",
      "payload": {
        "datapoint_id": "tax_amount",
        "value": "field.amount_total.value * 0.2"
      },
      "event": "trigger",
      "enabled": true
    }
  ]
}

Example usage:

# Get rule details
rule = get_rule(rule_id=12345)

list_rules

Lists all business rules configured in your organization. Rules define custom business logic with trigger conditions (TxScript formulas) and actions that execute when conditions are met.

Parameters:

• schema_id (integer, optional): Filter rules by schema ID
• organization_id (integer, optional): Filter rules by organization ID
• enabled (boolean, optional): Filter by enabled status (true for enabled rules, false for disabled)

Returns:

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "name": "Auto-calculate Total",
      "url": "https://elis.rossum.ai/api/v1/rules/12345",
      "enabled": true,
      "organization": "https://elis.rossum.ai/api/v1/organizations/100",
      "schema": "https://elis.rossum.ai/api/v1/schemas/200",
      "trigger_condition": "field.amount_total.changed",
      "created_by": "https://elis.rossum.ai/api/v1/users/300",
      "created_at": "2024-01-01T00:00:00Z",
      "modified_by": "https://elis.rossum.ai/api/v1/users/300",
      "modified_at": "2024-01-01T00:00:00Z",
      "rule_template": null,
      "synchronized_from_template": false,
      "actions": [
        {
          "id": 54321,
          "type": "set_datapoint_value",
          "payload": {
            "datapoint_id": "tax_amount",
            "value": "field.amount_total.value * 0.2"
          },
          "event": "trigger",
          "enabled": true
        }
      ]
    }
  ]
}

Example usage:

# List all rules
all_rules = list_rules()

# List rules for a specific schema
schema_rules = list_rules(schema_id=12345)

# List only enabled rules
enabled_rules = list_rules(enabled=True)

# List enabled rules for a specific organization
org_enabled_rules = list_rules(organization_id=100, enabled=True)

Relations Management

get_relation

Retrieves details of a specific relation by its ID. Relations introduce common relations between annotations.

Parameters:

• relation_id (integer, required): Relation ID

Returns:

{
  "id": 12345,
  "type": "duplicate",
  "key": "abc123def456",
  "parent": "https://elis.rossum.ai/api/v1/annotations/100",
  "annotations": [
    "https://elis.rossum.ai/api/v1/annotations/100",
    "https://elis.rossum.ai/api/v1/annotations/101"
  ],
  "url": "https://elis.rossum.ai/api/v1/relations/12345"
}

Example usage:

# Get relation details
relation = get_relation(relation_id=12345)

list_relations

Lists all relations between annotations with optional filters. Relations introduce common relations between annotations:

• edit: Created after editing annotation in user interface (rotation or split of the document)
• attachment: One or more documents are attachments to another document
• duplicate: Created after importing the same document that already exists in Rossum

Parameters:

• id (integer, optional): Filter by relation ID
• type (string, optional): Filter by relation type ('edit', 'attachment', 'duplicate')
• parent (integer, optional): Filter by parent annotation ID
• key (string, optional): Filter by relation key
• annotation (integer, optional): Filter by annotation ID

Returns:

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "type": "duplicate",
      "key": "abc123def456",
      "parent": "https://elis.rossum.ai/api/v1/annotations/100",
      "annotations": [
        "https://elis.rossum.ai/api/v1/annotations/100",
        "https://elis.rossum.ai/api/v1/annotations/101"
      ],
      "url": "https://elis.rossum.ai/api/v1/relations/12345"
    },
    {
      "id": 12346,
      "type": "edit",
      "key": null,
      "parent": "https://elis.rossum.ai/api/v1/annotations/200",
      "annotations": [
        "https://elis.rossum.ai/api/v1/annotations/201",
        "https://elis.rossum.ai/api/v1/annotations/202"
      ],
      "url": "https://elis.rossum.ai/api/v1/relations/12346"
    }
  ]
}

Example usage:

# List all relations
all_relations = list_relations()

# List duplicate relations
duplicate_relations = list_relations(type="duplicate")

# List relations for a specific parent annotation
parent_relations = list_relations(parent=12345)

# List relations containing a specific annotation
annotation_relations = list_relations(annotation=12345)

get_document_relation

Retrieves details of a specific document relation by its ID. Document relations introduce additional relations between annotations and documents.

Parameters:

• document_relation_id (integer, required): Document relation ID

Returns:

{
  "id": 12345,
  "type": "export",
  "annotation": "https://elis.rossum.ai/api/v1/annotations/100",
  "key": "exported_file_key",
  "documents": [
    "https://elis.rossum.ai/api/v1/documents/200",
    "https://elis.rossum.ai/api/v1/documents/201"
  ],
  "url": "https://elis.rossum.ai/api/v1/document_relations/12345"
}

Example usage:

# Get document relation details
doc_relation = get_document_relation(document_relation_id=12345)

list_document_relations

Lists all document relations with optional filters. Document relations introduce additional relations between annotations and documents:

• export: Documents generated from exporting an annotation
• einvoice: Electronic invoice documents associated with an annotation

Parameters:

• id (integer, optional): Filter by document relation ID
• type (string, optional): Filter by relation type ('export', 'einvoice')
• annotation (integer, optional): Filter by annotation ID
• key (string, optional): Filter by relation key
• documents (integer, optional): Filter by document ID

Returns:

{
  "count": 2,
  "results": [
    {
      "id": 12345,
      "type": "export",
      "annotation": "https://elis.rossum.ai/api/v1/annotations/100",
      "key": "exported_file_key",
      "documents": [
        "https://elis.rossum.ai/api/v1/documents/200",
        "https://elis.rossum.ai/api/v1/documents/201"
      ],
      "url": "https://elis.rossum.ai/api/v1/document_relations/12345"
    },
    {
      "id": 12346,
      "type": "einvoice",
      "annotation": "https://elis.rossum.ai/api/v1/annotations/102",
      "key": null,
      "documents": [
        "https://elis.rossum.ai/api/v1/documents/300"
      ],
      "url": "https://elis.rossum.ai/api/v1/document_relations/12346"
    }
  ]
}

Example usage:

# List all document relations
all_doc_relations = list_document_relations()

# List export-type document relations
export_relations = list_document_relations(type="export")

# List document relations for a specific annotation
annotation_doc_relations = list_document_relations(annotation=100)

# List document relations containing a specific document
document_relations = list_document_relations(documents=200)

Email Templates

get_email_template

Retrieves details of a specific email template by its ID.

Parameters:

• email_template_id (integer, required): Email template ID

Returns:

{
  "id": 1500,
  "name": "Rejection Email",
  "url": "https://elis.rossum.ai/api/v1/email_templates/1500",
  "queue": "https://elis.rossum.ai/api/v1/queues/8199",
  "organization": "https://elis.rossum.ai/api/v1/organizations/1",
  "subject": "Document Rejected",
  "message": "<p>Your document has been rejected.</p>",
  "type": "rejection",
  "enabled": true,
  "automate": false,
  "triggers": [],
  "to": [{"type": "annotator", "value": ""}],
  "cc": [],
  "bcc": []
}

Example usage:

# Get email template details
template = get_email_template(email_template_id=1500)

list_email_templates

Lists all email templates with optional filters. Email templates define automated or manual email responses sent from Rossum queues.

Parameters:

• queue_id (integer, optional): Filter by queue ID
• type (string, optional): Filter by template type ('rejection', 'rejection_default', 'email_with_no_processable_attachments', 'custom')
• name (string, optional): Filter by template name
• first_n (integer, optional): Limit results to first N templates

Returns:

{
  "count": 2,
  "results": [
    {
      "id": 1500,
      "name": "Rejection Email",
      "type": "rejection",
      "queue": "https://elis.rossum.ai/api/v1/queues/8199",
      "automate": false
    },
    {
      "id": 1501,
      "name": "No Attachments Notification",
      "type": "email_with_no_processable_attachments",
      "queue": "https://elis.rossum.ai/api/v1/queues/8199",
      "automate": true
    }
  ]
}

Example usage:

# List all email templates
all_templates = list_email_templates()

# List email templates for a specific queue
queue_templates = list_email_templates(queue_id=8199)

# List rejection templates
rejection_templates = list_email_templates(type="rejection")

# List first 5 templates
first_templates = list_email_templates(first_n=5)

create_email_template

Creates a new email template. Templates can be automated to send emails automatically on specific triggers, or manual for user-initiated sending.

Parameters:

• name (string, required): Name of the email template
• queue (string, required): URL of the queue to associate with
• subject (string, required): Email subject line
• message (string, required): Email body (HTML supported)
• type (string, optional): Template type - 'rejection', 'rejection_default', 'email_with_no_processable_attachments', 'custom' (default: 'custom')
• automate (boolean, optional): If true, email is sent automatically on trigger (default: false)
• to (array, optional): List of recipient objects with 'type' and 'value' keys
• cc (array, optional): List of CC recipient objects
• bcc (array, optional): List of BCC recipient objects
• triggers (array, optional): List of trigger URLs

Recipient object types:

• {"type": "annotator", "value": ""} - Send to the document annotator
• {"type": "constant", "value": "[e-mail]"} - Send to a fixed email address
• {"type": "datapoint", "value": "email_field_id"} - Send to email from a datapoint field

Returns:

{
  "id": 1502,
  "name": "Custom Notification",
  "url": "https://elis.rossum.ai/api/v1/email_templates/1502",
  "queue": "https://elis.rossum.ai/api/v1/queues/8199",
  "subject": "Document Processed",
  "message": "<p>Your document has been processed.</p>",
  "type": "custom",
  "automate": true,
  "to": [{"type": "constant", "value": "[e-mail]"}]
}

Example usage:

# Create a simple custom email template
template = create_email_template(
    name="Processing Complete",
    queue="https://elis.rossum.ai/api/v1/queues/8199",
    subject="Document Processing Complete",
    message="<p>Your document has been successfully processed.</p>"
)

# Create an automated rejection template
template = create_email_template(
    name="Auto Rejection",
    queue="https://elis.rossum.ai/api/v1/queues/8199",
    subject="Document Rejected",
    message="<p>Your document could not be processed.</p>",
    type="rejection",
    automate=True,
    to=[{"type": "annotator", "value": ""}]
)

# Create template with multiple recipients
template = create_email_template(
    name="Team Notification",
    queue="https://elis.rossum.ai/api/v1/queues/8199",
    subject="New Document",
    message="<p>A new document has arrived.</p>",
    to=[{"type": "constant", "value": "[e-mail]"}],
    cc=[{"type": "datapoint", "value": "sender_email"}]
)

Annotation Status Workflow

When a document is uploaded, the annotation progresses through various states:

1. importing - Initial state after upload. Document is being processed.
2. to_review - Extraction complete, ready for user validation.
3. reviewing - Annotation is being reviewed (triggered by start_annotation). This state is required before you can update annotation fields.
4. confirmed - The annotation has been validated and confirmed (via confirm_annotation).
5. exporting - The annotation is being exported.
6. exported - Final state for successfully processed documents.

Other possible states include: created, failed_import, split, in_workflow, rejected, failed_export, postponed, deleted, purged.

Important Notes:

• After uploading documents, agents should wait for annotations to transition from importing to to_review (or later states) before considering them fully processed.
• To update annotation field values, you must first call start_annotation to move the annotation to 'reviewing' status.
• After updating fields with bulk_update_annotation_fields, you can call confirm_annotation to move to 'confirmed' status.

Example Workflows

Single Document Upload

1. Upload a document using upload_document
2. Get the annotation ID using list_annotations
3. Check annotation status using get_annotation
4. Wait until status is to_review, confirmed, or exported

Document Upload with Field Updates

1. Upload a document using upload_document
2. Get the annotation ID using list_annotations
3. Wait until status is importing or to_review
4. Start the annotation using start_annotation (moves to 'reviewing')
5. Get annotation content using get_annotation with sideloads=['content']
6. Update field values using bulk_update_annotation_fields with datapoint IDs from content
7. Confirm the annotation using confirm_annotation (moves to 'confirmed')

Bulk Document Upload

1. Upload all documents in bulk using upload_document for each file
2. Check status of all annotations using list_annotations
3. Monitor until all documents finish processing

Create Queue with Engine

1. Create a schema using create_schema with sections and datapoints
2. Create an engine using create_engine with type 'extractor' or 'splitter'
3. Create engine fields using create_engine_field for each schema field
4. Create a queue using create_queue linking the schema and engine
5. Optionally update engine training queues using update_engine

Error Handling

The server provides detailed error messages for common issues:

• Missing API token
• File not found
• Upload failures
• API errors

License

MIT License - see LICENSE file for details

Resources

• Rossum API Documentation
• Model Context Protocol
• Rossum SDK
• Main Repository