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": "Type a question to retrieve documents chunks"
  }
}
'
{
  "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"
            }
          ],
          "text_locations": [
            {
              "paragraph_num": 1,
              "sentence_num": 1
            }
          ]
        }
      ],
      "document_type": "Earnings Call"
    }
  ],
  "external_results": {},
  "metadata": {
    "request_id": "user_2k3Z4SerTUIieyCfQhGR5UF2Af3",
    "timestamp": "2025-09-12T11:10:46.019077+00:00",
    "audit": {
      "queries": [
        {
          "auto_enrich_filters": true,
          "filters": {
            "document_type": {
              "mode": "INCLUDE",
              "values": [
                {
                  "type": "TRANSCRIPT",
                  "subtypes": [
                    "EARNINGS_CALL"
                  ]
                }
              ]
            },
            "reporting_entities": [
              "BA9E0C"
            ],
            "reporting_periods": [
              {
                "fiscal_year": 2025,
                "fiscal_quarter": 4
              }
            ]
          },
          "max_chunks": 100,
          "ranking_params": {
            "source_boost": 1,
            "freshness_boost": 1,
            "reranker": {
              "enabled": true
            }
          }
        }
      ]
    }
  },
  "usage": {
    "api_query_units": 0.7
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bigdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
search_mode
enum<string>
required

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

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

Click here for a more detailed comparison

Available options:
fast,
smart
​
query
object
required
​
include_audit
boolean

When set to true, the response metadata will include an audit object containing the resolved queries that were actually executed. Useful for debugging and understanding how the system interpreted your request.

Response

200 - application/json

Search results

​
results
object[]
required

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

​
external_results
object

External search results grouped by source (e.g. web).

​
metadata
object

Request metadata and timing information.

​
usage
object

API usage information for the request.