Skip to main content

jhf-spool API

Documentation Map​

API

Version: 2026-04-01

API Style​

  • protocol: HTTP/JSON
  • version surface: /v1
  • docs:
    • /openapi.json
    • /docs
    • /redoc

Auth​

Public reads:

  • /v1/health/live
  • /v1/health/ready
  • /v1/health/info
  • /v1/fabric/metadata
  • /v1/external-api-contract
  • GET /v1/release-notices

Authenticated routes:

  • ingest
  • search
  • articles
  • snapshots
  • exports
  • research runs
  • accounts
  • support
  • billing

Endpoint Groups​

Health and metadata​

  • GET /v1/health/live
  • GET /v1/health/ready
  • GET /v1/health/info
  • GET /v1/fabric/metadata
  • GET /metrics

GET /v1/health/info is the non-secret runtime readback surface. It exposes:

  • runtime environment name
  • sanitized dependency targets
  • runtime counts
  • runtime_config summary:
    • public_base_url
    • public_host
    • public_scheme
    • force_https_redirect
    • trusted_hosts
    • billing_provider

Ingest​

  • POST /v1/ingest/gdelt
  • POST /v1/ingest/ccnews
  • POST /v1/ingest/gdelt/backfill
  • POST /v1/ingest/ccnews/backfill
  • POST /v1/ingest/gdelt/current-events
  • POST /v1/ingest/ccnews/current-events
  • POST /v1/ingest/rss/backfill
  • POST /v1/ingest/rss/current-events
  • POST /v1/ingest/newsapi/backfill
  • POST /v1/ingest/newsapi/current-events
  • GET /v1/jobs/{job_id}

Search and retrieval​

  • POST /v1/search/semantic
  • POST /v1/search/filter
  • GET /v1/articles/{article_id}
  • GET /v1/articles/{article_id}/versions
  • GET /v1/articles/{article_id}/dedupe-cluster

Snapshot, export, research​

  • POST /v1/datasets/snapshots
  • GET /v1/datasets/snapshots/{snapshot_id}
  • POST /v1/exports/simulation
  • GET /v1/exports/{export_id}
  • POST /v1/research/runs
  • GET /v1/research/runs/{run_id}

Billing and support​

  • POST /v1/accounts/{account_id}/billing/checkout
  • POST /v1/accounts/{account_id}/billing/customer-portal
  • POST /v1/webhooks/paddle
  • POST /v1/accounts/{account_id}/support-cases
  • GET /v1/support-cases/{case_id}/evidence
  • POST /v1/support-cases/{case_id}/evidence/enrich

Operator/runtime views​

  • GET /v1/research/operational-dashboard-summary
  • GET /v1/research/operational-slo-gates
  • GET /v1/research/security-compliance-gates
  • GET /v1/research/incident-readiness-gates
  • GET /v1/research/security-pen-test-evidence
  • GET /v1/research/secret-readiness
  • GET /v1/research/paddle-readiness
  • GET /v1/research/tls-proxy-readiness

Versioning Logic​

The maintained HTTP contract is versioned primarily through /v1. Repository and deployment versioning are still git-commit based rather than semver-tag based.

Stability​

  • maintained /v1 routes documented in OpenAPI are the primary API contract
  • some research/governance routes are internal/operator-facing even though they are maintained
  • legacy /webhooks/* prototype routes are not a recommended integration surface

License: AGPLv3
Learn more: https://helpifyr.com