HTTPeep API

openapi: 3.1.0
info:
  title: HTTPeep API
  version: '2026-10-18'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-18: 5 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; HTTPeep has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 0
    pages-with-code: 4
    pages-read: 4
  x-source-kind: mostly-language-sdk-reference
  x-source-caveat: 'all but one page read was a language SDK reference (a client library) rather than a REST reference: paths and methods are
    the ones those pages name'
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-18'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.httpeep.com/skills/httpeep-cli
  - https://docs.httpeep.com/cli/shell
  - https://docs.httpeep.com/cli/overview
  - https://docs.httpeep.com/cli/sessions
paths:
  /api/search:
    get:
      operationId: get_api_search
      tags:
      - Api
      summary: GET /api/search
      x-source: https://docs.httpeep.com/skills/httpeep-cli
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -v http://localhost:3000/api/search?q=test \n If your app runs on a different port, use that port instead. You can also\
          \ trigger the request from a browser or from the UI if that is how the bug reproduces. \n Then ask the agent: \n Use HTTPeep to inspect\
          \ the traffic from the Next.js dev server. Find the request triggered by /api/search, check the upstream URL, method, status, response\
          \ body, and t"
  /get:
    get:
      operationId: get_get
      tags:
      - Get
      summary: GET /get
      x-source: https://docs.httpeep.com/skills/httpeep-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -v https://httpbin.org/get \n Then ask the agent: \n Use HTTPeep to inspect the curl request I just sent. Show the method,\
          \ URL, status, headers that matter, and timing. Redact secrets. \n The agent can query: \n httpeep-cli --format json sessions list --process-name-like\
          \ curl \n hp shell is interactive and intentionally takes over the terminal until you exit the child shell. For unattended automat"
  /health:
    get:
      operationId: get_health
      tags:
      - Health
      summary: GET /health
      x-source: https://docs.httpeep.com/cli/shell
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -v https://api.example.com/health \n exit \n For non-interactive automation, prefer explicit environment variables or command-specific\
          \ proxy flags so scripts do not block inside an interactive shell. \n For launching desktop applications or browsers with capture enabled,\
          \ use hp launch instead. \n hp shell is also used by hp record start --shell workflows so recorded terminal traffic goes through "
  /users:
    get:
      operationId: get_users
      tags:
      - Users
      summary: GET /users
      x-source: https://docs.httpeep.com/cli/overview
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://api.example.com/users \n exit \n Launch Chrome and watch new captures \n hp launch chrome --url \"https://example.com\"\
          \ --watch \n Send a request and inspect the result \n hp --format json request --method GET --url \"https://httpbin.org/get\" \n hp\
          \ sessions list --keyword httpbin \n Apply a temporary redirect and auto-rollback \n hp rules run  --map-remote \"api.example.com=http://127.0.0.1:3000\""
  /v2/users:
    get:
      operationId: get_v2_users
      tags:
      - Users
      summary: GET /v2/users
      x-source: https://docs.httpeep.com/skills/httpeep-cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl , local dev servers, Node.js scripts, Python scripts, Rust binaries, SDKs, and other command-line tools. \n Find the relevant\
          \ request - filter sessions by keyword, domain, status code, URL, process name, or process ID. \n Inspect request and response details\
          \ - review method, URL, headers, body, status code, redirects, timing, and process metadata. \n Replay requests - reproduce a captured\
          \ reques"
tags:
- name: Api
- name: Get
- name: Health
- name: Users