Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Hugging Bay Public Analytics API
version: 0.2.0
summary: AI artifact discovery, provenance, hosted/external state, and mirror demand APIs.
x-agent-quickstart: '## Connect your agent
One live call; public reads need no key:
```sh
curl -fsS ''https://huggingbay.xyz/api/mcp'' -H ''Content-Type: application/json'' -d ''{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"search_artifacts","arguments":{"q":"Qwen2.5 0.5B GGUF","limit":5}}}''
```
Hosted MCP: Streamable HTTP `https://huggingbay.xyz/api/mcp`. No key for reads. Inspect tools/list.
Claude Code: `claude mcp add --transport http hugging-bay https://huggingbay.xyz/api/mcp`
Codex CLI: `codex mcp add hugging-bay --url https://huggingbay.xyz/api/mcp`. Public reads need no OAuth login.
Cursor: add {"mcpServers":{"hugging-bay":{"url":"https://huggingbay.xyz/api/mcp"}}} to .cursor/mcp.json.
ChatGPT: On ChatGPT web, open Plugins → + → Add custom MCP server. Name it hugging-bay, paste this remote MCP URL, choose no authentication, and review the search and fetch tools for public catalog reads. Availability depends on your account and workspace permissions. This custom connection is separate from the private bundled plugin; public-directory approval remains separate. URL: https://huggingbay.xyz/chatgpt/mcp
Stdio (Node.js 18+): `npx -y hugging-bay-mcp@0.1.13`; list tools.
On 2026-10-29 the official MCP Registry listed io.github.barneywohl/hugging-bay 0.1.13 as active and latest.
The call returns a live catalog row. Read its file and license details before downloading.
Fit is an estimate. A hash checks bytes; it does not prove a run, safety or license permission.'
description: 'Agents can request models, features, tools and builds, get an id, check the status of each request, and read a public changelog of what shipped. Missing a model, file, tool or feature? Ask with request_feature (MCP) or POST https://huggingbay.xyz/api/v1/requests. No account. You get an id and can check its status. What shipped: https://huggingbay.xyz/changelog Start at /api/index.json for bounded open-model and dataset discovery, license and provenance metadata, hosted-file evidence, MCP profiles and explicit execution boundaries. Catalog inclusion is not proof of byte availability, runtime readiness or quality. Authenticated operations require the documented scopes; discovery never grants authority to execute them.
**Data freshness.** `degraded` means a fresh complete read was unavailable; `stale` means earlier snapshot data is being shown. Neither flag grants download or execution permission. See `x-data-freshness`.
**Private notifications.** The site''s `/v1/notify/*` browser/email routes are listed under `x-private-routes`, including their paused and one-click behavior.'
x-changelog:
- version: 0.2.0
date: '2026-10-16'
changes:
- 'Identified the Round 9 path addition: POST /api/events/a2hs (createA2hsEvent), the aggregate home-screen tip counter added on 2026-10-15. Its schema requires event, surface and platform plus the same-origin CSRF header; it stores no visitor identifiers.'
- Clarified IP and route-group read budgets, uncached RateLimit headers, and the separate live database concurrency admission limits under x-rate-limit.admission. Capacity 503s do not imply a fixed requests-per-second throttle.
- /api/programs is not served on huggingbay.xyz or run.huggingbay.xyz. Read hosted Bay Run Pins at https://run.huggingbay.xyz/v1/pins; the separate browser model manifest is https://huggingbay.xyz/run/api/programs.
- version: 0.2.0
date: '2026-10-12'
changes:
- Hosted-file JSONL routes and their latest-data alias return JSON errors instead of zero-byte successful downloads when no rows are available; nonempty dumps retain their row format and continuation links.
- Unknown agent-request ids return request_not_found, including malformed ids. /changelog/ redirects to /changelog, which shares agent-request shipping entries with /api/v1/changelog; /what-changed remains the separate serve-decision feed.
- OpenAPI contract version follows this changelog instead of the MCP package version. Data freshness flags and private browser notification routes are documented separately from public SDK operations.
- version: 0.2.0
date: '2026-09-21'
changes:
- 'Consolidated developer reference: the authentication policy, the rate-limit policy (x-rate-limit), the error taxonomy (x-error-taxonomy), this changelog (x-changelog) and a loud deprecated-alias map (x-deprecated-aliases) are now carried in this one document, so openapi.json is the single source instead of the scattered install/PyPI/blackboard/SKILL surfaces.'
- Published a pointer to the observed remote MCP tools/list contract (x-mcp) so an agent can discover the model-discovery and download tools, not only the fixed Bay Run demo Pins.
- version: 0.2.0
date: '2026-09-20'
changes:
- 'General API error envelope: { error, code, status, message, requestId, next:{action,href} }; notification routes have separate documented shapes. nextAction and docsRef remain as deprecated aliases.'
- recorded-vs-alias markers (x-primary, x-primary-path, x-aliases) and near-synonym disambiguation (x-route-family, x-use-when) on every duplicated route.
- 'Runnable examples: request parameter examples, a JSON response example and an x-codeSamples curl recipe on the core operations.'
- 'Edge validation: malformed numeric query parameters are rejected with 400 invalid_query before reaching the database.'
- version: 0.2.0
date: '2026-09-19'
changes:
- 'Developer on-ramp: /quickstart (get a key, first call, serve a model), the rendered reference at /docs/api (Redoc over this spec), self-serve reader tokens, and an llms.txt mirror of the same steps.'
servers:
- url: https://huggingbay.xyz
tags:
- name: Analytics
paths:
/api/events/page:
post:
operationId: createEventsPage
tags:
- Analytics
summary: Record a privacy-bucketed page event
description: 'Used by the web app and trusted clients to capture aggregate page demand. The public traffic API returns only rollups, never raw visitor keys, IPs, user agents, or referrers.
**Inputs.** No path or query fields are required. The request body schema lists accepted fields and required values.
**Outputs.** See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.
**Errors.** API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.
**Rate limits.** Write and protocol operations can have separate route-specific limits. Read Retry-After and retry_after_s when present; do not infer a write allowance from the public read budget.
**Example setup.** This example is not executed by documentation checks. Review the operation and obtain any required user consent before sending it.'
requestBody:
content:
application/json:
schema:
type: object
properties:
path:
type: string
route:
type: string
title:
type: string
referrer:
type: string
additionalProperties: true
responses:
'202':
description: Event accepted or safely ignored when persistence is unavailable
content:
application/json:
schema:
type: object
required:
- ok
- recorded
properties:
ok:
type: boolean
recorded:
type: boolean
trafficClass:
type: string
additionalProperties: true
headers:
X-HB-Backoff:
description: Optional v1 backoff contract marker; rollout defaults off.
schema:
type: string
X-HB-Admission:
description: Optional open, busy or limited; a process-local observation, not a reservation.
schema:
type: string
X-HB-Capacity:
description: Optional process-local heavy/bytes active, limit and remaining counts plus observed epoch seconds. Cached observations may be old.
schema:
type: string
x-idempotency-key:
supported: false
behavior: This endpoint does not implement Idempotency-Key; the header is ignored. Do not assume that retrying a write is safe.
x-request-example:
method: POST
url: https://huggingbay.xyz/api/events/page
headers:
Content-Type: application/json
body: {}
parameters: []
prerequisites:
- This example is not executed by documentation checks. Review the operation and obtain any required user consent before sending it.
verification: Request template. Not a captured live response.
curl: 'curl -sS -X POST ''https://huggingbay.xyz/api/events/page'' -H ''Content-Type: application/json'' --data-raw ''{}'''
x-codeSamples:
- lang: Shell
label: curl request
source: 'curl -sS -X POST ''https://huggingbay.xyz/api/events/page'' -H ''Content-Type: application/json'' --data-raw ''{}'''
x-rate-limit:
policy: '#/x-rate-limit'
summary: Write and protocol operations can have separate route-specific limits. Read Retry-After and retry_after_s when present; do not infer a write allowance from the public read budget.
x-error-contract:
schema: '#/components/schemas/ErrorEnvelope'
note: API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.
/api/events/a2hs:
post:
operationId: createA2hsEvent
tags:
- Analytics
summary: Increment a privacy-minimal home-screen aggregate counter
description: 'In-process UTC-day totals retained for 14 days. No visitor identifiers or free-text fields. Respects telemetry opt-outs. Cumulative totals are logged at most once per ten minutes.
**Inputs.** Path, query and header fields are listed below. The request body schema lists accepted fields and required values.
**Outputs.** See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.
**Errors.** API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.
**Rate limits.** Write and protocol operations can have separate route-specific limits. Read Retry-After and retry_after_s when present; do not infer a write allowance from the public read budget.
**Example setup.** This example is not executed by documentation checks. Review the operation and obtain any required user consent before sending it.'
parameters:
- name: X-Hugging-Bay-CSRF
in: header
required: true
schema:
const: '1'
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- event
- surface
- platform
properties:
event:
type: string
enum:
- shown
- dismissed
- installed
- launched
surface:
type: string
enum:
- home
- run
platform:
type: string
enum:
- ios-safari
- android-chrome
- standalone
- none
responses:
'202':
description: Counter recorded or telemetry opted out
content:
application/json:
schema:
type: object
additionalProperties: true
description: Counter recorded or telemetry opted out. Fields can vary; no stronger field guarantee is specified for this operation.
headers:
X-HB-Backoff:
description: Optional v1 backoff contract marker; rollout defaults off.
schema:
type: string
X-HB-Admission:
description: Optional open, busy or limited; a process-local observation, not a reservation.
schema:
type: string
X-HB-Capacity:
description: Optional process-local heavy/bytes active, limit and remaining counts plus observed epoch seconds. Cached observations may be old.
schema:
type: string
'403':
description: Same-origin request and CSRF header required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
headers:
X-HB-Backoff:
description: Optional v1 backoff contract marker; rollout defaults off.
schema:
type: string
X-HB-Admission:
description: Optional open, busy or limited; a process-local observation, not a reservation.
schema:
type: string
X-HB-Capacity:
description: Optional process-local heavy/bytes active, limit and remaining counts plus observed epoch seconds. Cached observations may be old.
schema:
type: string
'422':
description: invalid_a2hs_event
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
headers:
X-HB-Backoff:
description: Optional v1 backoff contract marker; rollout defaults off.
schema:
type: string
X-HB-Admission:
description: Optional open, busy or limited; a process-local observation, not a reservation.
schema:
type: string
X-HB-Capacity:
description: Optional process-local heavy/bytes active, limit and remaining counts plus observed epoch seconds. Cached observations may be old.
schema:
type: string
x-idempotency-key:
supported: false
behavior: This endpoint does not implement Idempotency-Key; the header is ignored. Do not assume that retrying a write is safe.
x-request-example:
method: POST
url: https://huggingbay.xyz/api/events/a2hs
headers:
X-Hugging-Bay-CSRF: '1'
Content-Type: application/json
body:
event: shown
surface: home
platform: ios-safari
parameters:
- name: X-Hugging-Bay-CSRF
in: header
value: '1'
prerequisites:
- This example is not executed by documentation checks. Review the operation and obtain any required user consent before sending it.
verification: Request template. Not a captured live response.
curl: 'curl -sS -X POST ''https://huggingbay.xyz/api/events/a2hs'' -H ''X-Hugging-Bay-CSRF: 1'' -H ''Content-Type: application/json'' --data-raw ''{"event":"shown","surface":"home","platform":"ios-safari"}'''
x-codeSamples:
- lang: Shell
label: curl request
source: 'curl -sS -X POST ''https://huggingbay.xyz/api/events/a2hs'' -H ''X-Hugging-Bay-CSRF: 1'' -H ''Content-Type: application/json'' --data-raw ''{"event":"shown","surface":"home","platform":"ios-safari"}'''
x-rate-limit:
policy: '#/x-rate-limit'
summary: Write and protocol operations can have separate route-specific limits. Read Retry-After and retry_after_s when present; do not infer a write allowance from the public read budget.
x-error-contract:
schema: '#/components/schemas/ErrorEnvelope'
note: API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.
responses:
'403':
description: Same-origin request and CSRF header required
mediaTypes:
- application/json
schemas:
application/json:
$ref: '#/components/schemas/ErrorEnvelope'
'422':
description: invalid_a2hs_event
mediaTypes:
- application/json
schemas:
application/json:
$ref: '#/components/schemas/ErrorEnvelope'
/api/events/action:
post:
operationId: createEventsAction
tags:
- Analytics
summary: Record a bounded first-party product action event
description: 'Non-blocking product funnel ingestion for saves, mirror requests, reviews, publisher profile opens, and download intent. Payloads are bounded and stored only when Postgres analytics is enabled.
**Inputs.** No path or query fields are required. The request body schema lists accepted fields and required values.
**Outputs.** See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.
**Errors.** API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.
**Rate limits.** Write and protocol operations can have separate route-specific limits. Read Retry-After and retry_after_s when present; do not infer a write allowance from the public read budget.
**Example setup.** This example is not executed by documentation checks. Review the operation and obtain any required user consent before sending it.'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- action
properties:
action:
type: string
entityType:
type: string
entityId:
type: string
path:
type: string
route:
type: string
metadata:
type: object
additionalProperties: true
additionalProperties: true
responses:
'202':
description: Action event accepted or safely ignored
content:
application/json:
schema:
type: object
additionalProperties: true
description: Action event accepted or safely ignored. Fields can vary; no stronger field guarantee is specified for this operation.
headers:
X-HB-Backoff:
description: Optional v1 backoff contract marker; rollout defaults off.
schema:
type: string
X-HB-Admission:
description: Optional open, busy or limited; a process-local observation, not a reservation.
schema:
type: string
X-HB-Capacity:
description: Optional process-local heavy/bytes active, limit and remaining counts plus observed epoch seconds. Cached observations may be old.
schema:
type: string
'422':
description: Unknown action event name
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
headers:
X-HB-Backoff:
description: Optional v1 backoff contract marker; rollout defaults off.
schema:
type: string
X-HB-Admission:
description: Optional open, busy or limited; a process-local observation, not a reservation.
schema:
type: string
X-HB-Capacity:
description: Optional process-local heavy/bytes active, limit and remaining counts plus observed epoch seconds. Cached observations may be old.
schema:
type: string
x-idempotency-key:
supported: false
behavior: This endpoint does not implement Idempotency-Key; the header is ignored. Do not assume that retrying a write is safe.
x-request-example:
method: POST
url: https://huggingbay.xyz/api/events/action
headers:
Content-Type: application/json
body:
action: search.submit
path: /browse
metadata:
q: embedding
parameters: []
prerequisites:
- This example is not executed by documentation checks. Review the operation and obtain any required user consent before sending it.
verification: Request template. Not a captured live response.
curl: 'curl -sS -X POST ''https://huggingbay.xyz/api/events/action'' -H ''Content-Type: application/json'' --data-raw ''{"action":"search.submit","path":"/browse","metadata":{"q":"embedding"}}'''
x-codeSamples:
- lang: Shell
label: curl request
source: 'curl -sS -X POST ''https://huggingbay.xyz/api/events/action'' -H ''Content-Type: application/json'' --data-raw ''{"action":"search.submit","path":"/browse","metadata":{"q":"embedding"}}'''
x-rate-limit:
policy: '#/x-rate-limit'
summary: Write and protocol operations can have separate route-specific limits. Read Retry-After and retry_after_s when present; do not infer a write allowance from the public read budget.
x-error-contract:
schema: '#/components/schemas/ErrorEnvelope'
note: API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.
responses:
'422':
description: Unknown action event name
mediaTypes:
- application/json
schemas:
application/json:
$ref: '#/components/schemas/ErrorEnvelope'
components:
schemas:
ErrorEnvelope:
type: object
description: 'General API JSON errors, HTTP 410 Gone tombstones, MCP JSON-RPC error.data, and MCP tools/call failures (`result.isError:true` structuredContent) use this envelope; notification confirmation/unsubscribe errors have separate shapes, and paused subscribe/lookup responses use next:null. Fields: `code` (stable snake_case), `message` (plain words: what happened), `next` ({ label, action, command, href }: the single next step — `command` is a literal runnable shell line), `request_id`, and `retry_after_s` in the body on retryable 429 and 503 errors (not on 410). `error`, `status`, `requestId`, `retryAfterSeconds`, `cause` and `hint` are additive legacy twins kept for older clients. `nextAction` and `docsRef` are DEPRECATED aliases that only the /api/agents/* and /api/recommend-specialist lanes still emit; read `next` instead.'
required:
- code
- message
- next
- request_id
properties:
code:
type: string
description: Stable machine-readable error code (see x-error-taxonomy).
message:
type: string
description: What happened, in plain words.
next:
type: object
required:
- label
- action
- command
- href
description: The single next step. `label` is plain words; `action` is one of retry | fix_identifier | get_key | wait | contact; `command` is a literal runnable shell line (no editing required); `href` is the docs or recovery URL. `step` is the finer-grained legacy recovery verb.
properties:
label:
type: string
action:
type: string
enum:
- retry
- fix_identifier
- get_key
- wait
- contact
command:
type: string
href:
type: string
step:
type: string
enum:
- search_catalog
- fix_identifier
- list_tasks
- fix_query
- fix_hardware_param
- fix_request
- fix_arguments
- authenticate
- use_authorized_credential
- use_allowed_method
- retry_after
- retry_later
- read_body_then_retry
- reduce_request_size
- read_api_index
- list_tools
- request_mirror
- open_finder
- read_docs
- relax_constraints
retryAfterSeconds:
type: integer
minimum: 1
dropped:
type: string
additionalProperties: true
request_id:
type:
- string
- 'null'
description: req_… — quote it when you report a problem. Same id as the X-Request-Id header (prefixed).
retry_after_s:
type: integer
minimum: 1
description: 'Present on retryable 429 and 503 errors: wait this many seconds, then retry. Mirrors the Retry-After header for header-blind clients.'
error:
type: string
deprecated: true
description: DEPRECATED legacy twin of `code`; read `code`. Kept for one release.
status:
anyOf:
- type: integer
minimum: 400
maximum: 599
- enum:
- identity-unavailable
- unavailable
- not-served
requestId:
type:
- string
- 'null'
deprecated: true
description: DEPRECATED legacy twin of `request_id` (unprefixed); read `request_id`. Kept for one release.
retryable:
type: boolean
retryAfterSeconds:
type: integer
minimum: 1
deprecated: true
description: DEPRECATED legacy twin of `retry_after_s`; read `retry_after_s`. Kept for one release.
hint:
type: string
cause:
type: string
reason_code:
type: string
description: The lane-specific code a guided code (file_withheld, ...) replaced.
field:
type: string
allowed: {}
nextAction:
type: object
deprecated: true
description: 'DEPRECATED alias of `next`: { method, endpoint }. Read `next.href` instead.'
docsRef:
type: string
deprecated: true
description: DEPRECATED alias of `next.href` pointing at the OpenAPI operation.
additionalProperties: true
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'Hugging Bay bearer token for account, publisher, or authorized operator endpoints. Public discovery endpoints do not require a token. Get a reader token self-serve (no prior auth, no signup): POST /api/account/reader-token, then send it as Authorization: Bearer <token>. Full walkthrough at /quickstart#get-a-key.'
x-hugging-bay-route-recovery:
/api/search:
requestedPath: /api/search
method: GET
behavior: internal_alias
aliasOf: /api/artifacts
url: https://huggingbay.xyz/api/search?q=<query>&limit=20
canonicalUrl: https://huggingbay.xyz/api/artifacts?summary=1&q=<query>&limit=20
responseSchema: ArtifactPage
defaults:
summary: '1'
limit: 20
note: Returns bounded public artifact summaries; it never exposes private rows.
/api/finder:
requestedPath: /api/finder
method: GET
behavior: internal_alias
aliasOf: /api/agents/find-model
url: https://huggingbay.xyz/api/finder?task=<task>&limit=3
canonicalUrl: https://huggingbay.xyz/api/agents/find-model?task=<task>&limit=3
responseSchema: FindModelResponse
note: Uses the bounded task-and-constraints finder; provide task (or q) before acting on a candidate.
/api/downloads/{artifactId}:
requestedPath: /api/downloads/{artifactId}
method: GET
behavior: internal_alias
aliasOf: /api/artifacts/{artifactId}/download-plan
url: https://huggingbay.xyz/api/downloads/{artifactId}
canonicalUrl: https://huggingbay.xyz/api/artifacts/{artifactId}/download-plan
responseSchema: ArtifactDownloadPlan
servesBytes: false
nextRequest:
method: GET
url: https://huggingbay.xyz/api/downloads/{artifactId}/{path}
note: Use an exact hosted file path returned by the plan; never infer a filename or availability.
x-agent-reads:
summary: User fetchers and OAI-SearchBot may read find, plan and search APIs. Bulk crawlers use public metadata. Private/export/byte routes stay excluded. Authentication, byte guards and rate limits apply.
userFetchers:
- ChatGPT-User
- Claude-User
- Perplexity-User
- Google-Agent
- Google-GeminiNotebook
- MistralAI-User
searchCrawlers:
- OAI-SearchBot
readEndpoints:
- https://huggingbay.xyz/api/agents/find-model
- https://huggingbay.xyz/api/agents/find-runnable
- https://huggingbay.xyz/api/agents/deployment-plan
- https://huggingbay.xyz/api/v1/search
- https://huggingbay.xyz/api/search
- https://huggingbay.xyz/api/search/semantic
robots: https://huggingbay.xyz/robots.txt
authorization: A user-agent string is not authentication or proof of user consent.
x-data-freshness:
degraded: The current read could not supply a complete fresh response. Any included rows are a fallback or partial view; an empty degraded response does not establish that no records exist.
stale: Included data comes from an earlier snapshot, rather than a fresh check. Read asOf, snapshotAt, generatedAt or the endpoint's documented refresh timestamp when present; do not assume generatedAt alone is the time the underlying data was checked.
acquisition: These flags describe data freshness, not permission to download or execute. Download links still depend on the live file checks.
x-private-routes:
scope: Private browser and email-provider integration; these routes are not public SDK operations and do not require a reader token. Browser JSON POSTs enforce the configured same-origin policy.
paused: Subscribe and lookup return 503 notify_paused with retryable:false, next:null and no Retry-After or retry_after_s. Do not automatically retry. Transient notify_unavailable responses carry retry_after_s and Retry-After.
routes:
- path: /v1/notify/subscribe
methods:
- POST
description: Same-origin JSON email/topic submission. Success is 200 with pending or confirmed state; no email-send claim while paused.
private: true
- path: /v1/notify/lookup
methods:
- POST
description: Same-origin JSON lookup for the typed email/topic; 200 returns onList, topic and status. Stores nothing.
private: true
- path: /v1/notify/confirm
methods:
- POST
description: Same-origin JSON body containing a signed confirmation token; GET is not supported. Confirmation errors use their own code-only shape.
private: true
- path: /v1/notify/unsubscribe
methods:
- POST
description: Same-origin JSON body containing a signed unsubscribe token. A configured signed unsubscribe can work while subscriptions are paused; errors use their own code-only shape.
private: true
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://artifacts.apis.io/huggingbay-xyz/openapi/huggingbay-xyz-analytics-api-openapi.yml