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

# Search agents

> Searches for agents by matching the query term against agent names and descriptions (case-insensitive).

Returns agents accessible to the authenticated user within their organization. Results are
limited to prevent performance issues — use `maxRecords` to control the limit.



## OpenAPI

````yaml GET /api/v1/agent/search
openapi: 3.0.1
info:
  title: Sequentum Cloud API
  description: API endpoints for Sequentum Cloud
  version: v1
servers: []
security:
  - ApiKey: []
    Bearer: []
paths:
  /api/v1/agent/search:
    get:
      tags:
        - ApiAgent
      summary: Search for agents by name or description
      description: >-
        Searches for agents by matching the query term against agent names and
        descriptions (case-insensitive).


        Returns agents accessible to the authenticated user within their
        organization. Results are

        limited to prevent performance issues — use `maxRecords` to control the
        limit.
      parameters:
        - name: query
          in: query
          description: The search term to match against agent names and descriptions
          schema:
            type: string
        - name: maxRecords
          in: query
          description: Maximum number of results to return. Defaults to 50, max 1000.
          schema:
            type: integer
            format: int32
        - name: includeArchived
          in: query
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Returns the list of matching agents
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AgentApiModel'
        '400':
          description: If the query is empty or invalid, or maxRecords is out of range
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: If the API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    AgentApiModel:
      type: object
      properties:
        agentTemplates:
          type: string
          nullable: true
        configType:
          $ref: '#/components/schemas/ConfigType'
        description:
          type: string
          nullable: true
        documentation:
          type: string
          nullable: true
        icon:
          type: string
          nullable: true
        image:
          type: string
          format: byte
          nullable: true
        inputParameters:
          type: object
          additionalProperties:
            type: string
          nullable: true
        id:
          type: integer
          format: int32
          nullable: true
        isActive:
          type: boolean
          readOnly: true
        lastActivity:
          type: string
          format: date-time
          nullable: true
        name:
          type: string
          nullable: true
        proxyPoolId:
          type: integer
          format: int32
          nullable: true
        spaceId:
          type: integer
          format: int32
          nullable: true
        startUrl:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        userId:
          type: integer
          format: int32
          nullable: true
        validationStatus:
          $ref: '#/components/schemas/ConfigValidationStatus'
        version:
          type: integer
          format: int32
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
      additionalProperties: false
    BadRequestError:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        statusDescription:
          type: string
          nullable: true
        message:
          type: string
          nullable: true
          readOnly: true
        severity:
          $ref: '#/components/schemas/ErrorSeverity'
        errorCode:
          type: string
          description: "Optional machine-readable error code. When present, clients should switch on this\r\nvalue rather than parsing Sequentum.Enterprise.Core.ControllerError.Message. Omitted from the response when null."
          nullable: true
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    ConfigType:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: '`1` = `Agent`; `2` = `SharedFile`; `3` = `Template`; `4` = `Command`'
      format: int32
    ConfigValidationStatus:
      enum:
        - 1
        - 2
        - 3
      type: integer
      description: "Semantic validation status of a config's most recently saved definition (e.g. whether every\r\nfixed export schema column is actually produced by a command). Serialized as its underlying\r\nint, not a string - see Sequentum.Enterprise.ControlCenter.Swagger.EnumDescriptionsSchemaFilter\r\nfor how these values get documented in the public OpenAPI spec. (`1` = `Unknown` - Validation status was not computed for this response (e.g. a historical config version, which does not retain its own stored status); `2` = `Invalid` - The config has one or more semantic validation errors (e.g. a required export column with no producing command); `3` = `Valid` - The config has no semantic validation errors)"
      format: int32
    ErrorSeverity:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: >-
        `0` = `Error`; `1` = `Unexpected`; `2` = `Fatal`; `3` = `Warning`; `4` =
        `Info`
      format: int32
  securitySchemes:
    ApiKey:
      type: apiKey
      description: >-
        API Key authorization header. Example: "Authorization: ApiKey
        {your-api-key}"
      name: Authorization
      in: header
    Bearer:
      type: http
      description: 'OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"'
      scheme: bearer
      bearerFormat: JWT

````