---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Builds"
description: "The `builds` collection of Sylphx Build: An Build turns one commit into an image, an SBOM, and signed provenance."
type: reference
product: builds
summary: "An Build turns one commit into an image, an SBOM, and signed provenance."
updated: 2026-09-28
order: 900
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

An Build turns one commit into an image, an SBOM, and signed provenance. An Build is immutable once created; it ends with Artifact digests or a typed failure.

**Service** Sylphx Build · **Resource type** `build.sylphx.com/Build` · **Name pattern** `orgs/{org}/projects/{project}/builds/{build}` · **Shape** `spec_status`

**Not available yet.** Sylphx Build is declared in the registry but no backend serves it: every call answers `501` with the problem code `UNIMPLEMENTED`.

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/builds/{build}`. |
| `uid` | `string` | `bld_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `BuildSpec` | Desired state. Required. |
| `status` | `BuildStatus` | Observed state. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/builds#get) | Gets a build. |
| `GET` | [`list`](/docs/api/builds#list) | Lists builds in a project. |
| `POST` | [`create`](/docs/api/builds#create) | Creates a build. The Operation is done when the controller settles it. |
| `POST` | [`cancel`](/docs/api/builds#cancel) | Cancels a queued or running Build; its lease is released and nothing is published. |

## get

Gets a build.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build` · scope `build:read` · effect `read` · not available yet · [Request, response and examples](/docs/api/builds/get)

## list

Lists builds in a project.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/builds` · scope `build:read` · effect `read` · not available yet · paginated · [Request, response and examples](/docs/api/builds/list)

## create

Creates a build. The Operation is done when the controller settles it.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/builds` · scope `build:write` · effect `write` · not available yet · long-running · [Request, response and examples](/docs/api/builds/create)

## cancel

Cancels a queued or running Build; its lease is released and nothing is published.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build:cancel` · scope `build:write` · effect `destructive` · not available yet · validate_only · long-running · [Request, response and examples](/docs/api/builds/cancel)