GetIntel api API

openapi: 3.1.0
info:
  title: GetIntel api API
  version: '2026-11-10'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-10: 7 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; GetIntel has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 13
    pages-with-code: 5
    pages-read: 19
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-10'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://getintel.ai/docs/api/authentication
  - https://getintel.ai/docs/api/errors-and-limits
  - https://getintel.ai/docs/api/examples
  - https://getintel.ai/docs/api/reference/operations/pages
  - https://getintel.ai/docs/api/reference/operations/reddit
  - https://getintel.ai/docs/api/reference/operations/task
  - https://getintel.ai/docs/api/reference/operations/topic
  x-docs-section: api
paths:
  /api/v1/${path}:
    get:
      operationId: get_api_v1_path
      tags:
      - Api
      summary: GET /api/v1/${path}
      x-source: https://getintel.ai/docs/api/examples
      parameters:
      - name: path
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch(`https://app.getintel.ai/api/v1/${path}`, {\x7F headers: { Authorization: `Bearer ${process.env.GETINTEL_API_KEY}` },\x7F\
          \ })"
  /api/v1/overview:
    get:
      operationId: get_api_v1_overview
      tags:
      - Api
      summary: GET /api/v1/overview
      x-source: https://getintel.ai/docs/api/authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://app.getintel.ai/api/v1/overview \\ -H \" Authorization: Bearer YOUR_API_KEY \" \n Create keys in Integrations →\
          \ Developers → GetIntel API . The full key is shown once, when you create it. After that GetIntel only shows its last 4 characters,\
          \ when it was created, who created it, and when it was last used. \n Keys are read-only. They can’t change anything in GetIntel. \n\
          \ Keys belong to the ac"
  /pages:
    get:
      operationId: get_pages
      tags:
      - Pages
      summary: Which of the brand’s own pages AI answers cite, now against the previous period, by engine and topic, and what AI cites instead
        for uncited topic pages.
      x-source: https://getintel.ai/docs/api/reference/operations/pages
      parameters:
      - name: brand_id
        in: query
        required: true
        schema:
          type: integer
        description: The brand to read, from GET /brands. Required when the account has more than one brand.
      - name: market
        in: query
        required: false
        schema:
          type: string
        description: 'The market to read, from GET /markets: its code (IN-hi, or just IN) or id. Default: the primary market.'
      - name: days
        in: query
        required: false
        schema:
          type: integer
        description: How many days back, ending today. Default 7. Ignored when from is given.
      - name: from
        in: query
        required: false
        schema:
          type: string
        description: Start date (YYYY-MM-DD). At most 90 days before to.
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: End date (YYYY-MM-DD). Default today.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPagesResponse'
      x-evidence:
        kind: documentation
  /reddit:
    get:
      operationId: get_reddit
      tags:
      - Reddit
      summary: Get Reddit signals
      x-source: https://getintel.ai/docs/api/reference/operations/reddit
      parameters:
      - name: brand_id
        in: query
        required: false
        schema:
          type: integer
        description: The brand to read, from GET /brands. Required when the account has more than one brand.
      - name: market
        in: query
        required: false
        schema:
          type: string
        description: 'The market to read, from GET /markets: its code (IN-hi, or just IN) or id. Default: the primary market.'
      - name: days
        in: query
        required: false
        schema:
          type: integer
        description: How many days back, ending today. Default 7. Ignored when from is given.
      - name: from
        in: query
        required: false
        schema:
          type: string
        description: Start date (YYYY-MM-DD). At most 90 days before to.
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: End date (YYYY-MM-DD). Default today.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Max threads per topic. Default 20.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRedditResponse'
      x-evidence:
        kind: documentation
  /tasks/{id}:
    get:
      operationId: get_tasks_id
      tags:
      - Tasks
      summary: Get a task
      x-source: https://getintel.ai/docs/api/reference/operations/task
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: brand_id
        in: query
        required: false
        schema:
          type: integer
        description: The brand to read, from GET /brands. Required when the account has more than one brand.
      - name: market
        in: query
        required: false
        schema:
          type: string
        description: 'The market to read, from GET /markets: its code (IN-hi, or just IN) or id. Default: the primary market.'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTasksIdResponse'
      x-evidence:
        kind: documentation
  /topics/{id}:
    get:
      operationId: get_topics_id
      tags:
      - Topics
      summary: Get a topic
      description: 'One topic in full: score and rivals, every buyer question with each engine’s latest answer, head-to-heads, top cited sources,
        score history and the content analysis (facts AI compares, what cited pages share).'
      x-source: https://getintel.ai/docs/api/reference/operations/topic
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: brand_id
        in: query
        required: false
        schema:
          type: integer
        description: The brand to read, from GET /brands. Required when the account has more than one brand.
      - name: market
        in: query
        required: false
        schema:
          type: string
        description: 'The market to read, from GET /markets: its code (IN-hi, or just IN) or id. Default: the primary market. Example IN-hi'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTopicsIdResponse'
      x-evidence:
        kind: documentation
  /usage:
    get:
      operationId: get_usage
      tags:
      - Usage
      summary: Get this month's usage
      x-source: https://getintel.ai/docs/api/errors-and-limits
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
security:
- bearer: []
components:
  schemas:
    GetPagesResponse:
      type: object
      properties:
        data:
          type: object
          description: required
        meta:
          type: object
          description: required
        api_version:
          type: string
          description: 'Example: v1'
        brand:
          type: object
          description: object with id (integer) and name (string)
        market:
          type: object
          description: object with id (integer), code (string), label (string)
    GetRedditResponse:
      type: object
      properties:
        data:
          type: object
          description: required
        meta:
          type: object
          description: required
        api_version:
          type: string
          description: 'Example: v1'
        brand:
          type: object
          description: object with id (integer) and name (string)
        market:
          type: object
          description: object with id (integer), code (string), label (string)
    GetTasksIdResponse:
      type: object
      properties:
        data:
          type: object
          description: required object
        meta:
          type: object
          description: required object
        api_version:
          type: string
          description: Example v1
        brand:
          type: object
          description: object with id, name, market
        brand.id:
          type: integer
        brand.name:
          type: string
        brand.market:
          type: object
        brand.market.id:
          type: integer
        brand.market.code:
          type: string
        brand.market.label:
          type: string
    GetTopicsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: object data required
        meta:
          type: object
          description: object meta required
        api_version:
          type: string
          description: Example v1
        brand:
          type: object
          description: brand object
        brand.id:
          type: integer
        brand.name:
          type: string
        brand.market:
          type: object
        brand.market.id:
          type: integer
        brand.market.code:
          type: string
        brand.market.label:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Api
- name: Pages
- name: Reddit
- name: Tasks
- name: Topics
- name: Usage