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

    Secrets

    API reference for secrets endpoints.

    Auto-generated

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

    POST /api/v1/secrets

    POST
    /api/v1/secrets

    Create Secret

    Parameters

    NameTypeRequiredDescription
    namestring
    Required
    Secret name (e.g. SLACK_TOKEN)
    valuestring
    Required
    Secret value (plaintext)
    integrationstringOptionalintegration
    kind"generic" | "site_login" | "profile_field" | "totp"Optionalgeneric (workflow secret), site_login (domain-bound credential) or profile_field (résumé/profile value) for Hands fill_secret, or totp (base32 authenticator seed) for Hands fill_totp. Card data is never stored here.Default: generic
    allowed_domainsstring[]Optionalallowed_domains

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/secrets \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "name": "example_name",
        "value": "example_value",
        "kind": "..."
      }'

    Response Example

    JSON
    {
      "status": "ok"
    }

    GET /api/v1/secrets

    GET
    /api/v1/secrets

    List Secrets

    Parameters

    NameTypeRequiredDescription
    integrationstringOptionalintegration

    Request Example

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

    Response Example

    JSON
    {
      "secrets": [],
      "total": 0
    }

    GET /api/v1/secrets/{secret_id}

    GET
    /api/v1/secrets/{secret_id}

    Get Secret

    Parameters

    NameTypeRequiredDescription
    secret_idstring
    Required
    secret_id

    Request Example

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

    Response Example

    JSON
    {
      "id": "example",
      "name": "example",
      "integration": "example",
      "masked_value": "example",
      "kind": "example",
      "allowed_domains": "example"
    }

    PUT /api/v1/secrets/{secret_id}

    PUT
    /api/v1/secrets/{secret_id}

    Update Secret

    Parameters

    NameTypeRequiredDescription
    secret_idstring
    Required
    secret_id
    valuestring
    Required
    New secret value

    Request Example

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

    Response Example

    JSON
    {
      "id": "example",
      "name": "example",
      "integration": "example",
      "masked_value": "example",
      "kind": "example",
      "allowed_domains": "example"
    }

    DELETE /api/v1/secrets/{secret_id}

    DELETE
    /api/v1/secrets/{secret_id}

    Delete Secret

    Parameters

    NameTypeRequiredDescription
    secret_idstring
    Required
    secret_id

    Request Example

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

    Response Example

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

    On this page