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

# [CBFull] Run Full Competitive Brief

> Generate a comprehensive competitive intelligence brief with all sections. Returns full JSON output.



## OpenAPI

````yaml /api-reference/v1/v1.1.0_openapi.json post /action/competitive_brief_run_full_brief
openapi: 3.0.0
info:
  version: 1.1.0
  title: AI Actions - Get Data
  description: API specifications for 'Get Data' category AI actions.
  license:
    name: MIT
servers:
  - url: https://api-lr.agent.ai/v1
security:
  - bearerAuth: []
paths:
  /action/competitive_brief_run_full_brief:
    post:
      tags:
        - Competitive Brief
      summary: '[CBFull] Run Full Competitive Brief'
      description: >-
        Generate a comprehensive competitive intelligence brief with all
        sections. Returns full JSON output.
      operationId: competitiveBriefRunFullBrief
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                company_name:
                  type: string
                  description: Name of your company.
                about:
                  type: string
                  x-ui: textarea
                  description: Brief description of what your company does.
                role:
                  type: string
                  enum:
                    - sales
                    - marketing
                    - product
                    - executive
                    - founder
                    - entrepreneur
                    - investor
                    - consultant
                    - business_development
                    - customer_success
                    - operations
                    - finance
                    - hr
                    - engineering
                    - other
                  description: Your role determines which insights are prioritized.
                  default: sales
                use_user_context_role:
                  type: boolean
                  description: >-
                    Use role from your user profile settings instead of the
                    dropdown above.
                  default: true
                use_full_user_context:
                  type: boolean
                  description: >-
                    Auto-generate about, industry, and keywords from your
                    profile data (company, title, LinkedIn, etc.) using AI.
                  default: true
                industry:
                  type: string
                  description: Your company's industry (e.g., SaaS, Healthcare, FinTech).
                industry_keywords:
                  type: string
                  description: Comma-separated industry keywords for better targeting.
                competitors:
                  type: string
                  x-ui: textarea
                  description: >-
                    List competitors in any format: 'Salesforce, HubSpot' or
                    'salesforce.com, hubspot.com' or JSON array. Will be
                    auto-parsed.
                brand_keywords:
                  type: string
                  description: Comma-separated brand keywords to monitor mentions.
                contacts:
                  type: string
                  x-ui: textarea
                  description: >-
                    List contacts in any format: names, LinkedIn URLs, emails,
                    or JSON. Will be auto-parsed.
                force_refresh:
                  type: boolean
                  description: Bypass cache and fetch fresh data.
                  default: false
                email:
                  type: string
                  description: Email address to send brief to (optional).
                send_email:
                  type: boolean
                  description: Send brief via email after generation.
                  default: false
                output_variable_name:
                  type: string
                  description: Variable name for the competitive brief JSON.
                  default: competitive_brief
                  pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
              required:
                - company_name
                - role
                - output_variable_name
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
        '401':
          description: Unauthorized - invalid or missing bearer token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
components:
  schemas:
    ActionResponse:
      type: object
      properties:
        status:
          type: integer
          format: int32
          description: HTTP status code of the action response
        response:
          type: object
          description: Response data from the action
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token from your account
        ([https://agent.ai/user/integrations#api](https://agent.ai/user/integrations#api))

````