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

# Search interview transcripts

> Keyword search over interview transcripts, returning short snippets that
point at where something was said (agent-oriented: read the interview
itself for the full context).

The query is split into whitespace-separated keywords; a message matches
when it contains any term (case-insensitive substring), so extra words
broaden rather than narrow the search and there is no phrase matching.
Punctuation is stripped from each term's edges, and stopwords and
single-character terms are dropped — a query consisting only of those is
rejected with 400. Only conversational message turns are searched —
tool-call payloads and reasoning entries never match. Hits are ranked by distinct terms
matched, then interview recency, and capped at 3 per interview and
30 in total. All interview conversation types (onboarding, interview,
guided-interview, imported-interview) are always searched. Visibility
scoping matches the interviews list (non-admins only search their own
or assigned interviews).




## OpenAPI

````yaml /api-reference/openapi-public.yaml get /projects/{project_id}/interviews/search-transcripts/
openapi: 3.0.3
info:
  title: Clarifeye Platform API — Public API
  description: >
    Forward-facing, supported REST API for new integrators of the Clarifeye
    Platform.


    Covers the curated public surface: authentication, knowledge management

    (documents), users & teams, signals, and tool execution. New integrations

    should target these endpoints.


    ## Authentication

    All endpoints require authentication. Include the Authorization header in
    every request using either format:

    - `Authorization: Token <token_key>`

    - `Authorization: Bearer <token_key>`
  version: 1.0.0
  contact:
    name: Clarifeye Support
servers:
  - url: https://eu.app.clarifeye.ai/api/v1
    description: EU
  - url: https://us.app.clarifeye.ai/api/v1
    description: US
security:
  - BearerAuth: []
  - TokenAuth: []
tags:
  - name: Users
    description: Manage users within a project
  - name: Invitations
    description: Manage project invitations
  - name: Documents
    description: Manage documents within a project
  - name: Signals
    description: Submit signals about the project's content for domain experts to review
  - name: Tools
    description: Execute configured AI tools with custom parameters
  - name: Interviews
    description: >-
      Assign, run and review structured interview conversations, and manage
      interview drafts and campaigns
  - name: Artifacts
    description: >
      Knowledge-store artifact catalog: list artifacts, create and edit custom
      artifacts,

      manage scope membership, read and publish versions, and configure the
      cohesion guide.
  - name: Knowledge Changelog
    description: Chronological log of changes to the knowledge store's artifacts.
paths:
  /projects/{project_id}/interviews/search-transcripts/:
    get:
      tags:
        - Interviews
      summary: Search interview transcripts
      description: >
        Keyword search over interview transcripts, returning short snippets that

        point at where something was said (agent-oriented: read the interview

        itself for the full context).


        The query is split into whitespace-separated keywords; a message matches

        when it contains any term (case-insensitive substring), so extra words

        broaden rather than narrow the search and there is no phrase matching.

        Punctuation is stripped from each term's edges, and stopwords and

        single-character terms are dropped — a query consisting only of those is

        rejected with 400. Only conversational message turns are searched —

        tool-call payloads and reasoning entries never match. Hits are ranked by
        distinct terms

        matched, then interview recency, and capped at 3 per interview and

        30 in total. All interview conversation types (onboarding, interview,

        guided-interview, imported-interview) are always searched. Visibility

        scoping matches the interviews list (non-admins only search their own

        or assigned interviews).
      operationId: searchInterviewTranscripts
      parameters:
        - $ref: '#/components/parameters/ProjectId'
        - name: query
          in: query
          required: true
          description: >-
            Search keywords (whitespace-separated; a message matches any term).
            Minimum 2 characters; stopwords and single-character terms are
            ignored.
          schema:
            type: string
        - name: campaign
          in: query
          description: >-
            Filter by campaign: a campaign UUID, or "none" for interviews
            without a campaign.
          schema:
            type: string
        - name: interview_ids
          in: query
          description: Comma-separated interview UUIDs to search within.
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  query:
                    type: string
                  terms:
                    type: array
                    description: The parsed search terms (unique, lowercased).
                    items:
                      type: string
                  count_interviews_matched:
                    type: integer
                    description: >-
                      Interviews with at least one matching message (before the
                      total-hit cap).
                  interviews_scanned:
                    type: integer
                    description: Candidate interviews whose transcripts were examined.
                  scan_limit_reached:
                    type: boolean
                    description: >
                      True when more interviews matched the prefilter than could
                      be

                      scanned, so older ones were not examined at all and
                      matches may

                      be missing entirely (not merely trimmed).
                  truncated:
                    type: boolean
                    description: >-
                      True when more matches exist than were returned
                      (per-interview cap, total cap, or scan bound reached).
                  hits:
                    type: array
                    items:
                      type: object
                      properties:
                        interview_id:
                          type: string
                          format: uuid
                        interview_name:
                          type: string
                          nullable: true
                        type:
                          type: string
                        status:
                          type: string
                          nullable: true
                        campaign:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type: string
                        role:
                          type: string
                          nullable: true
                        speaker:
                          type: string
                          description: Speaker name (imported transcripts only).
                        timestamp:
                          type: string
                          nullable: true
                        query_id:
                          type: integer
                          nullable: true
                          description: >-
                            Message identifier within the transcript, matching
                            chat_history entries.
                        snippet:
                          type: string
                          description: >-
                            ~300-char window around the first matched term,
                            ellipsis-trimmed.
                        matched_terms:
                          type: array
                          items:
                            type: string
                        interview_total_matches:
                          type: integer
                          description: >-
                            Matching messages in this interview (at most 3
                            become hits).
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: UUID of the project
      schema:
        type: string
        format: uuid
  responses:
    BadRequest:
      description: Bad request - invalid parameters or request body
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/ValidationError'
    Unauthorized:
      description: Unauthorized - missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Authentication credentials were not provided.
    Forbidden:
      description: Forbidden - insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: You do not have permission to perform this action.
    NotFound:
      description: Not found - resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not found.
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
      example:
        error: User not found
    ValidationError:
      type: object
      additionalProperties:
        type: array
        items:
          type: string
      example:
        email:
          - This field is required.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Use Authorization: Bearer <token>'
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Use Authorization: Token <token>'

````