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

# Raw live read against a source

> Read a source live through Unified passthrough using a provider-native path.

Read-only: the (method, path) is validated against the source's declared read
surface before any provider call; writes are rejected (405).



## OpenAPI

````yaml https://app.stainlessapi.com/api/spec/documented/hyperspell.yaml post /live/{source}/passthrough
openapi: 3.1.0
info:
  title: Hyperspell API
  summary: >-
    Hyperspell is the memory layer for AI apps and agents. Through the API, you
    can add memories, connect data sources to index them in real-time, and
    search memories with our natural language query engine.
  termsOfService: https://hyperspell.com/blog/tos
  contact:
    name: Hyperspell
    url: https://hyperspell.com/
    email: hello@hyperspell.com
  version: 0.32.1
servers:
  - url: https://api.hyperspell.com
    description: Production
security:
  - APIKey: []
    AsUser: []
paths:
  /live/{source}/passthrough:
    post:
      tags:
        - Live
      summary: Raw live read against a source
      description: >-
        Read a source live through Unified passthrough using a provider-native
        path.


        Read-only: the (method, path) is validated against the source's declared
        read

        surface before any provider call; writes are rejected (405).
      operationId: live_source_passthrough_live__source__passthrough_post
      parameters:
        - name: source
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/DocumentProviders'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PassthroughRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PassthroughResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKey: []
        - AsUser: []
components:
  schemas:
    DocumentProviders:
      type: string
      enum:
        - reddit
        - notion
        - slack
        - google_calendar
        - google_mail
        - box
        - dropbox
        - github
        - google_drive
        - vault
        - web_crawler
        - trace
        - microsoft_teams
        - gmail_actions
        - granola
        - fathom
        - fireflies
        - linear
        - hubspot
        - salesforce
        - coda
        - lightfield
        - gong
        - pylon
        - clickup
      title: DocumentProviders
    PassthroughRequest:
      properties:
        method:
          type: string
          enum:
            - GET
            - POST
            - PATCH
            - PUT
            - DELETE
          title: Method
          description: Provider HTTP method. Writes (PATCH/PUT/DELETE) are rejected.
          default: GET
        path:
          type: string
          title: Path
          description: Provider-native path, e.g. 'gmail/v1/users/me/messages'.
        query:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Query
          description: Query-string params for GET reads.
        body:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Body
          description: JSON body for read-via-POST (e.g. GraphQL).
        connection_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Connection Id
          description: Specific connection id when the user has multiple.
      type: object
      required:
        - path
      title: PassthroughRequest
    PassthroughResponse:
      properties:
        source:
          $ref: '#/components/schemas/DocumentProviders'
        method:
          type: string
          title: Method
        path:
          type: string
          title: Path
        payload:
          title: Payload
        truncated:
          type: boolean
          title: Truncated
          default: false
        notes:
          items:
            type: string
          type: array
          title: Notes
      type: object
      required:
        - source
        - method
        - path
        - payload
      title: PassthroughResponse
      description: >-
        A raw passthrough read: the provider's payload verbatim, plus what
        happened.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKey:
      type: http
      description: >-
        API Key or JWT User Token. If using an API Key, set the X-As-User header
        to act as a specific user. A JWT User Token is always scoped to a
        specific user.
      scheme: bearer
      bearerFormat: Bearer <token>
    AsUser:
      type: apiKey
      description: >-
        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
      in: header
      name: X-As-User

````