replynodes-com Brand API

openapi: 3.2.0
info:
  title: ReplyNodes Fetcher Brand API
  version: v1
  description: 'Read-only data APIs for AI agents. Bearer auth. Prepaid credits / free tier.


    Click **Authorize** and paste ONLY the API key (no "Bearer" prefix) — Swagger adds it automatically.'
servers:
- url: https://api.replynodes.com
security:
- bearerAuth: []
tags:
- name: brand
paths:
  /{domain}:
    servers:
    - url: https://brand.replynodes.com
    get:
      operationId: anonymous_brand
      tags:
      - brand
      summary: Read public brand intelligence
      description: 'Already-anonymous Brand gateway route for canonical capability brand-kit (fixed Tier A: 20 valid requests per trusted client-IP bucket per UTC calendar day). Domain validation occurs before admission; cache hits and upstream failures consume one unit. X-RateLimit-Limit is the effective fixed tier limit, X-RateLimit-Remaining is the capability bucket balance, and X-RateLimit-Reset is the next UTC midnight Unix timestamp.'
      security: []
      parameters:
      - name: domain
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9.-]+$
      responses:
        '200':
          description: Brand intelligence response; quota headers are included.
        '400':
          description: Invalid or blocked domain.
        '429':
          description: Anonymous daily quota exhausted; includes typed continuation and standard quota headers.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
            X-RateLimit-Remaining:
              schema:
                type: integer
            X-RateLimit-Reset:
              schema:
                type: integer
            Retry-After:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnonymousQuotaError'
        '503':
          description: Shared Redis unavailable; request rejected closed.
  /v1/brand/retrieve:
    get:
      operationId: brand_retrieve
      summary: Retrieve Brand
      description: 'Resolve the full brand profile of a company by domain, or extract brand details from one specific page URL: name, description, primary logo, logos, colors, fonts, social links, favicon, and og_image.'
      tags:
      - brand
      parameters:
      - name: domain
        in: query
        required: false
        description: Company domain to resolve, e.g. apple.com. One of domain or url is required.
        schema:
          type: string
      - name: url
        in: query
        required: false
        description: One specific page URL to extract brand details from instead of the whole domain.
        schema:
          type: string
          format: uri
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Success response.
          headers:
            X-Request-Id:
              description: Correlation identifier echoed as meta.request_id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandRetrieveResponse'
        '400':
          description: Normalized error with code invalid_request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Normalized error with code rate_limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          headers:
            Retry-After:
              description: Seconds until the quota window resets.
              schema:
                type: integer
        '502':
          description: Normalized error with code upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Normalized error with code degraded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
  /v1/brand/search:
    get:
      operationId: brand_search
      summary: Search Brand
      description: Fuzzy brand or company search by name or domain; returns up to 10 lightweight matches with domain, name, and logo.
      tags:
      - brand
      parameters:
      - name: query
        in: query
        required: true
        description: Brand name or domain to search for.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum number of matches to return (default and maximum 10).
        schema:
          type: integer
          minimum: 1
          maximum: 10
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Success response.
          headers:
            X-Request-Id:
              description: Correlation identifier echoed as meta.request_id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandSearchResponse'
        '400':
          description: Normalized error with code invalid_request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Normalized error with code rate_limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          headers:
            Retry-After:
              description: Seconds until the quota window resets.
              schema:
                type: integer
        '502':
          description: Normalized error with code upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Normalized error with code degraded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
  /v1/brand/styleguide:
    get:
      operationId: brand_styleguide
      summary: Get Styleguide
      description: 'Extract the design system of a website by domain or URL: colors, typography, spacing, and more.'
      tags:
      - brand
      parameters:
      - name: domain
        in: query
        required: false
        description: Website domain to extract a styleguide from, e.g. replynodes.com. One of domain or url is required.
        schema:
          type: string
      - name: url
        in: query
        required: false
        description: One specific page URL to extract a styleguide from instead of the whole domain.
        schema:
          type: string
          format: uri
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Success response.
          headers:
            X-Request-Id:
              description: Correlation identifier echoed as meta.request_id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandStyleguideResponse'
        '400':
          description: Normalized error with code invalid_request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Normalized error with code rate_limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          headers:
            Retry-After:
              description: Seconds until the quota window resets.
              schema:
                type: integer
        '502':
          description: Normalized error with code upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Normalized error with code degraded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
  /v1/brand/fonts:
    get:
      operationId: brand_fonts
      summary: Get Fonts
      description: Extract the typography and font stack of a website by domain or URL.
      tags:
      - brand
      parameters:
      - name: domain
        in: query
        required: false
        description: Website domain to extract font information from, e.g. replynodes.com. One of domain or url is required.
        schema:
          type: string
      - name: url
        in: query
        required: false
        description: One specific page URL to extract font information from instead of the whole domain.
        schema:
          type: string
          format: uri
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Success response.
          headers:
            X-Request-Id:
              description: Correlation identifier echoed as meta.request_id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandFontsResponse'
        '400':
          description: Normalized error with code invalid_request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Normalized error with code rate_limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          headers:
            Retry-After:
              description: Seconds until the quota window resets.
              schema:
                type: integer
        '502':
          description: Normalized error with code upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Normalized error with code degraded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
  /v1/brand/logo:
    get:
      operationId: brand_logo
      summary: Get Brand Logo
      description: 'Fetch the brand logo kit for one company domain: primary logo URL, candidate logo variants, favicon, and og_image.'
      tags:
      - brand
      parameters:
      - name: domain
        in: query
        required: true
        description: 'Company domain to resolve, e.g. stripe.com. A bare domain only: no scheme, port, path, or credentials.'
        schema:
          type: string
      security: []
      responses:
        '200':
          description: Success response.
          headers:
            X-Request-Id:
              description: Correlation identifier echoed as meta.request_id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandLogoResponse'
        '400':
          description: Normalized error with code invalid_request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Normalized error with code rate_limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          headers:
            Retry-After:
              description: Seconds until the quota window resets.
              schema:
                type: integer
        '502':
          description: Normalized error with code upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '503':
          description: Normalized error with code degraded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    AnonymousContinuation:
      type: object
      required:
      - url
      properties:
        url:
          type: string
          format: uri
          const: https://replynodes.com/auth.md
    BrandRetrieveAsset:
      type: object
      required:
      - url
      properties:
        kind:
          type: string
        url:
          type: string
    BrandStyleguideResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            domain:
              type: string
            url:
              type: string
            status:
              type: string
            mode:
              type: string
            colors:
              type: array
              items:
                type: object
                properties:
                  role:
                    type: string
                  value:
                    type: string
                  source:
                    type: string
                  count:
                    type: integer
                additionalProperties: false
                required:
                - value
                - source
            typography:
              type: array
              items:
                type: object
                properties:
                  tag:
                    type: string
                  usage:
                    type: string
                  family:
                    type: string
                  size:
                    type: string
                  weight:
                    type: string
                  line_height:
                    type: string
                  source:
                    type: string
                additionalProperties: false
                required:
                - source
            buttons:
              type: array
              items:
                type: object
                properties:
                  variant:
                    type: string
                  background:
                    type: string
                  color:
                    type: string
                  border_radius:
                    type: string
                  padding:
                    type: string
                  font_weight:
                    type: string
                  source:
                    type: string
                additionalProperties: false
                required:
                - variant
                - source
            card:
              type: object
              properties:
                background:
                  type: string
                border_radius:
                  type: string
                box_shadow:
                  type: string
                padding:
                  type: string
                border:
                  type: string
                source:
                  type: string
              additionalProperties: false
              required:
              - source
            spacing:
              type: array
              items:
                type: string
            shadows:
              type: array
              items:
                type: string
            radii:
              type: array
              items:
                type: string
          additionalProperties: false
          required:
          - domain
          - url
          - status
        meta:
          $ref: '#/components/schemas/GatewayResponseMeta'
      additionalProperties: false
      required:
      - data
      - meta
    BrandRetrieveResponse:
      type: object
      required:
      - data
      - meta
      properties:
        data:
          type: object
          required:
          - domain
          - url
          properties:
            domain:
              type: string
            url:
              type: string
            name:
              type: string
            description:
              type: string
            favicon:
              type: string
            og_image:
              type: string
            primary_logo:
              type: string
            logos:
              type: array
              items:
                $ref: '#/components/schemas/BrandRetrieveAsset'
            backdrops:
              type: array
              items:
                $ref: '#/components/schemas/BrandRetrieveAsset'
            colors:
              type: array
              items:
                $ref: '#/components/schemas/BrandRetrieveColor'
            fonts:
              type: array
              items:
                type: string
            social_links:
              type: array
              items:
                type: string
        meta:
          type: object
          required:
          - request_id
          properties:
            request_id:
              type: string
            contract_version:
              type: string
            generated_at:
              type: string
              format: date-time
            availability:
              type: string
            detail:
              type: string
            missing_fields:
              type: array
              items:
                type: string
            next_cursor:
              type: string
            stale:
              type: boolean
    AnonymousQuotaError:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - request_id
          - continuation
          properties:
            code:
              const: anonymous_limit_reached
            message:
              type: string
              example: 'The anonymous daily limit has been reached. Get a free API key through the browser-approved claim flow described at https://replynodes.com/auth.md: 500 free credits are granted when the first long-lived API key is created and delivered.'
            request_id:
              type: string
            continuation:
              $ref: '#/components/schemas/AnonymousContinuation'
            next_action:
              $ref: '#/components/schemas/NextAction'
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
            retryable:
              type: boolean
            reason:
              type: string
            continuation:
              $ref: '#/components/schemas/AnonymousContinuation'
            status:
              type: integer
            detail:
              type: string
            readme:
              type: string
            next_action:
              $ref: '#/components/schemas/NextAction'
          additionalProperties: false
          required:
          - code
          - message
          - request_id
      additionalProperties: false
      required:
      - error
    NextAction:
      type: object
      description: Typed next step for an agent (ADR 0024). Present only where a next step exists; branch on action, never on message text.
      required:
      - action
      - method
      - url
      - required_fields
      - docs
      properties:
        action:
          type: string
          enum:
          - get_api_key
          - verify_email
          - resend_code
          - renew_key
          - top_up
          - retry_later
          description: Closed set; values may be added, never renamed or removed.
        method:
          type: string
          enum:
          - GET
          - POST
        url:
          type: string
          format: uri
        required_fields:
          type: array
          items:
            type: string
        optional_fields:
          type: array
          items:
            type: string
        human_message:
          type: string
          description: Short sentence the agent can show its human.
        docs:
          type: string
          format: uri
        retry_after_seconds:
          type: integer
          minimum: 1
          description: When the same request may be retried without completing the action.
        auth:
          type: string
          enum:
          - bearer_api_key
          description: Credential the call needs; bearer_api_key means send the same API key as a Bearer token.
      additionalProperties: false
    BrandLogoData:
      type: object
      required:
      - url
      properties:
        url:
          type: string
          format: uri
          description: The snapshot target URL the logos were extracted from.
        brand:
          type: object
          properties:
            name:
              type: string
              description: Public site/brand name detected on the page, when available.
            logo_url:
              type: string
              format: uri
              description: Primary brand logo URL, when available.
            logos:
              type: array
              items:
                type: object
                properties:
                  kind:
                    type: string
                    description: Asset slot and format (e.g. logo.svg, favicon.ico).
                  url:
                    type: string
                    format: uri
              description: Candidate logo variants detected on the page.
            favicon_url:
              type: string
              format: uri
            og_image:
              type: string
              format: uri
      additionalProperties: false
    BrandRetrieveColor:
      type: object
      required:
      - hex
      properties:
        hex:
          type: string
        usage:
          type: string
        count:
          type: integer
          format: int64
    ResponseMeta:
      type: object
      required:
      - request_id
      properties:
        request_id:
          type: string
        contract_version:
          type: string
        generated_at:
          type: string
          format: date-time
        availability:
          type: string
        next_cursor:
          type: string
        missing_fields:
          type: array
          items:
            type: string
        stale:
          type: boolean
      additionalProperties: true
    GatewayResponseMeta:
      type: object
      required:
      - request_id
      properties:
        request_id:
          type: string
        contract_version:
          type: string
        generated_at:
          type: string
          format: date-time
        availability:
          type: string
        detail:
          type: string
        missing_fields:
          type: array
          items:
            type: string
        next_cursor:
          type: string
        stale:
          type: boolean
      additionalProperties: false
    BrandFontsData:
      type: object
      required:
      - domain
      - url
      - count
      properties:
        domain:
          type: string
        url:
          type: string
          format: uri
        count:
          type: integer
          minimum: 0
        words_count:
          type: integer
          minimum: 0
          description: Word count reported by the rendered page metadata, when available.
        fonts:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: false
    BrandFontsResponse:
      type: object
      required:
      - data
      - meta
      properties:
        data:
          $ref: '#/components/schemas/BrandFontsData'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      additionalProperties: false
    BrandLogoResponse:
      type: object
      required:
      - data
      - meta
      properties:
        data:
          $ref: '#/components/schemas/BrandLogoData'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      additionalProperties: false
    BrandSearchResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            query:
              type: string
            count:
              type: integer
            matches:
              type:
              - array
              - 'null'
              items:
                type: object
                properties:
                  name:
                    type: string
                  domain:
                    type: string
                  url:
                    type: string
                  favicon:
                    type: string
                  description:
                    type: string
                additionalProperties: false
                required:
                - domain
          additionalProperties: false
          required:
          - query
          - count
          - matches
        meta:
          $ref: '#/components/schemas/GatewayResponseMeta'
      additionalProperties: false
      required:
      - data
      - meta
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: rn_test_<64hex> or rn_live_<64hex>
      description: API key. Paste the raw key only (e.g. rn_test_...) — the "Bearer " prefix is added automatically.