Artifacts
Agent Docs

Resolve an upstream repo URL, owner/name, or artifact id to one Hugging Bay record.

Alias of /api/v1/resolve (recorded; identical handler). Prefer the recorded path: this one already answers with Deprecation and Sunset headers. Use this when a human or agent pasted a Hugging Face, ModelScope, GitHub, Zenodo, or arXiv URL. The response includes a normalized repo, exact artifact match when present, hosted download rows when ready, fallback search rows, and safe next actions.

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/resolve

Request

  • Base URL: https://huggingbay.xyz
  • URL: https://huggingbay.xyz/api/resolve
  • Auth: none declared

Query parameters

repostring

Owner/name repo or full upstream URL.

urlstring

Full upstream URL. Alias for repo.

qstring

Search text fallback. Alias for repo when repo/url is omitted.

source'huggingface' | 'modelscope' | 'github' | 'zenodo' | 'arxiv' | 'openml' | 'dataverse' | 'datacite' | 'paperswithcode' | 'opendatalab' | 'opencompass'
compat'containment'

Deprecated legacy response block opt-in for one release only.

Response

Resolved artifact (status found or found_stale).

schemaVersion'hugging-bay.resolve.v1' required
generatedAtstring required
inputstring required
status'found' | 'found_stale' | 'missing' | 'unsupported' required
artifactIdstring nullable

Alias of artifact.id — the resolved artifact id, or null when unresolved. Use the same id against /api/v1/artifacts/{id}/download-plan.

artifactArtifactSummary (unresolved $ref)
actionsobject required
guidancestring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.