Skip to main content
GET
/
search
Search cases and files
curl --request GET \
  --url https://api.uk.veridox.ai/search \
  --header 'x-api-key: <api-key>'
{
  "results": [
    {
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "case_label": "<string>",
      "label": "<string>",
      "mime_type": "<string>",
      "thumbnail_url": "<string>",
      "current_risk_score": "<string>",
      "analysis_status": "waiting_for_upload",
      "analysis_outcome": "success",
      "current_analysis_phase": "<string>",
      "uploaded_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}
Perform a comprehensive search across all cases and files accessible to you. This endpoint allows you to find matching case labels and file names, providing a unified search experience for your document workflows.

​
Features

  • Prefix Matching: Search results include partial matches (e.g., “pol” matches “policy”).
  • Unified Results: Matches against both case labels and file names.
  • Flat Output: Returns a flat list of files with their parent case context for easy display.

​
Best Practices

  1. Debounce UI Searches: If implementing search-as-you-type in your frontend, debounce requests (e.g., 300ms) to avoid hitting rate limits.
  2. Specific Queries: More specific search terms yield more relevant results and improve performance.
  3. Pagination: Use limit and offset for large result sets to maintain responsive UI performance.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
query
string
required
Required string length: 1 - 100
​
limit
integer
default:50

Maximum number of results to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of results to skip for pagination

Required range: 0 <= x <= 9007199254740991

Response

Search results retrieved successfully

​
results
object[]
required
​
total
number
required