---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Get a build"
description: "`build.builds.get` (GET /v1/{name}): Gets a build."
type: reference
product: builds
summary: "Gets a build."
updated: 2026-09-28
nav: false
---

> **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.

Gets a build.

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

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build`
- **Scope** `build:read`
- **Effect** `read` — nothing is written.
- **Collection** [builds](/docs/api/builds)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the build to get. Required. |

## Response

| 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. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### BuildSpec

| Field | Type | What it is |
| --- | --- | --- |
| `source` | `BuildSource` | The exact source. Required. |
| `dockerfile` | `string` | A Dockerfile path relative to the root directory; unset lets the zero- config frontend detect the stack. |
| `target` | `string` | The Dockerfile stage to build. |
| `build_class` | `string` | The class, `sylphx-<os>-<size>`; default `sylphx-linux-standard`. |
| `build_args` | `map<string, string>` | Build arguments. Secret values bind through Sylphx Secrets, never here. |
| `cache` | `string` | The BuildCache to read and write; default the project's `default` cache. |

### BuildStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `state` | `BuildState` | The lifecycle state. Output only. One of `queued`, `running`, `succeeded`, `failed`, `cancelled`. |
| `failure` | `BuildFailure` | Why the build failed, when `state` is FAILED. Output only. One of `source_unavailable`, `build_error`, `no_capacity`, `class_not_offered`, `signing_unavailable`, `timeout`. |
| `output` | `BuildOutput` | The result, when `state` is SUCCEEDED. Output only. |
| `lease` | `string` | The Sandboxes lease the build ran on. Output only. |
| `start_time` | `timestamp` | When the build started running. Output only. |
| `end_time` | `timestamp` | When the build reached a final state. Output only. |
| `log_uri` | `string` | Where the build log is read, through Observability. Output only. |

### BuildSource

| Field | Type | What it is |
| --- | --- | --- |
| `source_link` | `string` | The Hosting SourceLink naming the repository and its Connection. Required. |
| `commit` | `string` | The full commit SHA to build. Required. |
| `root_directory` | `string` | The directory inside the repository to build; default the root. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

### BuildOutput

| Field | Type | What it is |
| --- | --- | --- |
| `image` | `string` | The image reference: `registry.sylphx.net/<path>@sha256:<hex>`. Output only. |
| `image_digest` | `string` | The image manifest digest. Output only. |
| `sbom_digest` | `string` | The SBOM Artifact digest. Output only. |
| `provenance_digest` | `string` | The signed SLSA provenance Artifact digest. Output only. |
| `artifact` | `string` | The artifact in Sylphx Artifacts that holds the three. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/builds/build" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.build.builds.get({ name: 'orgs/acme/projects/shop/builds/build' })
```

**Rust**

```rust
let mut req = sylphx::build::GetBuildRequest::default();
req.name = "orgs/acme/projects/shop/builds/build".to_string();
let response = sx.build().builds().get(req).await?;
```

**CLI**

```bash
sylphx build builds get orgs/acme/projects/shop/builds/build
```

**MCP**

```json
{ "method_id": "build.builds.get", "args": {"name":"orgs/acme/projects/shop/builds/build"} }
```