Hyperresearch

Hyperresearch Vault API

The vault API from Hyperresearch — 27 operation(s) for vault.

GitHub OpenAPI

Operations 31

POST /v1/admin/backfills/note-titles Re-derive stored note titles through the title rule #
POST /v1/vault/fetch Fetch one URL into the vault #
GET /v1/vault/status Vault status counters #
GET /v1/vault/notes List notes #
POST /v1/vault/notes Create a note #
POST /v1/vault/notes/batch Read up to 50 notes (fenced by default) #
GET /v1/vault/notes/{id} Read a note (fenced when fetched from the web) #
PATCH /v1/vault/notes/{id} Update status, tags, summary, scores #
DELETE /v1/vault/notes/{id} Delete a note and its index rows #
GET /v1/vault/search Search the workspace vault (hybrid by default) #
GET /v1/vault/hubs Most-linked notes #
GET /v1/vault/tags Tag census #
POST /v1/vault/sources/check Dedup check for a URL #
GET /v1/vault/sources Provenance ledger #
GET /v1/vault/claims Claims for a note or run #
POST /v1/vault/claims Ingest fetcher-extracted claims (idempotent) #
GET /v1/vault/claims/search Full-text search over extracted claims #
GET /v1/vault/run-notes Notes written by a run #
POST /v1/vault/export Export the workspace vault (async job) #
POST /v1/vault/import Import a vault archive (async job) #
POST /v1/vault/import-uploads Start a resumable vault import upload #
PUT /v1/vault/import-uploads/{id}/parts/{part} Upload one fixed-size vault archive part #
POST /v1/vault/import-uploads/{id}/complete Assemble a resumable vault upload and queue import #
DELETE /v1/vault/import-uploads/{id} Abort a resumable vault upload #
GET /v1/jobs/{id} Poll a vault job #
GET /v1/escalations List escalations #
POST /v1/escalations/{id}/claim Claim a queued escalation (queued → in_progress) #
POST /v1/escalations/{id}/raw/{filename} Upload the rescued artifact bytes (R2 `raw/*` only — never indexed) #
POST /v1/escalations/{id}/resolve Resolve: extracted text becomes a raw note (upload → extract → note) #
POST /v1/escalations/{id}/abandon Abandon an escalation with audit detail #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hyperresearch-ai/openapi/hyperresearch-ai-vault-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/hyperresearch-ai/json-schema/hyperresearch-ai-run-status-schema.json
📊
JSONSchema
https://artifacts.apis.io/hyperresearch-ai/json-schema/hyperresearch-ai-usage-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/hyperresearch-ai/json-schema/hyperresearch-ai-run-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/hyperresearch-ai/json-schema/hyperresearch-ai-run-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/hyperresearch-ai/json-schema/hyperresearch-ai-answer-search-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/hyperresearch-ai/json-schema/hyperresearch-ai-operator-run-detail-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hyperresearch-ai:hyperresearch-ai-vault-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hyperresearch-ai-vault-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: hyperresearch Cloud Vault API
  version: 1.0.0
  description: 'REST v1 for hosted hyperresearch runs, vault access, verification, and billing. Times are RFC 3339 UTC; ids are prefixed ULIDs.


    **Authentication.** Send an API key as `Authorization: Bearer hr_live_…`. Each operation lists the scope it needs (`x-hr-scope`, and in its `security` requirement). OAuth 2.1 (authorization code + PKCE, `oauth2` scheme) issues tokens for the hosted MCP server at https://mcp.hyperresearch.ai/mcp; REST calls use an API key.


    **Errors.** Every 4xx/5xx body is the `ErrorEnvelope`: `error.type`, a stable `error.code`, a human `message`, the offending `param` when there is one, and the `request_id` to quote to support. Branch on `code`, never on `message`.


    **Rate limits.** Responses carry `RateLimit-Policy` and `RateLimit` (draft-ietf-httpapi-ratelimit-headers) alongside the older `X-RateLimit-*` headers. A 429 always carries `Retry-After` (seconds) and `error.retry_after`.


    **Versioning.** The version is in the path. `/v1` is stable: within it, changes are additive only (new operations, new optional request fields, new response fields, new enum values a client must tolerate). A breaking change ships only under a new path version. A deprecated operation is marked `deprecated: true` here and answers with `Deprecation` (RFC 9745) and `Sunset` (RFC 8594) headers and `Link: rel="deprecation"` at least six months before it is removed, and is listed under Deprecations on the policy page: https://hyperresearch.ai/docs/versioning'
  contact:
    name: hyperresearch
    url: https://hyperresearch.ai
  x-api-lifecycle:
    version_scheme: path
    current: v1
    status: stable
    breaking_changes: new path version only
    deprecation_notice_min_days: 182
    deprecation_signals:
    - 'openapi deprecated: true'
    - Deprecation header (RFC 9745)
    - Sunset header (RFC 8594)
    - Link rel="deprecation"
    - policy page deprecations list
    policy: https://hyperresearch.ai/docs/versioning
servers:
- url: https://api.hyperresearch.ai
  description: production
tags:


# --- truncated at 32 KB (136 KB total) ---
# Full source: https://artifacts.apis.io/hyperresearch-ai/openapi/hyperresearch-ai-vault-api-openapi.yml