---
title: "Reads how a build is getting on"
method: GET
path: "/builds/{id}"
tags: ["Builds"]
---

# Reads how a build is getting on

`GET /builds/{id}`

## Request

- Base URL: `https://genhttp.dev/api/v1`
- URL: `https://genhttp.dev/api/v1/builds/{id}`
- Auth: none declared

Asked again while it runs: its place in the queue, the steps the agent took so far, and once it is done how it
ended. The result of a build that worked holds the editor key of the new lambda, so whoever has the id of a build
can take the lambda it made - keep it as private as the key. The agent forgets a build some time after it ended.

## Path parameters

- `id` string, required

## Response `200`

Its state, its steps, and how it ended once it has

- BuildProgress: How a build is getting on.
  - `State` string: `queued`, `running`, `done` or `failed`
  - `Steps` AgentStep[]: What it has done so far, as facts a page can say in the visitor's language - the same steps the editor shows of a change
    - `At` integer: Seconds into the run
    - `Kind` string: What it did: `say`, `guide`, `demos`, `read`, `logs`, `create`, `write`, `check`, `deploy`, `upload`, `delete`, `list`, `feature` (started one), `update` (changed a feature's notes or base), `merge`, `discard` (deleted a feature), `data` (switched a kind of data on), `records` (read the database), `secrets` (listed the secrets) or `other`
    - `Text` string, nullable: What the agent said, for a step of kind `say`
    - `Tool` string, nullable: The tool, for a step of kind `other`
    - `Files` string[], nullable: The files written or read
    - `Removed` string[], nullable: The files a write removed
    - `Whole` boolean, nullable: Whether a write replaced every file rather than some
    - `Path` string, nullable: The workspace path of an upload or a removal
    - `Done` boolean, nullable: Whether the tool has answered
    - `Version` integer, nullable: The version read, saved, merged into, put online, or made a feature's base
    - `Online` boolean, nullable: Whether a write or a deployment went online - at the preview address, for a feature
    - `Errors` integer, nullable: How many errors the compiler found
    - `Problems` integer, nullable: How many errors the log holds
    - `Problem` string, nullable: Why the platform refused the step, in its words
    - `Feature` string, nullable: The name of the feature the step was about
    - `Preview` boolean, nullable: Whether the step was about a feature rather than the lambda itself
    - `Data` string, nullable: The kind of data a step of kind `data` switched on: `database`, `secrets` or `workspace`
  - `Result` BuildResult: How a build ended.
    - `Ok` boolean: Whether a lambda was made
    - `Deployed` boolean, nullable: Whether it is online
    - `PublicKey` string, nullable: The public key of the lambda that was made
    - `PrivateKey` string, nullable: Its editor key - handed out here, to whoever asked for the build, and nowhere else
    - `Url` string, nullable: Where it answers
    - `EditorUrl` string, nullable: Where its editor is
    - `Summary` string, nullable: What the agent said it made
    - `Keep` string, nullable: What the person needs to be told about keeping the editor key
    - `Error` string, nullable: What went wrong, or - where it was declined - why, in the language of the request
    - `Detail` string, nullable: What went wrong, in the words of whatever it went wrong in
    - `Declined` boolean, nullable: Whether the agent would not build what was asked for, because it is not an application or not one this platform is for; `error` says why
  - `Waiting` integer: Its place in the queue; zero once it runs
  - `Seconds` integer: How long it has been running, in seconds, counted by the agent
  - `Limit` integer, nullable: How long it may run, in seconds; absent when there is no clock on it

## Other responses

- `204`: A response containing no body
- `400`: That is not the id of a build.
- `404`: The agent knows no build of this id, any more - or this installation has no agent.

---

[API](https://skmtc.dev/genhttp/apis/genhttp-lambda-api.md) · [All operations](https://skmtc.dev/genhttp/apis/genhttp-lambda-api/llms.txt) · [OpenAPI document](https://skmtc.dev/genhttp/apis/genhttp-lambda-api/revisions/8b36699e03df?raw)
