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

# Search articles

> Search knowledge base articles for any query using AI-powered recommendation



## OpenAPI

````yaml /api-reference/openapi.json get /v1/community/search/articles
openapi: 3.0.3
info:
  title: IrisAgent's API Reference
  description: >
    IrisAgent service can be used as an API to power intelligent conversations
    and search, index, and connect with your internal and external knowledge
    articles, tickets, community forums, product documentation,

    and other informational content.
  version: 1.2.0
servers:
  - url: https://api1.irisagent.com
security:
  - bearerAuth: []
paths:
  /v1/community/search/articles:
    get:
      summary: Search articles
      description: >-
        Search knowledge base articles for any query using AI-powered
        recommendation
      operationId: searchArticles
      parameters:
        - name: text
          in: query
          description: The search query string.
          required: true
          schema:
            type: string
        - name: offset
          in: query
          description: Pagination offset for search results.
          required: false
          schema:
            type: integer
            format: uint
            minimum: 0
        - name: limit
          in: query
          description: Maximum number of results to return.
          required: false
          schema:
            type: integer
            format: uint
            default: 25
            minimum: 1
        - name: X-Business-Id
          in: header
          description: Business ID of the customer.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArticlesSearchResponse'
        '400':
          description: Bad request - invalid input
        '401':
          description: Unauthorized - invalid credentials
        '403':
          description: Forbidden - insufficient permissions
components:
  schemas:
    ArticlesSearchResponse:
      type: object
      properties:
        articles:
          type: array
          items:
            $ref: '#/components/schemas/SearchArticle'
      required:
        - articles
    SearchArticle:
      type: object
      properties:
        id:
          description: Unique identifier for the article
          type: string
        title:
          description: Title of the article
          type: string
        url:
          description: URL of the article
          type: string
          format: uri
        snippet:
          description: Brief snippet or excerpt from the article
          type: string
      required:
        - id
        - title
        - url
        - snippet
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        The `Authorization` header is required to authenticate API requests.
        It should contain a bearer token obtained through the IrisAgent portal.

````