Filter Talonic Documents
talonic_filterFilter documents by extracted field values using conditions like equals, contains, or date comparisons. Combine multiple filters for precise results.
Instructions
Filter the user's Talonic documents by extracted field values using composable conditions. Conditions accept either a canonical field name (e.g. 'vendor.name', 'policy.0_coverage_type') or a field UUID. The Talonic API resolves names to ids server-side.
USE WHEN:
The user wants documents matching specific structured criteria, like 'invoices over 1000 EUR' or 'contracts expiring before 2026-12-31' or 'COIs from Acme'.
The query is value-based on extracted fields, not a free-text concept search.
You need to retrieve a sortable, paginated list filtered by field conditions.
DO NOT USE WHEN:
The user wants conceptual / free-text search across content (use talonic_search).
The user is looking for a single document by id (use talonic_get_document).
The user wants extracted data from a new document (use talonic_extract).
OPERATORS:
eq, neq: equality / inequality
gt, gte, lt, lte: numeric or date comparisons
between: requires both
valueandvalue_tocontains: substring match on string fields
is_empty: presence check (no value needed)
is_not_empty: presence check (no value needed). Note: currently underreports; use
eq/gt/containsetc. against a known value when possible.
TIPS:
To discover available field names, call talonic_search first with a related query. fields[].canonicalName from the response is what to pass as
fieldhere.Both
field(name) andfield_id(UUID) reach the API asfieldId. Either is fine.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| conditions | Yes | One or more filter conditions, AND-ed together. | |
| search | No | Optional free-text search applied alongside the filters. | |
| sort | No | Optional sort by a field. | |
| page | No | Page number for pagination. | |
| limit | No | Results per page. Default 50 server-side. | |
| source_connection_id | No | Optionally scope to a specific source connection. |