openapi: 3.2.0
info:
  title: AutoGPT Agent Server Search API
  summary: AutoGPT Agent Server
  description: This server is used to execute agents that are created by the AutoGPT system.
  version: '0.1'
tags:
- name: Search
paths:
  /api/search/global:
    get:
      tags:
      - Search
      summary: Global search
      operationId: getSearchGlobalSearch
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          maxLength: 512
          description: Free-form search query (semantic + lexical). When empty or omitted, the endpoint returns the most-recently-updated items per bucket instead.
          default: ''
          title: Q
        description: Free-form search query (semantic + lexical). When empty or omitted, the endpoint returns the most-recently-updated items per bucket instead.
      - name: per_type_limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 10
          minimum: 1
          description: Maximum items returned per bucket. The response contains *at most* this many agents, files, and chats — fewer when the bucket has no/few matches.
          default: 4
          title: Per Type Limit
        description: Maximum items returned per bucket. The response contains *at most* this many agents, files, and chats — fewer when the bucket has no/few matches.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSearchResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-operation-id-source: normalized
      x-operation-id-original: getSearchGlobal search
components:
  responses:
    HTTP401NotAuthenticatedError:
      description: Authentication required
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
  schemas:
    GlobalSearchResponse:
      properties:
        agents:
          items:
            $ref: '#/components/schemas/SearchResultItem'
          type: array
          title: Agents
        files:
          items:
            $ref: '#/components/schemas/SearchResultItem'
          type: array
          title: Files
        chats:
          items:
            $ref: '#/components/schemas/SearchResultItem'
          type: array
          title: Chats
      type: object
      title: GlobalSearchResponse
      description: 'Top-N hits bucketed by item type.


        For a non-empty query this contains hybrid-search results.

        For an empty query this contains the most-recently-updated items

        per bucket (cached per-user with a short TTL).'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    SearchResultItem:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          enum:
          - library_agent
          - store_agent
          - workspace_file
          - chat_session
          title: Type
        title:
          type: string
          title: Title
        subtitle:
          anyOf:
          - type: string
          - type: 'null'
          title: Subtitle
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
        score:
          anyOf:
          - type: number
          - type: 'null'
          title: Score
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
      type: object
      required:
      - id
      - type
      - title
      title: SearchResultItem
      description: 'One row in a /search/global bucket.


        Kept intentionally generic so the frontend can render all three

        buckets through a single component. Type-specific details live in

        ``metadata`` (e.g. mime_type for files, creator for store agents).'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    APIKeyAuthenticator-X-Postmark-Webhook-Token:
      type: apiKey
      in: header
      name: X-Postmark-Webhook-Token
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBearerJWT:
      type: http
      scheme: bearer
      bearerFormat: jwt