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

# Search Files

> Hybrid (vector + keyword) search across accessible files. Results are ranked by relevance and capped at 100.

User-scoped keys search all files the user can read. Org-scoped keys search all non-access-controlled files in the organization.

Pass `scope` (user-scoped keys only) to constrain the search to one of the three top-level meta-collections shown in the GC AI UI:
- `my-files`: files in the user's personal "My Files" tree
- `shared-with-me`: files explicitly shared with the user (and files inside shared folders)
- `organization`: files in the organization's "Organization Files" tree



## OpenAPI

````yaml GET /files
openapi: 3.0.3
info:
  title: GC AI External API
  version: 1.0.0
  description: >-
    The GC AI External API allows programmatic access to GC AI's chat
    capabilities. It's designed for integration with workflow automation tools
    like Zapier, Make, n8n, or custom applications.


    ## Authentication


    All API requests must include an API key in the `Authorization` header:


    ```

    Authorization: gcai_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

    ```


    API keys can be created in the GC AI app under **Settings → API**.


    ## Current Limitations


    The API is optimized for single-turn completions. The following are not yet
    available via API:


    - **Multi-turn conversations**: each request is independent

    - **Interactive clarification**: the model cannot pause to ask the caller a
    follow-up question; the `askUserQuestions` tool is disabled on the API
    surface in beta


    ## Usage


    Usage is tracked and viewable in the GC AI app under **Settings → API → View
    Usage**.


    ## Support


    For API support, contact [support@gc.ai](mailto:support@gc.ai) or reach out
    to your account representative.
  contact:
    email: support@gc.ai
servers:
  - url: https://app.gc.ai/api/external/v1
    description: Production server
security: []
tags:
  - name: Chat
    description: AI chat completion endpoints
  - name: Files
    description: File upload and management endpoints
  - name: Folders
    description: Folder management endpoints
  - name: Playbooks
    description: Playbook review endpoints
  - name: Projects
    description: Project management endpoints
  - name: Utility
    description: Health check and connectivity endpoints
paths:
  /files:
    get:
      tags:
        - Files
      summary: Search files
      description: >-
        Hybrid (vector + keyword) search across accessible files. Results are
        ranked by relevance and capped at 100.


        User-scoped keys search all files the user can read. Org-scoped keys
        search all non-access-controlled files in the organization.


        Pass `scope` (user-scoped keys only) to constrain the search to one of
        the three top-level meta-collections shown in the GC AI UI:

        - `my-files`: files in the user's personal "My Files" tree

        - `shared-with-me`: files explicitly shared with the user (and files
        inside shared folders)

        - `organization`: files in the organization's "Organization Files" tree
      operationId: searchFiles
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Search query (required)
            example: force majeure
          required: true
          description: Search query (required)
          name: q
          in: query
        - schema:
            type: string
            enum:
              - my-files
              - shared-with-me
              - organization
            description: >-
              Optional scope filter. When omitted, searches all files the user
              can read.
            example: my-files
          required: false
          description: >-
            Optional scope filter. When omitted, searches all files the user can
            read.
          name: scope
          in: query
      responses:
        '200':
          description: Files matching the query, ranked by relevance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSearchResponse'
        '400':
          description: >-
            Missing or invalid query parameters, or scope used with an
            org-scoped key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or malformed API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service temporarily unavailable
          headers:
            Retry-After:
              schema:
                type: string
                description: >-
                  Seconds to wait before retrying after a transient service
                  outage.
                example: '5'
              required: true
              description: >-
                Seconds to wait before retrying after a transient service
                outage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    FileSearchResponse:
      type: object
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/SearchedFile'
          description: >-
            Files matching the query, ranked by hybrid (vector + keyword)
            relevance. At most 100 results.
      required:
        - files
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        message:
          type: string
          description: Additional error details
        details:
          type: object
          additionalProperties:
            nullable: true
          description: Validation error details (for 400 errors)
      required:
        - error
    SearchedFile:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique file identifier
        name:
          type: string
          description: Original filename
        size:
          type: number
          description: File size in bytes
        content_type:
          type: string
          description: MIME type of the file
        status:
          type: string
          enum:
            - extracting
            - embedding
            - ready
            - failed
          description: Current processing status
        folder_id:
          type: string
          nullable: true
          format: uuid
          description: Parent folder ID, or null if the file is at the root
        created_at:
          type: string
          description: ISO 8601 creation timestamp
      required:
        - id
        - name
        - size
        - content_type
        - status
        - folder_id
        - created_at
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: |-
        API key for authentication. Format: `gcai_xxxxxxxxx`

        Create API keys in the GC AI app under Settings → API.

````