Search
This namespace provides comprehensive document search capabilities across user-accessible tags. It encompasses both targeted and universal search functionalities, enabling users to efficiently locate and retrieve relevant documents based on content matching and classification criteria.
The Search namespace is designed to support flexible querying mechanisms with advanced features including fuzzy matching for approximate string searches, pagination for handling large result sets, and both tag-specific and company-wide search scopes. It integrates seamlessly with the platform's classification system to deliver contextually relevant results.
The essence of the Search namespace is to empower users with powerful discovery tools that can adapt to various search scenarios. Whether users need to find specific documents within a particular tag classification or perform broad exploratory searches across their entire accessible document corpus, this namespace provides the necessary endpoints to accomplish these tasks efficiently.
Perform a basic search within user-accessible tags
GET https://<env>.tagshelf.com/api/search/basic
Search for documents within user-accessible tags with support for tag-specific filtering, pagination, and fuzzy matching.
Headers
Content-Type*
string
application/json
Authorization
string
Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key
string
<app_api_key>
Path Parameters
query
string
The search query string to match against document content
tagId
string
Specific tag ID to search within. If not provided, searches across all accessible tags
tagName
string
Tag name to search within (alternative to tagId). Case-insensitive
page
integer
Page number for pagination (1-based). Default: 1
pageSize
integer
Number of results per page. Default: 50, Maximum recommended: 100
fuzzy
boolean
Enable fuzzy matching for approximate string matching. Default: false
{
"result": [
{
"file_id": "d2bd5c6f-cd2a-490b-b93b-ee843ceba9ea",
"job_id": "44f9423e-f36b-1410-8c10-0092b3381c4b",
"channel": "web",
"user_name": "[email protected]",
"length": 576.0,
"tag_name": "Factura Fiscal",
"tag_score": 0.95,
"tag_source": "Alfred",
"classifier": "zero",
"creation_date": "2025-06-04T09:17:17.8Z",
"update_date": "2025-06-04T09:23:16.703Z",
"tag_id": "61b5433e-f36b-1410-8c0f-0092b3381c4b",
"data_points": [
{
"name": "InvoiceNumber",
"value": "RMP002-26",
"value_as_string": "RMP002-26",
"data_type": "String"
},
{
"name": "InvoiceDate",
"value": "2025-02-24T00:00:00",
"value_as_string": "2025-02-24T00:00:00.0000000",
"data_type": "DateTime"
},
{
"name": "InvoiceTotal",
"value": 260000.0,
"value_as_string": "260000.00",
"data_type": "Decimal"
}
]
},
{
"file_id": "d595fc17-e5b2-45c1-8fcd-0463b0aee014",
"job_id": "36fb423e-f36b-1410-8c10-0092b3381c4b",
"channel": "web",
"user_name": "[email protected]",
"length": 576.0,
"tag_name": "Factura Fiscal",
"tag_score": 0.95,
"tag_source": "Alfred",
"classifier": "zero",
"creation_date": "2025-06-04T09:36:37.753Z",
"update_date": "2025-06-04T09:47:33.73Z",
"tag_id": "61b5433e-f36b-1410-8c0f-0092b3381c4b",
"data_points": [
{
"name": "InvoiceNumber",
"value": "RMP002-26",
"value_as_string": "RMP002-26",
"data_type": "String"
},
{
"name": "InvoiceDate",
"value": "2025-02-24T00:00:00",
"value_as_string": "2025-02-24T00:00:00.0000000",
"data_type": "DateTime"
},
{
"name": "InvoiceTotal",
"value": 260000.0,
"value_as_string": "260000.00",
"data_type": "Decimal"
}
]
}
],
"total": 2,
"is_empty": false
}Last updated
Was this helpful?