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

# Generate a pain-points report (1 credit)

> Start generating the full pain-points report for a product. **Spends 1 credit.**
Generation is asynchronous (2-3 minutes): this returns `status: generating`
immediately - poll `GET /products/{id}/pain-points` (with your key) for the
finished report. No charge if a report is already generating. Requires a **spend
budget** on the credential (per-key spend cap, or an OAuth connection's
consent-time credit budget).




## OpenAPI

````yaml /openapi.yaml post /products/{id}/generate-report
openapi: 3.1.0
info:
  title: Reechee Developer Platform API
  version: 1.0.0
  description: >
    The Reechee REST API exposes software-review pain points, buying signals,
    and

    sales opportunities.


    Two auth lanes share one base URL:


    - **Anonymous** (no key) - read-only, IP rate-limited. Product search, a
    free
      pain-points taste, and category competitors.
    - **API key** (`Authorization: Bearer rch_live_…`) - paid teams get full
      pain-point reports, opportunities, watchlist, credit balance, and safe write
      actions (follow/unfollow, triage).

    Every response uses a consistent envelope: `{ "success": true, "data": … }`
    on

    success (with an optional `meta`), or `{ "success": false, "error": {
    "code",

    "message", "details"? } }` on failure.
  contact:
    name: Reechee
    url: https://reechee.io
servers:
  - url: https://app.reechee.io/api/v1
    description: Production
security: []
tags:
  - name: System
    description: Health and connectivity.
  - name: Products
    description: Search products and read their pain points and competitors.
  - name: Opportunities
    description: Read and triage sales opportunities (API key required).
  - name: Watchlist
    description: Read and manage the team's followed products (API key required).
  - name: Account
    description: Team account data such as credit balance (API key required).
  - name: Credits
    description: >-
      Credit-spending actions (Tier 3). Requires a spend budget on the
      credential - a per-key spend cap for API keys, or the consent-time credit
      budget for OAuth connections.
paths:
  /products/{id}/generate-report:
    post:
      tags:
        - Credits
      summary: Generate a pain-points report (1 credit)
      description: >
        Start generating the full pain-points report for a product. **Spends 1
        credit.**

        Generation is asynchronous (2-3 minutes): this returns `status:
        generating`

        immediately - poll `GET /products/{id}/pain-points` (with your key) for
        the

        finished report. No charge if a report is already generating. Requires a
        **spend

        budget** on the credential (per-key spend cap, or an OAuth connection's

        consent-time credit budget).
      operationId: generatePainPointsReport
      parameters:
        - $ref: '#/components/parameters/ProductId'
      responses:
        '200':
          description: Generation started (or already in progress).
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/GenerateReportResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/SpendCapRequired'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          description: Report generation is temporarily unavailable; no credit was charged.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: internal_error
                  message: >-
                    Report generation service unavailable. No credit was
                    charged.
      security:
        - bearerAuth: []
components:
  parameters:
    ProductId:
      name: id
      in: path
      required: true
      description: Product id (uuid).
      schema:
        type: string
        format: uuid
  schemas:
    GenerateReportResponse:
      type: object
      required:
        - status
        - message
      properties:
        status:
          type: string
          const: generating
        message:
          type: string
        credits_remaining:
          type: integer
          description: Present when generation was newly started (a credit was spent).
        already_in_progress:
          type: boolean
          description: Present and true when a report was already generating (no charge).
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - payment_required
                - forbidden
                - not_found
                - rate_limited
                - internal_error
            message:
              type: string
            details:
              type:
                - object
                - 'null'
              additionalProperties: true
  responses:
    Unauthorized:
      description: A valid API key is required (or the key was invalid/revoked/expired).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: unauthorized
              message: API key required
    PaymentRequired:
      description: >
        The credit-spending call was blocked for payment reasons.
        `details.reason`

        distinguishes the two cases:


        - `spend_cap_reached` - the credential's rolling 30-day spend budget
        (per-key
          cap, or an OAuth connection's credit budget) would be exceeded; carries
          `spend_cap`, `spend_used`, `spend_remaining`, `credits_required`.
        - `out_of_credits` - the team's credit balance is too low; carries
          `credits_required` and `credits_remaining`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: payment_required
              message: API key spend cap reached
              details:
                reason: spend_cap_reached
                spend_cap: 100
                spend_used: 100
                spend_remaining: 0
                credits_required: 1
    SpendCapRequired:
      description: >
        The credential has no spend budget. Credit-spending (Tier 3) actions
        require one

        as a safety guardrail - for API keys, set a per-key spend cap in
        Settings → API

        keys; for OAuth connections, reconnect and allow a credit budget on the
        consent

        screen.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: forbidden
              message: >-
                This API key has no spend cap. Set a per-key spend cap in
                Settings to enable credit-spending tools.
              details:
                reason: spend_cap_required
    NotFound:
      description: The resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: not_found
              message: Resource not found
    RateLimited:
      description: |
        The rate limit was exceeded. The response carries `Retry-After` and
        `X-RateLimit-*` headers.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests allowed in the window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests remaining in the window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix seconds when the window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: rate_limited
              message: Rate limit exceeded
              details:
                retry_after_seconds: 12
                limit: 60
                remaining: 0
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: rch_live_…
      description: >
        A paid-team API key, sent as `Authorization: Bearer rch_live_…`. Create
        and

        revoke keys in the app under Settings → API keys.

````