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

# Get Deep Search

> Retrieve a specific deep search by its ID.



## OpenAPI

````yaml GET /deepSearch/{id}
openapi: 3.0.0
info:
  title: Cloudglue API
  description: API for Cloudglue
  license:
    name: Apache License 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 0.7.13
servers:
  - url: https://api.cloudglue.dev/v1
security:
  - bearerAuth: []
paths:
  /deepSearch/{id}:
    get:
      tags:
        - Deep Search
      summary: Get a deep search by ID
      description: Retrieve a specific deep search by its ID.
      operationId: getDeepSearch
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the deep search to retrieve
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Deep search details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeepSearch'
        '404':
          description: Deep search not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: An unexpected error occurred on the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    DeepSearch:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Deep search ID
        object:
          type: string
          enum:
            - deep_search
          description: Object type identifier
        status:
          type: string
          enum:
            - in_progress
            - completed
            - failed
            - cancelled
          description: Current status of the deep search
        created_at:
          type: number
          description: Unix timestamp of when the deep search was created
        query:
          type: string
          description: The original search query
        scope:
          type: string
          enum:
            - segment
            - file
          description: The scope of the search results
        text:
          type: string
          nullable: true
          description: LLM-generated synthesis text summarizing the results
        results:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/DeepSearchResult'
          description: Array of search results
        total:
          type: integer
          description: Total number of results
        limit:
          type: integer
          description: Maximum number of results requested
        search_queries:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/DeepSearchSearchQueryPlan'
          description: >-
            Intermediate search query plans (included when requested via
            include=['search_queries'])
        usage:
          $ref: '#/components/schemas/DeepSearchUsage'
          nullable: true
          description: Token and search call usage
        error:
          type: object
          nullable: true
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: string
          description: Error details if the deep search failed
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
    DeepSearchResult:
      type: object
      properties:
        type:
          type: string
          enum:
            - segment
            - file
          description: The type of result
        id:
          type: string
          format: uuid
          description: Result ID
        file_id:
          type: string
          format: uuid
          description: The file ID this result belongs to
        collection_id:
          type: string
          format: uuid
          description: >-
            The collection ID this result belongs to. Present when using
            `collections` source; omitted for `files` and `default` sources.
        score:
          type: number
          description: Relevance score
        context:
          type: string
          description: LLM-generated context explaining why this result is relevant
        segment_id:
          type: string
          format: uuid
          description: Segment ID (present when type is 'segment')
        start_time:
          type: number
          description: Start time in seconds (present when type is 'segment')
        end_time:
          type: number
          description: End time in seconds (present when type is 'segment')
        title:
          type: string
          nullable: true
          description: Segment title
        filename:
          type: string
          nullable: true
          description: Original filename
        thumbnail_url:
          type: string
          nullable: true
          description: URL to a thumbnail image
        metadata:
          type: object
          nullable: true
          description: Additional metadata
        summary:
          type: string
          nullable: true
          description: File summary (present when type is 'file')
        generated_title:
          type: string
          nullable: true
          description: Generated title (present when type is 'file')
    DeepSearchSearchQueryPlan:
      type: object
      properties:
        query:
          type: string
          description: The search query
        search_modalities:
          type: array
          items:
            type: string
          description: Modalities used for this search
        scope:
          type: string
          description: Search scope
        filter:
          type: object
          nullable: true
          description: Optional filter applied
        result_count:
          type: integer
          description: Number of results returned for this query
    DeepSearchUsage:
      type: object
      properties:
        input_tokens:
          type: integer
          description: Number of input tokens used
        output_tokens:
          type: integer
          description: Number of output tokens used
        total_tokens:
          type: integer
          description: Total number of tokens used
        search_calls:
          type: integer
          description: Number of search calls made
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````