openapi: 3.2.0
info:
  title: CrawlGraph Free Key API
  description: Free backlink intelligence powered by Common Crawl's hyperlink graph.
  version: 1.2.2
tags:
- name: Free Key
paths:
  /api/v1/free-key:
    post:
      tags:
      - Free Key
      summary: Request Free Key
      description: 'Request a free-tier API key (15 backlink calls per month; gap

        analysis requires the $99 lifetime tier). The key is emailed to the address you provide - it is never

        returned in this response. One active key per email. Lifetime

        customers manage keys at /account instead.'
      operationId: request_free_key_api_v1_free_key_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FreeKeyRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                title: Response Request Free Key Api V1 Free Key Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AttributionPayload:
      properties:
        utm_source:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Utm Source
        utm_medium:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Utm Medium
        utm_campaign:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Utm Campaign
        utm_content:
          anyOf:
          - type: string
            maxLength: 128
          - type: 'null'
          title: Utm Content
        utm_term:
          anyOf:
          - type: string
            maxLength: 128
          - type: 'null'
          title: Utm Term
        landing_path:
          anyOf:
          - type: string
            maxLength: 256
          - type: 'null'
          title: Landing Path
        referrer_host:
          anyOf:
          - type: string
            maxLength: 253
          - type: 'null'
          title: Referrer Host
      type: object
      title: AttributionPayload
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FreeKeyRequest:
      properties:
        email:
          type: string
          format: email
          title: Email
        attribution:
          anyOf:
          - $ref: '#/components/schemas/AttributionPayload'
          - type: 'null'
      type: object
      required:
      - email
      title: FreeKeyRequest