replynodes-com Web Search API

openapi: 3.2.0
info:
  title: ReplyNodes Fetcher Web Search 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: web_search
paths:
  /v1/web/search:
    get:
      operationId: web_search
      summary: Search the public web
      description: 'Search the public web (English only) through the SearXNG-backed provider contract v2. The response `data` is an array of records (id, platform, one-based page rank, title, snippet, domain, url, engines), `pagination` is `{page, next_page: null, has_more: null}` (continuation is never promised; request another page explicitly), and `meta` carries `contract_version: v2`, `generated_at`, `source: searxng`, `availability` (`complete` or `partial`), `engines_requested` and `engines_failed`. A partial response is still billed as a successful read; a response with no verified engine execution is a 502.'
      tags:
      - web_search
      parameters:
      - name: q
        in: query
        required: true
        description: Search query text (1..512 bytes, no control characters). Tokens starting with `!`, `:` or `<` are reserved and rejected; ordinary `site:example.com` text is passed through as search syntax, not a guaranteed filter.
        schema:
          type: string
          minLength: 1
          maxLength: 512
      - name: language
        in: query
        required: false
        description: 'Result language. English only: `en-US` (default) or `en-GB`.'
        schema:
          type: string
          enum:
          - en-US
          - en-GB
          maxLength: 16
      - name: engines
        in: query
        required: false
        description: Optional comma-separated approved engines (`brave`, `bing`). Omit to use the default primary/fallback chain.
        schema:
          type: string
          maxLength: 64
      - name: page
        in: query
        required: false
        description: Page number. The current engine profile supports pages 1-2 (Brave); higher pages are rejected with 400 invalid_request until more are verified.
        schema:
          type: integer
          minimum: 1
          maximum: 2
          default: 1
      - name: time_range
        in: query
        required: false
        description: Recency filter. Only `week` is supported by the current engine profile; `day` and `month` are rejected until verified. Not available when the Bing fallback would be needed (page 1 without a time range only).
        schema:
          type: string
          enum:
          - week
      - name: limit
        in: query
        required: false
        description: Maximum records returned from the merged page (1..50). Truncation only; never an offset or cursor.
        schema:
          type: integer
          minimum: 1
          maximum: 50
          default: 10
      security: []
      responses:
        '200':
          description: 'Success response with the v2 web-search payload: data (records), pagination (never promises continuation) and meta (availability complete or partial).'
          headers:
            X-Request-Id:
              description: Correlation identifier echoed as meta.request_id.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebSearchResponse'
        '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
    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
    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
    WebSearchPagination:
      type: object
      required:
      - page
      - next_page
      - has_more
      additionalProperties: false
      properties:
        page:
          type: integer
          minimum: 1
        next_page:
          type:
          - integer
          - 'null'
          description: 'Always null: continuation is never promised.'
        has_more:
          type:
          - boolean
          - 'null'
          description: 'Always null: continuation is never promised.'
    WebSearchData:
      type: object
      required:
      - data
      - pagination
      - meta
      additionalProperties: false
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WebSearchRecord'
        pagination:
          $ref: '#/components/schemas/WebSearchPagination'
        meta:
          $ref: '#/components/schemas/WebSearchMeta'
    WebSearchMeta:
      type: object
      required:
      - contract_version
      - generated_at
      - source
      - availability
      - engines_requested
      - engines_failed
      additionalProperties: false
      properties:
        contract_version:
          type: string
          enum:
          - v2
        generated_at:
          type: string
          format: date-time
          description: When the original upstream result was generated; preserved on cache hits.
        source:
          type: string
          enum:
          - searxng
        availability:
          type: string
          enum:
          - complete
          - partial
        engines_requested:
          type: array
          items:
            type: string
        engines_failed:
          type: array
          items:
            type: string
    WebSearchRecord:
      type: object
      required:
      - id
      - platform
      - rank
      - title
      - snippet
      - domain
      - url
      - engines
      additionalProperties: false
      properties:
        id:
          type: string
          description: web-search:s_ followed by the lowercase SHA-256 hex of the canonical URL.
        platform:
          type: string
          enum:
          - web-search
        rank:
          type: integer
          minimum: 1
          description: One-based position within the returned page; never a global rank.
        title:
          type:
          - string
          - 'null'
        snippet:
          type:
          - string
          - 'null'
        domain:
          type:
          - string
          - 'null'
        url:
          type: string
          format: uri
        engines:
          type: array
          items:
            type: string
          description: Engines that actually returned this record; empty when provenance is unknown.
    WebSearchResponse:
      type: object
      required:
      - data
      - meta
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/WebSearchData'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
  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.