Live

Search a source live

Changed on

Search a source live for content that may not be indexed yet. With index=true, each hit is queued for indexing (no-op for live-only sources like Google Calendar — see notes in the response).

post/live/{source}/search

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/live/{source}/search
  • Auth
    HTTP bearer

Path parameters

source'reddit' | 'notion' | 'slack' | 'google_calendar' | 'google_mail' | 'imap' | 'google_meet' | 'box' | 'dropbox' | 'github' | 'gitlab' | 'google_drive' | 'vault' | 'web_crawler' | 'trace' | 'microsoft_outlook' | 'microsoft_teams' | 'granola' | 'fathom' | 'fireflies' | 'figma' | 'linear' | 'hubspot' | 'salesforce' | 'coda' | 'confluence' | 'jira' | 'metabase' | 'gong' | 'clickup' | 'lightfield' | 'pylon' | 'fellow' | 'odoo' | 'external_mcp' | 'page' required

Headers

X-Hyperspell-Response-Profile'api' | 'mcp'

Case-sensitive api or mcp. Bounds Google Calendar search only; other providers retain their existing behavior.

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Request body

querystring required

Live search query.

indexboolean

If true, queue each hit for indexing so it's on-hand next time.

connection_idstring nullable

Specific connection id when the user has multiple for this source.

Response

Successful Response

indexedboolean
notesstring[]

Changes

  • 77d3e8d5e8a7Revision changes
    • warning

      added the new gong enum value to the // response property for the response status

    • info

      added the new enum value gong to the path request parameter source

  • 455cd12eecb3Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status