Get one spec doc.
const url = 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The ID of one spec doc.
Responses
Section titled “ Responses ”The spec doc.
One spec doc of a bundle, with its own profile, versions, review runs and verdict.
object
The bundle that holds the spec doc.
The profile of the spec doc.
Where a GitHub bundle comes from, and its draft (REQ-123).
object
The current version has changes that are not on GitHub.
GitHub changed after the draft started.
The path of the spec doc in its bundle.
For a local bundle, the folder on disk that holds the bundle’s files. A coding agent edits the files there.
object
The verdict of the bundle’s latest completed run. It is stale when that run is not on the current version.
object
Lint means only the lint stage ran.
object
Checks in adoption mode (REQ-133).
Open MUST findings that block the verdict. A MUST finding that the materiality judge called no material gap counts as SHOULD, because it is advice.
The MUST findings of checks that came back with no answer. They count in must. Another review answers them, so they are not questions.
Open blocking threads. Any makes the verdict Not Build Ready (§8.6 rule 2).
The full review whose AI findings this verdict counts. For a full run, the run itself.
The version the AI review read, when it is older than this verdict’s version.
How many sections changed since the AI review read the doc.
What the last full review fixed, left open and found new, against the full review before it. The unit is a check in a section, or a build question; only open MUST and SHOULD findings count. Absent when the doc has one full review or none.
object
The version that the earlier full review read.
Set when the verdict is stale because a linked bundle has a newer version than the run read (REQ-056).
With stale_reason upstream_changed, the linked spec docs that have a newer version than the run read.
object
The bundle that holds the spec doc.
Why the latest run on the current version failed, when it failed.
The frontmatter keys the main doc does not name, and the values a review used for them (REQ-135). Absent when the doc names both.
object
The one thing the caller must do next on this bundle. Absent when nothing is open. The list carries the kind and the sentence; one bundle also carries the target.
object
Questions opens the questions screen, with everything that blocks Build Ready and needs the author. breakdown opens the breakdown screen of an app or initiative doc, in place of handoff. verify opens the verify field, after a handoff with no usable verification run.
What to do, in words, for a button label or a status line.
Example
{ "source_kind": "local", "verdict": { "kind": "lint", "result": "build_ready", "stale_reason": "upstream_changed" }, "status": "draft", "next_action": { "kind": "waiver" }}default
Section titled “default”An error.
RFC 9457 problem details with a stable code.
object
A stable machine-readable error code.
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "code": "example"}