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

# Search the user’s private indexed evidence

> Searches material previously saved or imported into the current user’s private research index.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/search
openapi: 3.1.0
info:
  title: video2ctx API
  version: 1.0.0
  license:
    name: Apache License 2.0
    identifier: Apache-2.0
  description: >-
    Consumer-facing contract for the hosted video2ctx API. First-party
    application and operator routes are documented separately at
    https://docs.video2ctx.dev/internals/overview.
servers:
  - url: https://api.video2ctx.dev
    description: Hosted video2ctx API
security: []
tags:
  - name: System
    description: Service status and machine-readable documentation.
  - name: Providers
    description: Supported external video providers and their capabilities.
  - name: Discovery
    description: Search, browse, and trend research.
  - name: Videos
    description: Video metadata and evidence.
  - name: Channels
    description: Channel inspection.
  - name: Playlists
    description: Playlist inspection.
  - name: Projects
    description: Private research projects and saved material.
  - name: Research
    description: Imports, jobs, cited answers, comparisons, and reports.
  - name: Exports
    description: Project export creation and download.
  - name: Monitoring
    description: Monitors, notifications, and digest preferences.
  - name: Billing
    description: Checkout, usage, and Stripe webhook handling.
paths:
  /v1/search:
    get:
      tags:
        - Discovery
      summary: Search the user’s private indexed evidence
      description: >-
        Searches material previously saved or imported into the current user’s
        private research index.
      operationId: searchPrivateEvidence
      parameters:
        - name: q
          in: query
          required: true
          description: Evidence search query.
          schema:
            type: string
            maxLength: 500
            example: AI agents
        - name: projectId
          in: query
          required: false
          description: Restrict private retrieval to a project.
          schema:
            type: string
      responses:
        '200':
          description: Matching private evidence.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateSearchResponse'
          headers:
            X-Credits-Charged:
              $ref: '#/components/headers/CreditsCharged'
            X-Credits-Remaining:
              $ref: '#/components/headers/CreditsRemaining'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientCredits'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerApiKey: []
        - sessionCookie: []
        - apiKey: []
        - demoUser: []
components:
  schemas:
    PrivateSearchResponse:
      type: object
      required:
        - query
        - results
      properties:
        query:
          type: string
        results:
          type: array
          items:
            $ref: '#/components/schemas/Evidence'
    Evidence:
      type: object
      required:
        - id
        - score
        - text
      properties:
        id:
          type: string
        score:
          type: number
        text:
          type: string
        provider:
          $ref: '#/components/schemas/ProviderId'
        entityId:
          type: string
        startMs:
          type: integer
          minimum: 0
        sourceKey:
          type: string
        index:
          type: integer
          minimum: 1
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: QUERY_REQUIRED
            message:
              type: string
            details: {}
            requestId:
              type: string
    ProviderId:
      type: string
      enum:
        - youtube
      example: youtube
  headers:
    CreditsCharged:
      description: Credits settled for this operation.
      schema:
        type: integer
        minimum: 0
    CreditsRemaining:
      description: Current balance in the owning user account after the request is metered.
      schema:
        type: integer
  responses:
    Unauthorized:
      description: Authentication is required.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InsufficientCredits:
      description: >-
        The user account does not have enough credits. Error code:
        INSUFFICIENT_CREDITS.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      headers:
        X-Credits-Charged:
          $ref: '#/components/headers/CreditsCharged'
        X-Credits-Remaining:
          $ref: '#/components/headers/CreditsRemaining'
    Forbidden:
      description: The caller is not allowed to perform this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: The request failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: The public rate limit was exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: An unexpected server error occurred.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServiceUnavailable:
      description: An upstream AI or YouTube service is unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Permanent personal API key created in the dashboard. Example: curl -H
        "Authorization: Bearer aty_…" https://your-host/v1/projects
    sessionCookie:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: >-
        Better Auth session cookie. A production deployment may use the
        secure-prefixed cookie name; same-origin browser requests send it
        automatically.
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Legacy-compatible header for a permanent personal API key. Prefer
        Authorization: Bearer aty_….
    demoUser:
      type: apiKey
      in: header
      name: X-Demo-User
      description: >-
        Local development only. Any stable value selects an isolated demo
        account. Rejected in production.

````