Agent Docs

Common-path compatibility alias for the bounded task-first finder.

Alias of /api/agents/find-model (recorded; identical handler). Prefer the recorded path: this one already answers with Deprecation and Sunset headers. Internal alias for /api/agents/find-model. Provide task (or q) and optional constraints; the response remains bounded metadata and verification context, not a runtime or download authorization.

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

Request

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

Query parameters

taskstring

Task such as coding, chat, embeddings, or vision.

qstring

Compatibility synonym for task.

commercial'1'
hardwarestring

Your machine, free text or preset: 8gb-laptop (recorded), 16gb-laptop, cpu-only, 8gb, rtx3070-8, rtx3060-12, apple-m-16. No default: absent hardware is echoed as null and capacity is not evaluated.

gpustring

Deprecated preset id (prefer hardware). Unknown ids return 400 unknown_gpu with supportedGpus[]. Cannot be combined with hardware (400 conflicting-hardware-params).

ctxinteger
deviceFamily'nvidia' | 'amd' | 'intel' | 'apple' | 'cpu' | 'no-gpu'
customMemoryGbnumber

Honored: with deviceFamily=cpu this is system RAM; with a preset it overrides the preset's memory.

limitinteger

Response

Bounded task-first finder response

schemaVersion'hugging-bay.find-model.v1' required
generatedAtstring required
inputobject required
resultContractobject required
candidatesobject[] required
bestPickServeEligibleboolean

True when recorded.downloadable or recorded.executionAvailable is true; download and Bay Run execution remain distinct.

bestPickReasonstring nullable

One honest line: whether the pick is serve-eligible, or why no pick is asserted.

bestPickQualificationobject
exclusionsobject[]
fitUnknownobject[]
degradedboolean
partialboolean
guidancestring[] required

Changes

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