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

    Public Pages

    API reference for public pages endpoints.

    Auto-generated

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

    POST /api/v1/public-pages

    POST
    /api/v1/public-pages

    Publish Page

    Parameters

    NameTypeRequiredDescription
    source_type"scrape" | "crawl" | "search" | "workflow"OptionalSource TypeDefault: scrape
    source_idstring
    Required
    		Job id (or workflow run id) to publish
    titlestring
    Required
    		Title
    descriptionstringOptionalDescription
    refresh_interval"hourly" | "daily"Optionalrefresh_interval

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/public-pages \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source_type": "...",
    "source_id": "example_source_id",
    "title": "example_title",
    "description": "example_description"
  }'

    Response Example

    JSON
    {
  "status": "ok"
}

    GET /api/v1/public-pages/mine

    GET
    /api/v1/public-pages/mine

    List My Pages

    Request Example

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

    Response Example

    JSON
    {
  "status": "ok"
}

    GET /api/v1/public-pages/profile/{handle}

    GET
    /api/v1/public-pages/profile/{handle}

    Get Public Profile

    Parameters

    NameTypeRequiredDescription
    handlestring
    Required
    		handle

    Request Example

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

    Response Example

    JSON
    {
  "handle": "example",
  "pages": []
}

    GET /api/v1/public-pages/sitemap/slugs

    GET
    /api/v1/public-pages/sitemap/slugs

    Sitemap Slugs

    Request Example

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

    Response Example

    JSON
    {
  "status": "ok"
}

    DELETE /api/v1/public-pages/{slug}

    DELETE
    /api/v1/public-pages/{slug}

    Unpublish Page

    Parameters

    NameTypeRequiredDescription
    slugstring
    Required
    		slug

    Request Example

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

    Response Example

    JSON
    {
  "status": "ok"
}

    GET /api/v1/public-pages/{slug}

    GET
    /api/v1/public-pages/{slug}

    Get Page

    Parameters

    NameTypeRequiredDescription
    slugstring
    Required
    		slug

    Request Example

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

    Response Example

    JSON
    {
  "slug": "example",
  "title": "example",
  "description": "example",
  "source_type": "example",
  "columns": [],
  "rows": []
}

    POST /api/v1/public-pages/{slug}/follow

    POST
    /api/v1/public-pages/{slug}/follow

    Toggle Follow

    Parameters

    NameTypeRequiredDescription
    slugstring
    Required
    		slug

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/public-pages/<slug>/follow \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    POST /api/v1/public-pages/{slug}/fork

    POST
    /api/v1/public-pages/{slug}/fork

    Fork Page

    Parameters

    NameTypeRequiredDescription
    slugstring
    Required
    		slug

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/public-pages/<slug>/fork \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    GET /api/v1/public-pages/{slug}/fork-link

    GET
    /api/v1/public-pages/{slug}/fork-link

    Fork Link

    Parameters

    NameTypeRequiredDescription
    slugstring
    Required
    		slug

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/public-pages/<slug>/fork-link \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    PUT /api/v1/public-pages/{slug}/schedule

    PUT
    /api/v1/public-pages/{slug}/schedule

    Set Schedule

    Parameters

    NameTypeRequiredDescription
    slugstring
    Required
    		slug
    refresh_interval"hourly" | "daily"Optionalrefresh_interval

    Request Example

    Bash
    curl -X PUT https://api.alterlab.io/api/v1/public-pages/<slug>/schedule \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "id": "example",
  "slug": "example",
  "url": "example",
  "status": "example",
  "title": "example",
  "refresh_interval": "example"
}

    POST /api/v1/public-pages/{slug}/star

    POST
    /api/v1/public-pages/{slug}/star

    Toggle Star

    Parameters

    NameTypeRequiredDescription
    slugstring
    Required
    		slug

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/public-pages/<slug>/star \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    POST /api/v1/public-pages/{slug}/takedown

    POST
    /api/v1/public-pages/{slug}/takedown

    Takedown Notice

    Parameters

    NameTypeRequiredDescription
    slugstring
    Required
    		slug
    reasonstring
    Required
    		Reason
    contact_emailstring
    Required
    		Contact Email

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/public-pages/<slug>/takedown \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "example_reason",
    "contact_email": "example_contact_email"
  }'

    Response Example

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

    On this page