Introduction
Knowledge Graph
Search Service
Research Service
Structured Data
curl --request POST \
--url https://agents.bigdata.com/v1/research-agent \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"research_effort": "standard",
"message": "earnings analysis",
"tools_configs": {
"search": {
"query_filters": {
"entities": {
"any_of": [
{
"id": "D8442A"
},
{
"id": "4A6F00"
},
{
"id": "E09E2B"
}
]
},
"period": {
"start": "2024-10-14T22:00:00.000Z",
"end": "2025-10-14T21:59:59.999Z"
}
}
}
}
}
'[
{
"chat_id": "<string>",
"message": {
"type": "THINKING",
"role": "assistant",
"content": "<string>",
"message_id": "<string>",
"tool_name": "<string>",
"tool_arguments": {},
"error": "<string>",
"audit_traces": [
{
"query": {
"text": "<string>",
"filters": {}
},
"results": [
{
"values": [
{
"documentScope": "<string>",
"hd": "<string>",
"id": "<string>",
"language": "<string>",
"srcKey": "<string>",
"srcName": "<string>",
"ts": "<string>",
"chunks": [
{
"id": "<string>",
"cnum": 123,
"text": "<string>",
"sentences": [
{
"pnum": 123,
"snum": 123
}
],
"relevance": 123,
"boundingBoxes": [
{
"bottom": 123,
"left": 123,
"page": 123,
"right": 123,
"top": 123
}
]
}
],
"sourceRank": 10,
"contentType": "<string>",
"documentType": "<string>",
"url": "<string>",
"rpProviderId": "<string>"
}
],
"type": "CQS"
}
],
"auditType": "SearchAuditV1",
"toolId": "search_tool",
"queryId": 123
}
],
"references": [
{
"start": 123,
"end": 123,
"source": "<unknown>",
"tag": {
"tool_call_id": "<string>",
"ref_id": "<string>"
},
"action_audits_id": "<string>"
}
]
}
}
]Research Agent
Get faster insights and smarter decisions using our advanced AI capabilities and real-time data. (Beta version)
curl --request POST \
--url https://agents.bigdata.com/v1/research-agent \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"research_effort": "standard",
"message": "earnings analysis",
"tools_configs": {
"search": {
"query_filters": {
"entities": {
"any_of": [
{
"id": "D8442A"
},
{
"id": "4A6F00"
},
{
"id": "E09E2B"
}
]
},
"period": {
"start": "2024-10-14T22:00:00.000Z",
"end": "2025-10-14T21:59:59.999Z"
}
}
}
}
}
'[
{
"chat_id": "<string>",
"message": {
"type": "THINKING",
"role": "assistant",
"content": "<string>",
"message_id": "<string>",
"tool_name": "<string>",
"tool_arguments": {},
"error": "<string>",
"audit_traces": [
{
"query": {
"text": "<string>",
"filters": {}
},
"results": [
{
"values": [
{
"documentScope": "<string>",
"hd": "<string>",
"id": "<string>",
"language": "<string>",
"srcKey": "<string>",
"srcName": "<string>",
"ts": "<string>",
"chunks": [
{
"id": "<string>",
"cnum": 123,
"text": "<string>",
"sentences": [
{
"pnum": 123,
"snum": 123
}
],
"relevance": 123,
"boundingBoxes": [
{
"bottom": 123,
"left": 123,
"page": 123,
"right": 123,
"top": 123
}
]
}
],
"sourceRank": 10,
"contentType": "<string>",
"documentType": "<string>",
"url": "<string>",
"rpProviderId": "<string>"
}
],
"type": "CQS"
}
],
"auditType": "SearchAuditV1",
"toolId": "search_tool",
"queryId": 123
}
],
"references": [
{
"start": 123,
"end": 123,
"source": "<unknown>",
"tag": {
"tool_call_id": "<string>",
"ref_id": "<string>"
},
"action_audits_id": "<string>"
}
]
}
}
]Authorizations
Enter your API key
Body
Research effort level: 'lite' for quick analysis, 'standard' for comprehensive research
lite, standard The user's message/question to send to the agent
Optional runtime configurations for tools. Available tools: 'search' - configure search parameters and filters.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
positive, negative, neutral Content filter with logical operators: any_of (at least one match), all_of (all must match), none_of (none should match)
Show child attributes
Show child attributes
Array of filters where at least one must match
1Show child attributes
Show child attributes
DOCUMENT_ID, SOURCE_TYPE, DOCUMENT_TYPE, SOURCE_CATEGORY_ID 1 - 1000 elements1 - 1000 elements1- DocumentTranscriptFilter
- DocumentFilingFilter
- DocumentNewsFilter
- DocumentTranscriptPresentationFilter
- DocumentUserFileFilter
Show child attributes
Show child attributes
Document type - always TRANSCRIPT for transcript documents
TRANSCRIPT, FILING, NEWS, TRANSCRIPT-PRESENTATION, USER_FILE "TRANSCRIPT"Subtype for transcript documents
Analyst, Investor and Shareholder meeting, Earnings Call, General Conference Call, General Presentation, Guidance Call, Investor Conference Call, Sales and Revenue Call, Shareholders Meeting, Special Situation, M&A and Other 1 - 1000 elementsAvailable source category identifiers
expert_interviews, filings, my_files, news, podcasts, research, transcripts Array of filters where all must match
1Show child attributes
Show child attributes
DOCUMENT_ID, SOURCE_TYPE, DOCUMENT_TYPE, SOURCE_CATEGORY_ID 1 - 1000 elements1 - 1000 elements1- DocumentTranscriptFilter
- DocumentFilingFilter
- DocumentNewsFilter
- DocumentTranscriptPresentationFilter
- DocumentUserFileFilter
Show child attributes
Show child attributes
Document type - always TRANSCRIPT for transcript documents
TRANSCRIPT, FILING, NEWS, TRANSCRIPT-PRESENTATION, USER_FILE "TRANSCRIPT"Subtype for transcript documents
Analyst, Investor and Shareholder meeting, Earnings Call, General Conference Call, General Presentation, Guidance Call, Investor Conference Call, Sales and Revenue Call, Shareholders Meeting, Special Situation, M&A and Other 1 - 1000 elementsAvailable source category identifiers
expert_interviews, filings, my_files, news, podcasts, research, transcripts Array of filters where none should match
1Show child attributes
Show child attributes
DOCUMENT_ID, SOURCE_TYPE, DOCUMENT_TYPE, SOURCE_CATEGORY_ID 1 - 1000 elements1 - 1000 elements1- DocumentTranscriptFilter
- DocumentFilingFilter
- DocumentNewsFilter
- DocumentTranscriptPresentationFilter
- DocumentUserFileFilter
Show child attributes
Show child attributes
Document type - always TRANSCRIPT for transcript documents
TRANSCRIPT, FILING, NEWS, TRANSCRIPT-PRESENTATION, USER_FILE "TRANSCRIPT"Subtype for transcript documents
Analyst, Investor and Shareholder meeting, Earnings Call, General Conference Call, General Presentation, Guidance Call, Investor Conference Call, Sales and Revenue Call, Shareholders Meeting, Special Situation, M&A and Other 1 - 1000 elementsAvailable source category identifiers
expert_interviews, filings, my_files, news, podcasts, research, transcripts Optional chat ID to continue an existing conversation thread. If not provided, a new conversation is started.
Whether to persist the agent state in memory or in the database
enabled, disabled Response
Successful Response
The ID of the chat
Show child attributes
Show child attributes
THINKING, ACTION, ANSWER, COMPLETE, ERROR, AUDIT, GROUNDING, TOOL_ERROR, NOT_ENTITLED "assistant"Text content of the message
Unique identifier for grouping related chunks
Name of the tool being called (ACTION type only)
Arguments for tool call (ACTION type only)
Error message (ERROR type only)
Audit trace data (AUDIT type only)
Search tool audit trace that provides backward compatibility with AuditTrace while adding agent-specific type information from the library's AgentAuditTrace.
- SearchAuditV1
- MarkdownAuditV1
- BaseToolAuditTrace
Show child attributes
Show child attributes
- AuditTraceCQSResult
- AuditTraceExternalResult
- AuditTraceEngineAIResult
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"CQS""SearchAuditV1""search_tool"Grounding references (GROUNDING type only)
Show child attributes
Show child attributes
Start offset in the cumulative answer text
End offset (exclusive)
Actual source / audit object returned by the tool
Optional audit trace grouping identifier
Was this page helpful?