Expanded Limits, Across all tiers - Our Gift to you! Learn more →

AlterLab
SearchResearchPricingComparePlaygroundBlogDocsChangelog
    AlterLabAlterLab
    PricingComparePlaygroundBlogDocsChangelog
    IntroductionQuickstartInstallationYour First Request
    REST APICrawl APIMap APISearch APIResearch APINewSERP APINewExtract APIAIJob PollingDomain StatsNewGeocode APINewNews APIBatch ResultsNewAPI KeysSessions APINewEnterprise APIEnterprise
    AccountAutoAI VisibilityAutoAlertsAutoAuthAutoBillingAutoCrawlAutoExtractAutoIntegrationsAutoKeysAutoMapAutoMonitorsAutoOrganizationsAutoResearch SchedulesAutoRunsAutoSchedulesAutoScrapeAutoSearchAutoSearch SchedulesAutoSessionsAutoUser WebhooksAutoV1 EndpointsAutoAffiliatesAutoAgentAutoAgent OnboardingAutoAgent VisibilityAutoAnalyticsAutoApprovalsAutoArtifactsAutoAttributionAutoB2BAutoBatchAutoBeta FeaturesAutoBlogAutoBuyerAutoChatAutoConnectionsAutoConnectorsAutoContact ListsAutoCreatorAutoCross SellAutoDashboardAutoDefaultsAutoDomainsAutoEmail PreferencesAutoFcAutoHandsAutoHealthAutoJobsAutoListingsAutoMaintenanceAutoNewsAutoOauthAutoOauth GrantsAutoPage InspectAutoPlatformAutoPresetsAutoPricingAutoPrivacyAutoPublicAutoPublic PagesAutoReferralAutoReferralsAutoReportsAutoResearchAutoSecretsAutoSerpAutoSSOAutoStorefrontsAutoSupportAutoTemplatesAutoToolsAutoTrackAutoUsageAutoUsage TagsAutoUserAutoWorkflowsAutoWorkspacesAutoWebhooksAuto
    OverviewPythonNode.jsCLI
    Guides OverviewJavaScript RenderingBrowser ActionsOutput FormatsPDF & OCRCachingWebhooksJSON Schema FilteringWebSocket Real-TimeBring Your Own ProxyProSticky SessionsProAuthenticated ScrapingNewHTTP Methods & BodiesNewStructured ExtractionAIWeb SearchAgent and RAG GroundingResearch JobsAgent RunsSite MappingWeb CrawlingBatch ScrapingSchedulerData MarketplaceSelling DataAgent OnboardingEmbeddingsKeyword IdeasAI VisibilityWorkflowsChange DetectionCloud Storage ExportSpend LimitsOrganizations & TeamsScrape TemplatesCustom ConnectorsSecretsContact ListsPlatform Sub-AccountsReferrals & AffiliatesAlerts & NotificationsExtraction ProfilesAIBYOK ExtractionAIOAuth2 Machine-to-MachineSupport & TicketsUnsupported Targets
    Tutorials OverviewStructured ExtractionAIE-commerce ScrapingNews MonitoringPrice MonitoringMulti-Page CrawlingMonitoring DashboardAI Agent / MCPMCPAI Research AgentAISite CrawlingData Pipeline to Cloud
    E-commerceLead GenerationChange MonitoringRAG & AI PipelinesAIResearch
    Reference OverviewPricingRate LimitsReliabilityReliability ContractError CodesChangelogVersioning
    Migrations OverviewFrom FirecrawlFrom ApifyFrom ScrapingBee / ScraperAPIFrom Crawl4AIFrom SpiderSearch to SERPFirecrawl v0 API ReferenceLegacy
    OverviewMCP ServerAIn8n NodeLangChainAICrewAIAILlamaIndexAISupabaseChrome ExtensionSoon
    PlaygroundPricingStatus

    Up to 5,000 free requests · No credit card

    API Reference
    Auto-generated

    Research

    API reference for research endpoints.

    Auto-generated

    This page was generated from the OpenAPI spec. Runmake generate-docs to refresh after spec changes.

    GET /api/v1/research

    GET
    /api/v1/research

    List your research jobs

    Parameters

    NameTypeRequiredDescription
    limitintegerOptionallimitDefault: 20
    cursorstringOptionalcursor

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/research \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "items": [],
  "next_cursor": "example"
}

    GET /api/v1/research/{job_id}

    GET
    /api/v1/research/{job_id}

    Get a research job

    Parameters

    NameTypeRequiredDescription
    job_idstring
    Required
    		job_id

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/research/<job_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "id": "example",
  "status": "example",
  "effort": "example",
  "budget": "example",
  "cost": "example",
  "tool_calls": 0
}

    DELETE /api/v1/research/{job_id}

    DELETE
    /api/v1/research/{job_id}

    Delete a finished research job

    Parameters

    NameTypeRequiredDescription
    job_idstring
    Required
    		job_id

    Request Example

    Bash
    curl -X DELETE https://api.alterlab.io/api/v1/research/<job_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    POST /api/v1/research/{job_id}/approve

    POST
    /api/v1/research/{job_id}/approve

    Approve the plan and start the run

    Parameters

    NameTypeRequiredDescription
    job_idstring
    Required
    		job_id
    planobjectOptionalplan

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/research/<job_id>/approve \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "id": "example",
  "status": "example",
  "effort": "example",
  "budget": "example",
  "cost": "example",
  "tool_calls": 0
}

    POST /api/v1/research/{job_id}/cancel

    POST
    /api/v1/research/{job_id}/cancel

    Cancel a research job

    Parameters

    NameTypeRequiredDescription
    job_idstring
    Required
    		job_id

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/research/<job_id>/cancel \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "id": "example",
  "status": "example",
  "effort": "example",
  "budget": "example",
  "cost": "example",
  "tool_calls": 0
}

    GET /api/v1/research/{job_id}/events

    GET
    /api/v1/research/{job_id}/events

    Stream research progress (SSE, resumable)

    Parameters

    NameTypeRequiredDescription
    job_idstring
    Required
    		job_id
    last_event_idstringOptionallast_event_id
    Last-Event-IDstringOptionalLast-Event-ID

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/research/<job_id>/events \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    GET /api/v1/research/{job_id}/plan

    GET
    /api/v1/research/{job_id}/plan

    Get the plan of a plan_first job

    Parameters

    NameTypeRequiredDescription
    job_idstring
    Required
    		job_id

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/research/<job_id>/plan \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    PUT /api/v1/research/{job_id}/plan

    PUT
    /api/v1/research/{job_id}/plan

    Refine the plan before approving it

    Parameters

    NameTypeRequiredDescription
    job_idstring
    Required
    		job_id
    planobject
    Required
    		Plan

    Request Example

    Bash
    curl -X PUT https://api.alterlab.io/api/v1/research/<job_id>/plan \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "plan": "..."
  }'

    Response Example

    JSON
    {
  "id": "example",
  "status": "example",
  "effort": "example",
  "budget": "example",
  "cost": "example",
  "tool_calls": 0
}

    POST /api/v1/research/{job_id}/rerun

    POST
    /api/v1/research/{job_id}/rerun

    Start a new research job from a stored one

    Parameters

    NameTypeRequiredDescription
    job_idstring
    Required
    		job_id
    overridesobjectOptionalOverrides

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/research/<job_id>/rerun \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}
    Last updated: June 2026

    On this page