Deep Research
Comprehensive AI research analysis with multiple sub-queries.
Endpoint
POST /research/deep
Parameters
Parameter
Type
Required
Description
query
string
Yes
Research question or topic
orbit_entity_id
string[]
Yes
Companies to analyze (max: 5)
analysis_type
string[]
No
Types: financial, competitive, risk, esg
output_format
string
No
detailed, summary, bullet_points
include_visuals
boolean
No
Generate charts/tables (default: true)
Example Request
bash
curl -X POST "https://api.orbitfin.ai/v1/research/deep" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"query": "Analyze competitive positioning and financial health",
"orbit_entity_id": ["ent_2vxp8q3n", "ent_7kms9p2w"],
"analysis_type": ["financial", "competitive"],
"output_format": "detailed"
}'
Response
json
{
"status": "success",
"credits_used": 10.0,
"data": {
"research_id": "res_4mp9k2nx",
"executive_summary": "Comprehensive analysis reveals...",
"sections": [
{
"title": "Financial Performance Comparison",
"content": "...",
"data_tables": [],
"charts": []
}
],
"methodology": {
"sub_queries_generated": 12,
"documents_analyzed": 24,
"data_points_extracted": 156
},
"citations": [],
"generated_at": "2024-12-08T09:15:00Z"
}
}
Last updated