Search Documents

Search by semantic query, exact document attributes, or both.

POST /api/v1/documents/search

Search Documents

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/documents/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "<string>",
  "filters": {
    "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "page_id": "<string>",
    "title": "<string>",
    "status": "<string>",
    "default_language": "<string>",
    "doc_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {}
  },
  "limit": 5,
  "include_content": false
}
'

200

{
  "mode": "semantic",
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "is_internal": true,
      "excerpt": "<string>",
      "object": "document",
      "page_id": "<string>",
      "status": "<string>",
      "public_display": true,
      "default_language": "en",
      "source_id": "<string>",
      "source_name": "<string>",
      "parent_id": "<string>",
      "position": 0,
      "created_at": "<string>",
      "updated_at": "<string>",
      "metadata": "<unknown>",
      "doc_type_id": "<string>",
      "url": "<string>",
      "score": 123,
      "content": "<string>"
    }
  ],
  "has_more": true,
  "object": "search_result"
}

Authorizations

X-API-Key · string · header · required

Body

application/json

query · string | null

Semantic search query. Omit for exact filters only.

Maximum string length: 8000

filters · DocumentSearchFilters · object

Exact attribute filters, combined with AND. Use source_id (from list_sources) to search one source.

Show child attributes

limit · integer · default: 5

Maximum number of documents to return.

Required range: 1 <= x <= 100

include_content · boolean · default: false

Return each document's full content instead of an excerpt.

Response

200 - application/json

OK

mode · enum<string> · required

Available options: semantic, exact

data · DocumentSearchHit · object[] · required

Show child attributes

has_more · boolean · required

object · string · default: search_result