Agent Docs

Find bounded model candidates and inspect their evidence qualifiers for a task and constraints.

Catalog metadata and evidence context are not proof of verification, licensing suitability, local fit or measured quality. Some tasks return a separate Bay Run specialist handoff. Inspect limited availability, unknowns and explicit blockers before acting.

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/agents/find-model

Request

  • Base URL: https://huggingbay.xyz
  • URL: https://huggingbay.xyz/api/agents/find-model
  • Auth: none declared

Query parameters

taskstring required
commercial'1'
hardwarestring

Your machine, free text or preset: 8gb-laptop (recorded persona), 16gb-laptop, cpu-only, 8gb, rtx3070-8, rtx3060-12, apple-m-16. NO default: absent hardware is echoed as input.hardware:null and every candidate's memory.capacityFit is "not-evaluated". Unparseable text is echoed with input.warnings["hardware-unrecognized"] and no capacity verdict. Memory math is computed for the ONE recommended file (memory.recommendedFile), never the sum of all quant variants; memory.fitTier is advisory (likely-fits | tight | likely-too-big | unknown).

gpustring

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

ctxinteger

Context tokens the KV-cache estimate is sized for (default 8192).

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

Honored: deviceFamily=cpu&customMemoryGb=8 evaluates an 8 GB CPU laptop.

limitinteger
compat'containment'

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

Response

Ranked composite reports with a bestPick. input echoes hardware/hardwareParsed; indexBuild + recommendationPin document that identical (task, hardware) requests return the same bestOverall per index build while eligible (no time expiry). Unrecognized query params are echoed in input.unrecognizedParams with a warning, never dropped.

object required

Changes

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