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

# Search docs articles

> Full-text search across published help-center articles, ranked by relevance. Each result carries the article plus a snippet around the match. Requires the docs:read scope.



## OpenAPI

````yaml openapi-v2.json get /docs/articles/search
openapi: 3.0.3
info:
  title: Productlane API
  description: Productlane API v2.
  version: 2.0.0
servers:
  - url: https://productlane.com/api/v2
security: []
paths:
  /docs/articles/search:
    get:
      tags:
        - docs
      summary: Search docs articles
      description: >-
        Full-text search across published help-center articles, ranked by
        relevance. Each result carries the article plus a snippet around the
        match. Requires the docs:read scope.
      operationId: docs-searchArticles
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
        - name: cursor
          in: query
          required: false
          schema:
            type: string
        - name: query
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 500
          description: >-
            Search terms. Matched against titles, summaries, bodies and
            translations, and ranked by relevance.
        - name: visibility
          in: query
          required: false
          schema:
            type: string
            enum:
              - public
              - agent
              - internal
              - unlisted
              - all
          description: >-
            Defaults to public. Agent and internal articles stay off your docs
            site; pass one of them, or all, to include them. `unlisted` is the
            former name for `agent`.
        - name: portal_instance_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            Filter to a single portal by its id (from GET /portal/instances).
            Pass `__main__` for the Main (Root) portal. Omit to return items
            across all portals.
        - name: language
          in: query
          required: false
          schema:
            type: string
          description: >-
            BCP-47 language code. Merges the matching translation onto each row.
            Requires the Pro plan and the language enabled in workspace
            settings.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        title:
                          type: string
                        summary:
                          type: string
                        content:
                          type: string
                        icon:
                          type: string
                          description: >-
                            Name of a Nucleo icon (PascalCase, e.g. `Notepad`,
                            `Atom`). Must be a valid icon from
                            https://nucleoapp.com - unknown names will not
                            render in the dashboard or portal.
                        url_name:
                          type: string
                        published:
                          type: boolean
                        visibility:
                          type: string
                          enum:
                            - public
                            - unlisted
                          description: >-
                            Whether the article is on your docs site.
                            Deprecated: read visibility_tier for the agent and
                            internal split.
                        visibility_tier:
                          type: string
                          enum:
                            - public
                            - agent
                            - internal
                          description: >-
                            agent and internal articles both stay off your docs
                            site and out of portal search. The Productlane Agent
                            answers customers from an agent article, and never
                            links it. An internal article is read by the AI
                            Assistant alone.
                        kind:
                          type: string
                          enum:
                            - doc
                            - link
                          description: >-
                            link rows point at a page you host elsewhere:
                            content is empty and external_url holds the address.
                        external_url:
                          type: string
                          nullable: true
                        archived:
                          type: boolean
                        show_on_home_page:
                          type: boolean
                        image_url:
                          type: string
                          nullable: true
                        group_id:
                          type: string
                          nullable: true
                        parent_article_id:
                          type: string
                          nullable: true
                        order:
                          type: integer
                          description: >-
                            Position among its siblings, ascending. Sort by it
                            to match the order the docs site renders.
                        portal_instance_id:
                          type: string
                          nullable: true
                        snippet:
                          type: string
                          description: >-
                            Plain-text excerpt around the match. Empty when the
                            index returns none.
                      required:
                        - id
                        - created_at
                        - updated_at
                        - title
                        - summary
                        - content
                        - icon
                        - url_name
                        - published
                        - visibility
                        - visibility_tier
                        - kind
                        - external_url
                        - archived
                        - show_on_home_page
                        - image_url
                        - group_id
                        - parent_article_id
                        - order
                        - portal_instance_id
                        - snippet
                      additionalProperties: false
                  page:
                    type: object
                    properties:
                      cursor:
                        type: string
                        nullable: true
                      has_more:
                        type: boolean
                      limit:
                        type: integer
                    required:
                      - cursor
                      - has_more
                      - limit
                    additionalProperties: false
                required:
                  - data
                  - page
                additionalProperties: false
        default:
          $ref: '#/components/responses/error'
      security:
        - Authorization: []
components:
  responses:
    error:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              issues:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                    - message
                  additionalProperties: false
            required:
              - message
              - code
            additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.