platform-biomes-server

Operations of the Biome Host API. Paths are relative to your deployment's API host.

GET /api/biome-host-api/platform/biomes/server

List registered server biomes. The org is the one the kernel ADMITS for the caller (X-Xema-Org-Id and/or ?org=, which must agree and be proven by the caller's own token). Only biomes whose effectiveState is enabled for that org are returned.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
orgquerystringnoNames the org the caller works for; it is a declared org source of the route, not a selector. When the request also carries X-Xema-Org-Id the two MUST agree — a disagreement is refused, never silently preferred.
StatusDescriptionBody
200application/json ServerBiomeRegistrationResponseDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/biome-host-api/platform/biomes/server/{id}

Get a single server biome by id, for the org the caller names. A person holding the installations read permission (org admins hold it by default) sees exactly what the list shows that org: anything else is a 404.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
orgquerystringno
StatusDescriptionBody
200application/json ServerBiomeRegistrationResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404The biome is not available to this organization.application/problem+json ServerBiomeNotFoundProblemDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/biome-host-api/platform/biomes/server/{id}/contributions/{kind}

Resolve a server biome contribution-kind directory to an absolute path

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
kindpathstringyes
orgquerystringno
StatusDescriptionBody
200application/json BiomeContributionResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/biome-host-api/platform/biomes/server/{id}/icons/{slug}.svg

Return an SVG icon shipped by the biome under <root>/icons/<slug>.svg.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
slugpathstringyes
orgquerystringno
StatusDescriptionBody
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/biome-host-api/platform/biomes/server/{id}/install-schema

Return the biome's install-time JSON Schema and (optional) rjsf uiSchema. Consumed by the generic install wizard. A person holding the installations read permission (org admins hold it by default) reads it for a biome the list shows that org; anything else is a 404.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
orgquerystringno
StatusDescriptionBody
200application/json BiomeInstallSchemaResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404The biome is not available to this organization, or offers no install schema.application/problem+json ServerBiomeNotFoundProblemDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/biome-host-api/platform/biomes/server/{id}/provisioning-scaffolds

Return every workspace-provisioning scaffold the biome ships — the manifest provisioning[] declaration, the raw provisioning/<id>.yaml recipe, and its template files (base64). Consumed by agent-session-api's provisioning-plan-resolver.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
orgquerystringno
StatusDescriptionBody
200application/json BiomeProvisioningScaffoldsResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto