API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Builds

List project builds

client.builds.list(BuildListParams { project, branch, cursor, 2 more } params?, RequestOptionsoptions?): Page<Build { id, config_commit, created_at, 6 more } >

get/v0/builds

Create build

client.builds.create(BuildCreateParams { project, revision, allow_empty, 3 more } params, RequestOptionsoptions?): Build { id, config_commit, created_at, 6 more }

post/v0/builds

Retrieve build

client.builds.retrieve(stringbuildID, RequestOptionsoptions?): Build { id, config_commit, created_at, 6 more }

get/v0/builds/{buildId}

Creates two comparable builds

client.builds.compare(BuildCompareParams { base, head, project, targets } params, RequestOptionsoptions?): BuildCompareResponse { base, head }

post/v0/builds/compare

ModelsExpand Collapse

Build { id, config_commit, created_at, 6 more }

id: string

Build ID

config_commit: string

created_at: string

documented_spec: UnionMember0 { content, type } | UnionMember1 { expires, type, url } | null

Accepts one of the following:

UnionMember0 { content, type }

content: string

type: "content"

Accepts one of the following:

"content"

UnionMember1 { expires, type, url }

expires: string

type: "url"

Accepts one of the following:

"url"

url: string

object: "build"

Accepts one of the following:

"build"

org: string

project: string

targets: Targets { cli, csharp, go, 8 more }

cli?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

csharp?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

go?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

java?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

kotlin?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

node?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

php?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

python?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

ruby?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

terraform?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

typescript?: BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

updated_at: string

BuildTarget { commit, install_url, lint, 4 more }

commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { commit, conclusion, merge_conflict_pr }

commit: Commit { repo, sha } | null

repo: Repo { branch, name, owner }

branch: string

name: string

owner: string

sha: string

conclusion: "error" | "warning" | "note" | 9 more

Accepts one of the following:

"error"

"warning"

"note"

"success"

"merge_conflict"

"upstream_merge_conflict"

"fatal"

"payment_required"

"cancelled"

"timed_out"

"noop"

"version_bump"

merge_conflict_pr: MergeConflictPr | null

number: number

repo: Repo { name, owner }

name: string

owner: string

status: "completed"

Accepts one of the following:

"completed"

install_url: string | null

lint: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

object: "build_target"

Accepts one of the following:

"build_target"

status: "not_started" | "codegen" | "postgen" | "completed"

Accepts one of the following:

"not_started"

"codegen"

"postgen"

"completed"

test: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

build?: CheckStep

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

CheckStep = NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, status }

Accepts one of the following:

NotStarted { status }

status: "not_started"

Accepts one of the following:

"not_started"

Queued { status }

status: "queued"

Accepts one of the following:

"queued"

InProgress { status }

status: "in_progress"

Accepts one of the following:

"in_progress"

Completed { completed, status }

completed: Completed { conclusion, url }

conclusion: "success" | "failure" | "skipped" | 4 more

Accepts one of the following:

"success"

"failure"

"skipped"

"cancelled"

"action_required"

"neutral"

"timed_out"

url: string | null

status: "completed"

Accepts one of the following:

"completed"

BuildsDiagnostics

Get diagnostics for a build

client.builds.diagnostics.list(stringbuildID, DiagnosticListParams { cursor, limit, severity, targets } query?, RequestOptionsoptions?): Page<BuildDiagnostic { code, ignored, level, 4 more } >

get/v0/builds/{buildId}/diagnostics

ModelsExpand Collapse

BuildDiagnostic { code, ignored, level, 4 more }

code: string

The kind of diagnostic.

ignored: boolean

Whether the diagnostic is ignored in the Stainless config.

level: "fatal" | "error" | "warning" | "note"

The severity of the diagnostic.

Accepts one of the following:

"fatal"

"error"

"warning"

"note"

message: string

A description of the diagnostic.

more: BuildDiagnosticMore | null

Accepts one of the following:

Markdown { markdown, type }

markdown: string

type: "markdown"

Accepts one of the following:

"markdown"

Raw { raw, type }

raw: string

type: "raw"

Accepts one of the following:

"raw"

config_ref?: string

A JSON pointer to a relevant field in the Stainless config.

oas_ref?: string

A JSON pointer to a relevant field in the OpenAPI spec.

BuildDiagnosticMore = Markdown { markdown, type } | Raw { raw, type }

Accepts one of the following:

Markdown { markdown, type }

markdown: string

type: "markdown"

Accepts one of the following:

"markdown"

Raw { raw, type }

raw: string

type: "raw"

Accepts one of the following:

"raw"

BuildsTarget Outputs

Download build target output

client.builds.targetOutputs.retrieve(TargetOutputRetrieveParams { build_id, target, type, output } query, RequestOptionsoptions?): TargetOutputRetrieveResponse

get/v0/build_target_outputs