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

# Search

> Search Brain pages with bounded keyword scanning

CLI: `adside brain search`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/brain/search
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/brain/search:
    post:
      tags:
        - Brain
      summary: Search
      description: |-
        Search Brain pages with bounded keyword scanning

        CLI: `adside brain search`
      operationId: brain.search
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                query:
                  type: string
                  minLength: 2
                  maxLength: 120
                tiers:
                  minItems: 1
                  maxItems: 2
                  type: array
                  items:
                    type: string
                    enum:
                      - workspace
                      - org
                directory:
                  type: string
                  minLength: 1
                  maxLength: 200
                  pattern: ^[a-z0-9][a-z0-9/_\-.]*$
                maxResults:
                  default: 10
                  type: integer
                  minimum: 1
                  maximum: 25
              required:
                - query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  matches:
                    type: array
                    items:
                      type: object
                      properties:
                        tier:
                          type: string
                          enum:
                            - workspace
                            - org
                        path:
                          type: string
                        title:
                          type: string
                        snippet:
                          type: string
                        score:
                          type: number
                      required:
                        - tier
                        - path
                        - title
                        - score
                      additionalProperties: false
                  totalMatches:
                    type: number
                  pagesScanned:
                    type: number
                  truncated:
                    type: boolean
                  failedTiers:
                    type: array
                    items:
                      type: object
                      properties:
                        tier:
                          type: string
                          enum:
                            - workspace
                            - org
                        message:
                          type: string
                      required:
                        - tier
                        - message
                      additionalProperties: false
                required:
                  - matches
                  - totalMatches
                  - pagesScanned
                  - truncated
                  - failedTiers
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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