Agent Docs

Read catalog arrival events or capture a polling cursor.

mode=high-water captures the latest matching cursor; page reads subsequent arrivals. Copy all returned cursor fields together. source-unavailable is an HTTP 200 refusal, not an empty successful page.

Inputs. Path, query and header fields are listed below. No request body is required.

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. Public read budgets apply by client IP and route group. This operation can have a smaller route-specific budget. Read Retry-After on 429 or retryable 503 responses.

get/api/retention/catalog-arrivals

Request

  • Base URL: https://huggingbay.xyz
  • URL: https://huggingbay.xyz/api/retention/catalog-arrivals
  • Auth: none required

Query parameters

mode'page' | 'high-water'

Read events or capture the high-water mark.

limitinteger

Maximum rows to return.

qstring

Catalog retention filter.

typestring

Comma-separated artifact types.

licensestring

Catalog retention filter.

taskstring

Catalog retention filter.

frameworkstring

Catalog retention filter.

formatstring

Catalog retention filter.

worksWithstring

Catalog retention filter.

ownerstring

Catalog retention filter.

sourcestring

Catalog retention filter.

hostingstring

Catalog retention filter.

reviewStatusstring

Catalog retention filter.

scanstring

Catalog retention filter.

minCardinteger

Minimum card completeness.

verified'1'

Use 1 to select verified metadata.

commercial'1'

Use 1 for commercial-only criteria.

afterArrivedAtstring

Opaque cursor field copied from the previous response.

afterArtifactIdstring

Opaque cursor field copied from the previous response.

afterRevisionstring

Opaque cursor field copied from the previous response.

afterEventIdstring

Opaque cursor field copied from the previous response.

Response

Read catalog arrival events or capture a polling cursor.

schemaVersionstring
status'ready' | 'source-unavailable' required
arrivalBasisstring
criteriaobject
observedAtstring
hasMoreboolean
cursorobject nullable
reasonstring

Changes

No recorded changes to this operation across all 3 revisions of this API.