DeepDive Parameters
Complete parameter reference for AI-powered research and analysis
AI Research Platform
Core Research Parameters
Essential Research Configuration
Parameter | Type | Required | Description |
---|---|---|---|
research_query | string | Required | The main research question or topic to investigate. Should be specific and well-defined. Example: |
sources | array | Optional | Types of sources to include in the research analysis. Example: |
analysis_depth | string | Optional | Depth of AI analysis to perform on the collected data. Example: |
max_sources | integer | Optional | Maximum number of sources to analyze for the research. Example: |
timeframe | string | Optional | Time period to focus the research on (affects source selection). Example: |
language | string | Optional | Primary language for source analysis and response generation. Example: |
geographic_focus | array | Optional | Geographic regions to prioritize in the research. Example: |
Analysis Configuration
AI Analysis Settings
Parameter | Type | Required | Description |
---|---|---|---|
analysis_type | string | Optional | Specific type of analysis to perform on the research data. Example: |
entities | array | Optional | Specific entities (companies, people, products) to focus the analysis on. Example: |
focus_areas | array | Optional | Specific aspects or topics to emphasize in the analysis. Example: |
include_sentiment | boolean | Optional | Perform sentiment analysis on sources and entities. Example: |
include_trends | boolean | Optional | Identify and analyze trends in the research domain. Example: |
confidence_threshold | float | Optional | Minimum confidence score for including insights in results. Example: |
cross_reference | boolean | Optional | Cross-reference findings across multiple sources for validation. Example: |
Output Configuration
Response Format & Export Options
Parameter | Type | Required | Description |
---|---|---|---|
generate_summary | boolean | Optional | Generate an executive summary of the research findings. Example: |
include_citations | boolean | Optional | Include properly formatted citations for all analyzed sources. Example: |
citation_format | string | Optional | Format style for generated citations. Example: |
generate_recommendations | boolean | Optional | Generate actionable recommendations based on findings. Example: |
include_methodology | boolean | Optional | Include detailed methodology explanation in the response. Example: |
export_format | string | Optional | Additional export format for the research report. Example: |
visualization_data | boolean | Optional | Include structured data for creating charts and visualizations. Example: |
Available Source Types
Credit Consumption
Response Format
DeepDive Response Fields
Field | Type | Description |
---|---|---|
executive_summary | string | AI-generated executive summary of all research findings. Example: |
key_insights | array | Array of key insights with confidence scores and supporting evidence. Example: |
entity_analysis | object | Detailed analysis for each specified entity (if entities parameter used). Example: |
trend_analysis | array | Identified trends with direction, confidence, and timeframe (if include_trends=true). Example: |
sources_analyzed | array | Complete list of sources with metadata, relevance scores, and analysis notes. Example: |
citations | array | Properly formatted citations in the requested citation format. Example: |
recommendations | array | AI-generated actionable recommendations (if generate_recommendations=true). Example: |
methodology | object | Detailed explanation of research methodology used (if include_methodology=true). Example: |
visualization_data | object | Structured data for creating charts and graphs (if visualization_data=true). Example: |
export_url | string | Download URL for exported report (if export_format specified). Example: |
processing_time | float | Total time taken to complete the research analysis in seconds. Example: |
credits_used | integer | Number of API credits consumed by this research request. Example: |
Example Requests
Basic Research Request
Simple research with standard analysis depth and common source types:
Basic DeepDive Research
curl -X POST https://www.searchhive.dev/api/v1/deepdive \
-H "Authorization": "Bearer: sk_live_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"research_query": "Benefits of electric vehicles for urban transportation",
"sources": ["academic", "news", "industry_reports"],
"max_sources": 15,
"analysis_depth": "standard"
}'
Comprehensive Analysis Request
Full-featured research with all analysis options and export capabilities:
Comprehensive DeepDive Analysis
Analysis Type Reference
Compare entities across multiple dimensions and identify competitive advantages.
- • entities (array)
- • focus_areas (array)
Analyze market conditions, trends, and opportunities in a specific industry.
- • industry_reports
- • financial
- • news
Systematic review of academic literature with citation analysis and research gaps.
- • Citation networks
- • Research methodology analysis
- • Gap identification
Parameter Best Practices
Use specific, focused questions rather than broad topics.
Choose source types that align with your research objectives.
Use 'quick' for exploratory research, 'comprehensive' for final analysis.
Limit entities to 5-10 for focused competitive analysis.
Vague research questions produce unfocused results.
Single source types can create biased analysis.
Analyzing 10+ entities dilutes focus and increases costs.
Outdated sources can skew analysis for current topics.