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

# Detect Competitors

Gated by the `ai.deal_competitors` config feature flag — a `403` names the flag when disabled. This is a separate flag from the `ai.competitive_intelligence` flag that gates the full brief endpoints below.

The cheap sibling of the full brief — just names, no analysis. Requires the deal to have a linked account with a non-empty name. Runs a 4-step cascade (Perplexity → Exa fallback if fewer than 3 hits → LLM merge/dedup → pure LLM inference if nothing was found) and replaces the deal's `deal_competitors` rows with the result.

### Auth

Requires a CRM manage [scope](/authentication#scopes) and an active organization on the token. Any `*:manage` scope qualifies — in practice `contacts:manage`, `deals:manage`, `companies:manage`, or `activities:manage`.

### Response

| Field         | Type             | Description                                                                                                                                |
| ------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `success`     | `boolean`        |                                                                                                                                            |
| `skipped`     | `boolean`        | `true` if existing competitors were returned without re-running detection (when `force_refresh` is `false` and competitors already exist). |
| `competitors` | `string[]`       | Competitor names.                                                                                                                          |
| `source`      | `string \| null` | `perplexity` \| `exa` \| `inference`.                                                                                                      |
| `count`       | `integer`        |                                                                                                                                            |

### Errors

| Status | Cause                                                                                            |
| ------ | ------------------------------------------------------------------------------------------------ |
| `400`  | Deal has no linked account, or the account has no name.                                          |
| `403`  | `ai.deal_competitors` feature disabled.                                                          |
| `404`  | Deal not found.                                                                                  |
| `502`  | The entire detection cascade returned nothing (no API keys configured, or all providers failed). |


## OpenAPI

````yaml POST /deals/{deal_id}/competitors/detect
openapi: 3.1.0
info:
  title: anycrm-api
  version: 0.0.1
servers: []
security: []
tags:
  - name: Customer Intelligence
    description: >-
      Company research and ICP-fit scoring — create a research run, track its
      progress, and read back scored companies as leads.
  - name: Outreach
    description: >-
      The cold-email management console — domains, mailboxes, and campaigns — as
      a thin control plane over the SalesForge stack.
  - name: AnyCard
    description: >-
      Authenticated CRUD for AnyCard, the org's digital business-card /
      lead-capture product.
  - name: AnyCard Events
    description: >-
      Event-attribution analytics for AnyCard — which captured leads converted,
      broken down by source, owner, and deal.
  - name: AnyCard Share Links
    description: >-
      Unauthenticated endpoints reached by anyone who scans a QR code or opens a
      shared AnyCard link.
  - name: AI
    description: >-
      A streaming (SSE) AI chat endpoint with account-commit actions it can take
      on the caller's behalf.
  - name: Analytics Assistant
    description: >-
      The natural-language analytics assistant — a guarded text-to-SQL loop
      (SSE) that answers ad-hoc questions over the org's CRM data as a
      least-privilege, read-only database role.
  - name: Account Readiness
    description: >-
      Account Readiness Profiles — AI-scored signals on whether an account is
      ready for outreach or expansion, computed via a Temporal workflow.
  - name: Integrations
    description: >-
      Pipedream Connect — issuing connect tokens and managing the org's
      connected third-party accounts.
  - name: Feedback
    description: >-
      User-submitted platform feedback (bug reports, feature requests) — global,
      not scoped to one organization.
  - name: Public Media
    description: >-
      Unauthenticated image reads for publicly-embeddable assets (card photos,
      inline email images) — allowlisted by key shape; everything else in the
      storage bucket stays private.
  - name: Service Health
    description: Service liveness.
paths:
  /deals/{deal_id}/competitors/detect:
    post:
      tags:
        - Deals
      summary: Detect Deal Competitors
      operationId: detect_deal_competitors_deals__deal_id__competitors_detect_post
      parameters:
        - name: deal_id
          in: path
          required: true
          schema:
            type: string
            description: The deal's id.
            title: Deal Id
          description: The deal's id.
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/CompetitorDetectRequest'
                - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    CompetitorDetectRequest:
      properties:
        force_refresh:
          type: boolean
          title: Force Refresh
          description: >-
            Re-run detection even if competitors are already recorded on the
            deal.
          default: false
      type: object
      title: CompetitorDetectRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````