Search

Performs a search on a specific index using Elasticsearch’s Query DSL.

Search documents using Elasticsearch query

post

Search documents within a specific Elasticsearch index for an agent using a raw Elasticsearch query. The query will be automatically filtered by agentId for data isolation.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

indexNamestringRequired

The name of the Elasticsearch index to search in.

Body

application/json

sizeinteger · max: 10000Optional

Number of results to return

Default: 10

fromintegerOptional

Number of results to skip for pagination

Default: 0

Other propertiesanyOptional

Responses

200

Successful Response

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/v1/agents/{agentId}/search/{indexName}

HTTPcURLJavaScriptPython

POST /v1/agents/{agentId}/search/{indexName} HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "query": {
    "match": {
      "firstName": "John"
    }
  },
  "size": 10,
  "from": 0,
  "sort": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "aggs": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "highlight": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "hits": [
    {
      "id": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "pagination": {
    "total": 1,
    "size": 1,
    "hasMore": true
  },
  "performance": {
    "took": 1,
    "timedOut": true
  },
  "aggregations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}