Agent Docs

One-call deployment plan: hosted files with sha256, downloadUrl and a verify block; run steps only when a tested run plan exists.

One schema for both artifact= and id=. Optional files[].runKit holds harness-tested runner steps for that exact path and SHA-256. Top-level runKit selects the best tested file; runTested is independent of runReady and commandsAvailable. ?id= is a compatibility alias for ?artifact=; both use the same live download authority. ?artifact= (getAgentArtifactDeploymentPlan): a limited availability-compatible plan derived from the gated download-plan authority. Returns recorded identity (repo, revision, licenseId, totalBytes, hostedFileCount), per-file { path, sha256, sizeBytes, downloadUrl }, a shasum -a 256 -c verify block, runtime-family detection (gguf -> ollama/llama.cpp; safetensors/pytorch -> vllm/transformers; mlx/npz -> mlx_lm), and per-family recipes whose download and verify lines reference the exact hosted files and their SHA-256 digests. Run and serve lines are withheld unless commandsAvailable is true (a tested run plan exists); when it is false (reason no-tested-run-plan), plan to use your own runner (llama.cpp, Ollama, LM Studio). A model with no reviewed hosted files returns an honest available:false document with no commands. The same document is also served by the deployment_plan hosted-MCP tool. Never 500.

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/deployment-plan

Request

  • Base URL: https://huggingbay.xyz
  • URL: https://huggingbay.xyz/api/agents/deployment-plan
  • Auth: none declared

Query parameters

artifactstring

Artifact id (or resolvable reference). Selects the limited availability-compatible artifact deployment plan.

idstring

Compatibility alias for artifact; returns the same deployment-plan schema.

compat'containment'

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

Response

Deployment plan

schemaVersionstring
availableboolean
runTestedboolean
runKitobject nullable
runtimesobject
verifyobject
warningsstring[]

Changes

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