Skip to main content
POST
/
v1
/
search
Search documents
curl --request POST \
  --url https://api.bigdata.com/v1/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "search_mode": "fast",
  "query": {
    "text": "Microsoft earnings call highlights",
    "filters": {
      "timestamp": {
        "start": "2025-01-01T14:15:22Z",
        "end": "2025-08-11T14:15:22Z"
      },
      "topic": {
        "any_of": [
          "business,partnerships,partnership"
        ]
      },
      "document_type": {
        "mode": "INCLUDE",
        "values": [
          "NEWS"
        ]
      },
      "entity": {
        "all_of": [],
        "any_of": [
          "81660B",
          "C379FA",
          "94A3FB"
        ],
        "none_of": []
      },
      "tag": {
        "any_of": [
          "research-report",
          "any-tag"
        ]
      },
      "category": {
        "mode": "INCLUDE",
        "values": [
          "expert_interviews",
          "news",
          "research"
        ]
      }
    },
    "ranking_params": {
      "source_boost": 10,
      "freshness_boost": 1,
      "reranker": {
        "enabled": false,
        "threshold": 0.8
      }
    },
    "max_chunks": 100
  }
}
'
{
  "results": [
    {
      "id": "57BB2AD919....",
      "headline": "Headline example: Microsoft Corp.: Q3 2025 Earnings Call",
      "timestamp": "2025-04-30T21:30:00Z",
      "source": {
        "id": "D4B903",
        "name": "Factset Transcripts",
        "rank": "RANK_1"
      },
      "url": "https://www.benzinga.com/node/45117886?utm_campaign=partner_feed&utm_medium=feed&utm_source=ravenpack",
      "chunks": [
        {
          "cnum": 7,
          "text": "Microsoft will provide forward-looking guidance on its earnings conference call Wednesday, which can be viewed below.\nMSFT Price Action: Microsoft stock is up 5.5% to $417.17 year-over-year in after-hours trading Wednesday versus a 52-week trading range of $344.79 to $468.35.",
          "relevance": 0.8949412447701082,
          "sentiment": 0.33,
          "detections": [
            {
              "id": "ACE54B",
              "start": 23,
              "end": 38,
              "type": "entity"
            }
          ]
        }
      ],
      "document_type": "Earnings Call"
    }
  ],
  "metadata": {
    "request_id": "user_2k3Z4SerTUIieyCfQhGR5UF2Af3",
    "timestamp": "2025-09-12T11:10:46.019077+00:00"
  },
  "usage": {
    "api_query_units": 0.7
  }
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
query
object
required
​
search_mode
enum<string>
default:fast

Determines how the search query is processed.

fast (default): Runs a single query against the vector DB using the specified filters. Best for pre-processed queries where you control the filters.

smart: Analyzes the query text to automatically define advanced search filters and runs multiple sub-queries to ensure better coverage. Ideal for sending user questions directly without pre-processing. Has higher latency than fast mode. When using smart mode, only timestamp and source filters are allowed; using any other filters will result in a 400 Bad Request error.

Available options:
fast,
smart

Response

200 - application/json

Search results

​
results
object[]
required

Array of documents with one or more text chunks that match the query criteria.

​
metadata
object

Request metadata and timing information.

​
usage
object

API usage information for the request.