> ## 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.

# Ad-library search

> Search cached brand ads or explicitly request a paid scrape

CLI: `adside research ad-library search`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/research/ad-library/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}/research/ad-library/search:
    post:
      tags:
        - Research
      summary: Ad-library search
      description: |-
        Search cached brand ads or explicitly request a paid scrape

        CLI: `adside research ad-library search`
      operationId: research.ad-library.search
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                runId:
                  description: >-
                    Check on a scrape this tool started earlier. When set, every
                    other field is ignored.
                  type: string
                  minLength: 1
                brandName:
                  description: The brand or company name. Required unless `runId` is set.
                  type: string
                  minLength: 1
                  maxLength: 120
                channel:
                  description: Which ad library to search. Required unless `runId` is set.
                  type: string
                  enum:
                    - META
                    - GOOGLE
                    - LINKEDIN
                domain:
                  description: >-
                    The brand's website domain, for example `nike.com`. Required
                    for GOOGLE.
                  type: string
                  minLength: 3
                  maxLength: 253
                metaPageId:
                  description: The brand's numeric Facebook page id. Required for META.
                  type: string
                  pattern: ^\d+$
                startScrape:
                  default: false
                  description: >-
                    Set to true to start a paid scrape when the brand's ads are
                    not already collected. Leave false to only read what is
                    cached.
                  type: boolean
                limit:
                  default: 10
                  description: How many ads to return (max 25).
                  type: integer
                  minimum: 1
                  maximum: 25
                confirmationToken:
                  type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  text:
                    type: string
                required:
                  - text
                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.