> ## Documentation Index
> Fetch the complete documentation index at: https://docs.searchable.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a pitch

> Create a pitch: a 7-day trial project for a prospect, set up as the app's Add project flow sets one up with the pitch option: the pitch, its competitors, brand profile, default location and onboarding record, with 5 manual refreshes and one 7-day extension. It takes the details `POST /api/mcp/projects` takes, without `description` (a pitch stores none). A pitch's prompts count against the workspace's pitch allowance, never the plan's prompt allowance; `generatePrompts: true` starts the app's prompt generation in the background, within it. `dryRun: true` runs every check and answers the preview with 200, creating nothing. Requires a connection minted with the `project:provision` capability (not the bare `write` scope); a project-bound credential is refused outright, since creating a pitch is a workspace-level action. Supports `Idempotency-Key` replay; a reused key with a different body returns 409 `idempotency_conflict` instead of replaying the first pitch (a `dryRun` answer is stored too, so creating after a preview takes a new key). Refusals: 403 `plan_upgrade_required` (with `requiresUpgrade: true`) when the workspace's plan has no pitches, 403 `pitch_allowance_used` when its pitch allowance is spent, and 409 `duplicate_domain` when you already have a project or pitch on that domain in any workspace: `howToFix` and `existing` name it, unless it sits in a workspace the API may not reach, which is named nowhere. The other 403s: `missing_scope` without the `project:provision` capability, `forbidden` for a project-bound credential or a workspace where you may not create pitches (you are not a member, or your role cannot create projects), and `security_policy_denied` when the workspace's API access policy refuses the request (API access switched off, or an IP allowlist you are outside).



## OpenAPI

````yaml /api-reference/openapi.json post /api/mcp/pitches
openapi: 3.1.0
info:
  title: Searchable REST API
  version: 1.0.0
  summary: >-
    Query AI visibility, sources, sentiment, traffic, and content data, and
    trigger audits/reports/sitemap syncs.
  description: >-
    The Searchable REST API (`/api/mcp/*` and
    `/api/v1/projects/{projectId}/audits`) exposes the same data and actions
    available in the Searchable dashboard and MCP server, over plain HTTP with a
    bearer API key. It is a **read-mostly** surface — 75 of its 91 operations
    are GET. The mutating ones are capability-gated (a bare `write` scope does
    not satisfy a capability such as `prompt:draft`), and those listed under
    [Idempotency](/api-reference/introduction#idempotency) support
    `Idempotency-Key` replay.


    See **[Getting started](/api-reference/introduction)** for auth, rate
    limits, idempotency, and pagination conventions, and the **[error
    reference](/api/errors)** for every error `code` this API returns.


    `/api/mcp/*` is a frozen v1 contract — see the [changelog](/changelog) for
    the deprecation policy.
  contact:
    name: Searchable Support
    email: support@searchable.com
    url: https://docs.searchable.com/api-reference/introduction
servers:
  - url: https://app.searchable.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: List and inspect the projects an API key can reach.
  - name: Visibility
    description: >-
      AI visibility score, platform/topic/prompt/location breakdowns, and
      historical trend.
  - name: Share of Voice
    description: Brand vs. competitor mention-share ranking and its daily trend.
  - name: Competitors
    description: >-
      The project's tracked competitor roster — share of voice, sentiment, and
      mention/citation counts.
  - name: Sources
    description: >-
      Domains and URLs cited by AI answers — citation share, trend, and cached
      page content.
  - name: Sentiment
    description: Brand sentiment summary, trend, and head-to-head competitor comparison.
  - name: Query Fanout
    description: The sub-queries AI models generate when answering tracked prompts.
  - name: Traffic
    description: >-
      First-party AI-crawler and AI-referral traffic sourced from the
      tracker/CDN pipeline.
  - name: Shopping
    description: AI shopping/product-carousel visibility.
  - name: Ads
    description: >-
      Sponsored ads surfaced in AI answers — advertisers, individual creatives,
      ad-heavy prompts, and the frequency trend.
  - name: Answers
    description: Raw, per-response AI-answer data for a single prompt.
  - name: GSC
    description: Live Google Search Console performance data for the project's linked site.
  - name: GA4
    description: Live Google Analytics 4 traffic and AI-referral data.
  - name: Audits & Issues
    description: >-
      Page audits (technical + AEO), site issues, monitored pages, and sitemap
      sync.
  - name: Reports
    description: Generate and list shareable visibility/sentiment reports.
  - name: Articles
    description: Content pieces (articles) created in Searchable.
  - name: Opportunities
    description: >-
      Actionable, prioritized suggestions Searchable has surfaced for the
      project.
  - name: Brand
    description: Brand profile (knowledge base + AI-observed facts) and domain authority.
  - name: Prompts
    description: >-
      The project's prompt catalog (tracked, untracked, and AI-suggested
      prompts).
paths:
  /api/mcp/pitches:
    post:
      tags:
        - Projects
      summary: Create a pitch
      description: >-
        Create a pitch: a 7-day trial project for a prospect, set up as the
        app's Add project flow sets one up with the pitch option: the pitch, its
        competitors, brand profile, default location and onboarding record, with
        5 manual refreshes and one 7-day extension. It takes the details `POST
        /api/mcp/projects` takes, without `description` (a pitch stores none). A
        pitch's prompts count against the workspace's pitch allowance, never the
        plan's prompt allowance; `generatePrompts: true` starts the app's prompt
        generation in the background, within it. `dryRun: true` runs every check
        and answers the preview with 200, creating nothing. Requires a
        connection minted with the `project:provision` capability (not the bare
        `write` scope); a project-bound credential is refused outright, since
        creating a pitch is a workspace-level action. Supports `Idempotency-Key`
        replay; a reused key with a different body returns 409
        `idempotency_conflict` instead of replaying the first pitch (a `dryRun`
        answer is stored too, so creating after a preview takes a new key).
        Refusals: 403 `plan_upgrade_required` (with `requiresUpgrade: true`)
        when the workspace's plan has no pitches, 403 `pitch_allowance_used`
        when its pitch allowance is spent, and 409 `duplicate_domain` when you
        already have a project or pitch on that domain in any workspace:
        `howToFix` and `existing` name it, unless it sits in a workspace the API
        may not reach, which is named nowhere. The other 403s: `missing_scope`
        without the `project:provision` capability, `forbidden` for a
        project-bound credential or a workspace where you may not create pitches
        (you are not a member, or your role cannot create projects), and
        `security_policy_denied` when the workspace's API access policy refuses
        the request (API access switched off, or an IP allowlist you are
        outside).
      operationId: createPitch
      parameters:
        - $ref: '#/components/parameters/idempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                workspaceId:
                  type: string
                  format: uuid
                  description: >-
                    A workspace from `GET /api/mcp/workspaces` whose
                    `canCreateProjects` is true and whose plan has pitches (`GET
                    /api/mcp/pitches` shows `canCreatePitches`).
                domain:
                  type: string
                  description: The brand's website domain, e.g. example.com
                brandName:
                  type: string
                  description: The brand's name, as it's referred to in prompts and reports
                brandSummary:
                  type: string
                  description: >-
                    2-3 sentences: what the brand sells, who it serves, and what
                    makes it distinct
                brandNameDisambiguation:
                  type: string
                  description: >-
                    When the name is ambiguous, a short note on which brand this
                    is; empty when the name is distinctive
                reach:
                  type: string
                  enum:
                    - global
                    - national-global
                    - nationwide
                    - regional
                    - local
                  description: >-
                    Where the brand sells; national-global is a primary market
                    plus international reach
                country:
                  type: string
                  description: >-
                    Where most customers are: an ISO 3166-1 alpha-2 code, e.g.
                    GB
                city:
                  type: string
                  description: >-
                    The city, for regional or local reach, e.g. Austin. A
                    state's name here is taken as the state. A US city in more
                    than one state needs `state`, or it is not placed
                state:
                  type: string
                  description: >-
                    The state, for regional or local reach: alone for the whole
                    state (e.g. California), or with `city` for the state the
                    city is in (e.g. Oregon for Portland). A US code such as TX
                    works; elsewhere write the name
                language:
                  type: string
                  description: >-
                    Language for the prompts, e.g. en-GB; defaults from the
                    country
                competitors:
                  type: array
                  minItems: 1
                  maxItems: 20
                  description: Direct competitors, each a website domain or {domain, name}
                  items:
                    oneOf:
                      - type: string
                      - type: object
                        properties:
                          domain:
                            type: string
                          name:
                            type: string
                        required:
                          - domain
                brandAliases:
                  type: array
                  maxItems: 25
                  items:
                    type: string
                  description: Other names the brand goes by, counted as mentions of it
                name:
                  type: string
                  description: Project name; defaults to the brand name
                generatePrompts:
                  type: boolean
                  description: >-
                    Start the app's prompt generation in the background (tracked
                    prompts, within the workspace's pitch allowance)
                dryRun:
                  type: boolean
                  description: >-
                    Run the checks and return the preview without creating
                    anything.
              required:
                - workspaceId
                - domain
                - brandName
                - brandSummary
                - reach
                - country
                - competitors
                - generatePrompts
      responses:
        '200':
          description: Pitch created, or the preview of it for a dry run.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
            X-Idempotent-Replay:
              $ref: '#/components/headers/XIdempotentReplay'
            X-Idempotent-Skipped:
              $ref: '#/components/headers/XIdempotentSkipped'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePitchResponse'
        '400':
          $ref: '#/components/responses/defaultError'
        '401':
          $ref: '#/components/responses/defaultError'
        '403':
          $ref: '#/components/responses/defaultError'
        '409':
          description: >-
            A conflict. `duplicate_domain`: you already have a project or pitch
            on that domain in any workspace; `howToFix` and `existing` name it,
            unless it sits in a workspace the API may not reach, which is named
            nowhere. `idempotency_conflict`: the `Idempotency-Key` was reused
            with a different body. `idempotency_in_flight`: a request with the
            same key is still executing; `Retry-After` (5 seconds) is present,
            so retry with the SAME key.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          $ref: '#/components/responses/rateLimited'
        '500':
          $ref: '#/components/responses/defaultError'
components:
  parameters:
    idempotencyKey:
      name: Idempotency-Key
      in: header
      schema:
        type: string
      description: >-
        Optional client-generated key (e.g. a UUID). Retrying with the same key
        within 24h replays the original stored response (`X-Idempotent-Replay:
        true`) instead of repeating the side effect. See
        [Idempotency](/api-reference/introduction#idempotency).
  headers:
    XRequestId:
      description: This request's id. Include it when contacting support.
      schema:
        type: string
        format: uuid
    RateLimit:
      description: >-
        IETF draft rate-limit header:
        `"default";r=<remaining>;t=<seconds-until-reset>`. Omitted on responses
        where the limiter did not run (e.g. a pre-auth validation error, or a
        degraded limiter failing open).
      schema:
        type: string
    RateLimitPolicy:
      description: >-
        IETF draft rate-limit policy: `"default";q=<quota>;w=<window-seconds>`.
        Currently `q=600;w=60`.
      schema:
        type: string
    XRateLimitLimit:
      description: Requests allowed per window (600/minute per key).
      schema:
        type: integer
    XRateLimitRemaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
    XRateLimitReset:
      description: Absolute Unix-epoch second the current window resets.
      schema:
        type: integer
    XIdempotentReplay:
      description: >-
        `true` when this response is a replay of a previously stored successful
        response for the same `Idempotency-Key`.
      schema:
        type: string
        enum:
          - 'true'
    XIdempotentSkipped:
      description: >-
        `body-too-large` when a successful response exceeded the 100KB
        idempotency-store cap and was not cached (the request still ran
        normally).
      schema:
        type: string
        enum:
          - body-too-large
    RetryAfter:
      description: >-
        Seconds to wait before retrying. Set on 429s issued by Searchable's own
        rate limiter and on `409 idempotency_in_flight`; may be absent when an
        upstream provider (e.g. Google) rate-limits.
      schema:
        type: integer
  schemas:
    CreatePitchResponse:
      description: 'The pitch that was created, or, with `dryRun: true`, the preview of it.'
      oneOf:
        - type: object
          description: The pitch was created.
          properties:
            pitch:
              $ref: '#/components/schemas/PitchRecord'
            success:
              type: boolean
            promptGeneration:
              type: string
              enum:
                - started
                - not_requested
            location:
              type: object
              description: >-
                The pitch's default location as saved: the country, a state
                (`region` with no `city`), or a city in its state.
              properties:
                countryCode:
                  type: string
                city:
                  type:
                    - string
                    - 'null'
                region:
                  type:
                    - string
                    - 'null'
                label:
                  type: string
                  description: >-
                    The place as the app names it, e.g. California, United
                    States
              required:
                - countryCode
                - city
                - region
                - label
            notes:
              type: array
              items:
                type: string
              description: >-
                Present only when a state or city that was sent could not be
                placed: a state that matches no known state; a city that was not
                recognised; a US city found in more than one state; a state or
                city that could not be checked, because the lookup failed or did
                not answer, which is never reported as not recognised. The
                default location is then the whole country.
          required:
            - pitch
            - success
            - promptGeneration
        - type: object
          description: 'A dry run: nothing was created.'
          properties:
            dryRun:
              type: boolean
              enum:
                - true
            preview:
              type: object
              description: >-
                What the create would save and what the pitch draws on: the
                interview's answers as they would be saved (`domain` is the
                cleaned domain the checks and the create work on), the default
                `location` and any `locationNote`, and the pitch's limits.
              properties:
                workspaceId:
                  type: string
                  format: uuid
                domain:
                  type: string
                name:
                  type: string
                brandName:
                  type: string
                brandSummary:
                  type: string
                brandNameDisambiguation:
                  type: string
                reach:
                  type: string
                country:
                  type: string
                  description: The country's name and code, e.g. `United Kingdom (GB)`.
                city:
                  type: string
                state:
                  type: string
                location:
                  type: string
                  description: >-
                    The default location the pitch would get, as the app names
                    it.
                locationNote:
                  type: string
                  description: >-
                    Present when a state or city could not be placed and the
                    location is the whole country.
                language:
                  type: string
                competitors:
                  type: array
                  items:
                    type: string
                brandAliases:
                  type: array
                  items:
                    type: string
                generatePrompts:
                  type: boolean
                pitchDays:
                  type: integer
                  description: How many days the pitch runs.
                manualRefreshes:
                  type: integer
                  description: The pitch's manual refreshes.
                pitchAllowance:
                  type: string
                  description: >-
                    What is left of the workspace's pitch prompt allowance, e.g.
                    `500 of 500 left`.
              required:
                - workspaceId
                - domain
                - name
                - brandName
                - brandSummary
                - reach
                - country
                - location
                - language
                - competitors
                - generatePrompts
                - pitchDays
                - manualRefreshes
                - pitchAllowance
          required:
            - dryRun
            - preview
    Problem:
      type: object
      description: >-
        RFC 9457 `application/problem+json` error body. `error` is retained
        verbatim as a legacy compat key equal to `message`. Some codes carry
        additional fields beyond the base shape (documented per-code in the
        [error reference](/api/errors)) — always additive, never replacing
        these.
      properties:
        type:
          type: string
          format: uri
          description: >-
            A URL identifying the error kind — the error reference page,
            anchored to `code`.
        title:
          type: string
          description: Human-readable summary of `code`.
        status:
          type: integer
          description: The HTTP status code (matches the response status).
        code:
          type: string
          description: >-
            Machine-readable, stable error code — safe to branch on. See the
            [error reference](/api/errors) for the full catalog.
          enum:
            - unauthorized
            - forbidden
            - missing_scope
            - plan_upgrade_required
            - security_policy_denied
            - not_found
            - invalid_argument
            - invalid_country
            - no_domain
            - no_workspace
            - no_pages
            - bulk_limit_exceeded
            - quota_exceeded
            - project_not_runnable
            - pitch_not_supported
            - duplicate_domain
            - conflict
            - pitch_allowance_used
            - already_extended
            - cannot_reactivate
            - pitch_not_active
            - pitch_still_active
            - no_refreshes_left
            - refresh_failed
            - already_converted
            - extend_not_available_yet
            - not_a_pitch
            - preview_stale
            - confirmation_mismatch
            - destination_not_permitted
            - cross_reseller_transfer_not_allowed
            - same_workspace
            - destination_owner_missing
            - project_state_unsupported
            - creator_domain_conflict
            - source_domain_conflict
            - access_removal_not_confirmed
            - storage_object_missing
            - quota_projects_exceeded
            - quota_prompts_exceeded
            - in_flight_agent_runs
            - lock_timeout
            - serialization_failure
            - not_active
            - role_not_permitted
            - staff_not_in_tenant
            - staff_not_eligible
            - rate_limited
            - idempotency_in_flight
            - idempotency_conflict
            - query_timeout
            - gsc_not_connected
            - gsc_site_not_linked
            - gsc_access_denied
            - ga4_not_connected
            - traffic_not_connected
            - invalid_scope
            - host_outside_domain
            - invalid_citation_type
            - missing_competitor
            - unknown_competitor
            - duplicate_scope
            - rule_limit
            - internal_error
        error:
          type: string
          description: Legacy compat key. Always equal to `message`.
        message:
          type: string
          description: Human-readable error message (identical to `error`).
        howToFix:
          type: string
          description: Present on actionable errors — a concrete next step.
        requestId:
          type: string
          format: uuid
          description: This request's id. Include it when contacting support.
        requiresUpgrade:
          type: boolean
          description: Present on `plan_upgrade_required` (403).
        retryable:
          type: boolean
          description: >-
            Present on `rate_limited`, `idempotency_in_flight`, and
            `query_timeout`.
        timeout:
          type: boolean
          description: Present on `query_timeout` (504).
        quotaExceeded:
          type: boolean
          description: Present on `quota_exceeded` (403).
        current:
          type: integer
          description: Present on `quota_exceeded` — current usage.
        limit:
          type: integer
          description: Present on `quota_exceeded` — the plan's limit.
        bulkLimitExceeded:
          type: boolean
          description: Present on `bulk_limit_exceeded` (400, `POST /audits`).
        requested:
          type: integer
          description: >-
            Present on `bulk_limit_exceeded` / `quota_exceeded` — the count
            requested.
        maxAllowed:
          type: integer
          description: Present on `bulk_limit_exceeded` — the plan's per-request cap.
        details:
          description: >-
            Present on some `invalid_argument` (400) responses — a Zod
            `.flatten()` validation breakdown.
          type: object
          properties:
            formErrors:
              type: array
              items:
                type: string
            fieldErrors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
        opensAt:
          type: string
          format: date-time
          description: Present on `extend_not_available_yet` (409) — when extending opens.
        existing:
          type: object
          description: >-
            Present on `duplicate_domain` (409) from `POST /api/mcp/pitches` —
            the project or pitch that already holds the domain: `projectId`,
            `name`, `domain`, `workspaceId`, `workspaceName`, `isPitch`,
            `pitchStatus`, `isActive` and `canReactivate`. Absent when the
            holder sits in a workspace the API may not reach.
          additionalProperties: true
        quotaConflict:
          type: object
          description: >-
            Present on `quota_exceeded` (403) when converting a pitch would take
            the workspace past its plan's prompt allowance: the tracked
            prompt-locations in use (`current`), those the pitch adds
            (`pitchPromptCount`), the plan's `limit`, and the `shortfall`.
          properties:
            current:
              type: number
              description: 'Can be fractional: a weekly prompt-location counts as 1/7.'
            pitchPromptCount:
              type: integer
            limit:
              type: integer
            shortfall:
              type: number
              description: Can be fractional, as `current` can.
          required:
            - current
            - pitchPromptCount
            - limit
            - shortfall
      required:
        - type
        - title
        - status
        - code
        - error
        - message
    PitchRecord:
      type: object
      description: >-
        One pitch as the Pitches tab shows it, worked out by the app's own
        rules. A converted pitch is a `ConvertedPitchRecord` instead.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        domain:
          type: string
        workspaceId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - active
            - declined
            - expired
          description: >-
            A declined pitch is paused; an expired one ran out of days. Both can
            be reactivated while `canReactivate` is true.
        createdAt:
          type: string
          format: date-time
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
        daysLeft:
          type:
            - integer
            - 'null'
          description: >-
            Whole days left, rounded up and never below zero; null without an
            expiry.
        extended:
          type: boolean
          description: Whether the pitch's one 7-day extension is used.
        refreshes:
          type: object
          description: The pitch's manual refreshes.
          properties:
            limit:
              type: integer
            used:
              type: integer
            remaining:
              type: integer
          required:
            - limit
            - used
            - remaining
        hiddenFromPicker:
          type: boolean
          description: Whether the pitch is hidden from the project picker.
        trackedPromptCount:
          type: integer
          description: Its tracked prompt-locations, as the pitch allowance counts them.
        canReactivate:
          type: boolean
          description: >-
            Whether a closed pitch can be brought back right now, as the app
            offers Reactivate.
        canExtend:
          type: boolean
          description: >-
            Whether the pitch can be extended right now: active, not yet
            extended, and in its last 48 hours.
      required:
        - id
        - name
        - domain
        - workspaceId
        - status
        - createdAt
        - expiresAt
        - daysLeft
        - extended
        - refreshes
        - hiddenFromPicker
        - trackedPromptCount
        - canReactivate
        - canExtend
  responses:
    defaultError:
      description: >-
        Error response. `code` is the machine-readable reason — see the [error
        reference](/api/errors) for the full catalog and remediation per code.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        X-RateLimit-Limit:
          $ref: '#/components/headers/XRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/XRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/XRateLimitReset'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    rateLimited:
      description: >-
        Rate limited. Usually the per-API-key REST limit (600 requests/minute);
        on Google-backed endpoints it can also relay an upstream Google rate
        limit. `Retry-After` (seconds) is present when the limit was applied by
        Searchable's own rate limiter; it may be absent when an upstream
        provider rate-limits.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        X-RateLimit-Limit:
          $ref: '#/components/headers/XRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/XRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/XRateLimitReset'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sea_xxxxx
      description: >-
        A Searchable API key, created under **Manage Account → Integrations →
        API Keys**. Send as `Authorization: Bearer sea_xxxxx`. Every key carries
        one or more scopes (`read`, `write`, `admin`) and may optionally be
        bound to a single project — see [Getting
        started](/api-reference/introduction#authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.