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

# Search workspace assets

> Search the main workspace library by text, tags, orientation, folder, MIME family, and taxonomy locale. Isolated API keys cannot search the full workspace library.



## OpenAPI

````yaml /openapi.json get /api/files/search
openapi: 3.1.0
info:
  title: Convertly API
  version: 1.0.0
  description: >-
    Convertly provides production API endpoints for media conversion,
    compression, Image CDN delivery, Forma AI, HLS/DASH video streaming, media
    tools, async jobs, workflows, webhooks, and Convertly Storage.
  license:
    name: Proprietary
    url: https://convertly.sh/terms
servers:
  - url: https://convertly.sh
security:
  - bearerAuth: []
  - apiKeyAuth: []
paths:
  /api/files/search:
    get:
      tags:
        - Files and Storage
      summary: Search workspace assets
      description: >-
        Search the main workspace library by text, tags, orientation, folder,
        MIME family, and taxonomy locale. Isolated API keys cannot search the
        full workspace library.
      operationId: searchFiles
      parameters:
        - name: q
          in: query
          schema:
            type: string
        - name: tags
          in: query
          description: Comma-separated tags.
          schema:
            type: string
        - name: tagMode
          in: query
          schema:
            type: string
            enum:
              - any
              - all
        - name: orientation
          in: query
          schema:
            type: string
            enum:
              - vertical
              - horizontal
              - square
        - name: folderId
          in: query
          description: Folder UUID, or `null` for the workspace root.
          schema:
            type: string
        - name: mimePrefix
          in: query
          schema:
            type: string
            example: image/
        - name: locale
          in: query
          schema:
            type: string
            default: en
        - name: facets
          in: query
          description: 'Comma-separated facets: tags, orientation, mimeType.'
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
      responses:
        '200':
          description: Search results and requested facets
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        upgradeUrl:
          type: string
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Dashboard-generated Convertly API key. Keys currently begin with
        `cvly_`.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternative API key header for server-side clients.

````