Skip to main content
POST
/
v1
/
research-agent
Research Agent
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": {
      "chat_id": "EPH-12345-683279",
      "message": {
        "content": "I need to search for the latest news about Nvidia...",
        "message_id": "thinking_123",
        "role": "assistant",
        "type": "THINKING"
      }
    }
  }
]

Authorizations

​
X-API-Key
string
header
required

Enter your API key

Body

application/json
​
research_effort
enum<string>
required

Research effort level: 'lite' for quick analysis, 'standard' for comprehensive research

Available options:
lite,
standard
​
message
string
required

The user's message/question to send to the agent

​
tools_configs
object | null

Optional runtime configurations for tools. Available tools: 'search' - configure search parameters and filters.

​
chatId
string | null

Optional chat ID to continue an existing conversation thread. If not provided, a new conversation is started.

​
persistenceMode
enum<string>

Whether to persist the agent state in memory or in the database

Available options:
enabled,
disabled

Response

200 - application/json

Successful Response

​
chat_id
string
required

The ID of the chat

​
message
object
required
Examples:
{
  "chat_id": "EPH-12345-683279",
  "message": {
    "content": "I need to search for the latest news about Nvidia...",
    "message_id": "thinking_123",
    "role": "assistant",
    "type": "THINKING"
  }
}
{
  "chat_id": "EPH-12345-683279",
  "message": {
    "message_id": "action_456",
    "role": "assistant",
    "tool_arguments": {
      "query": "Nvidia AI chip developments 2024"
    },
    "tool_name": "search",
    "type": "ACTION"
  }
}
{
  "chat_id": "EPH-12345-683279",
  "message": {
    "content": "Based on my research, here's what I found about Nvidia's latest AI chip developments...",
    "message_id": "answer_789",
    "role": "assistant",
    "type": "ANSWER"
  }
}
⌘I