Skip to content
Get started

Create build

builds.create(BuildCreateParams**kwargs) -> Build
post/v0/builds

Create a build, on top of a project branch, against a given input revision.

The project branch will be modified so that its latest set of config files points to the one specified by the input revision.

ParametersExpand Collapse
project: Optional[str]

Project name

revision: Union[str, Dict[str, FileInput]]

Specifies what to build: a branch name, commit SHA, merge command ("base..head"), or file contents.

Accepts one of the following:
RevisionUnionMember0 = str

A branch name, commit SHA, or merge command in the format "base..head"

RevisionUnionMember1 = Dict[str, FileInput]

File contents to commit directly

Accepts one of the following:
class Content:
content: str

File content

class URL:
url: str

URL to fetch file content from

allow_empty: Optional[bool]

Whether to allow empty commits (no changes). Defaults to false.

branch: Optional[str]

The project branch to use for the build. If not specified, the branch is inferred from the revision, and will 400 when that is not possible.

commit_message: Optional[str]

Optional commit message to use when creating a new commit.

targets: Optional[List[Target]]

Optional list of SDK targets to build. If not specified, all configured targets will be built.

Accepts one of the following:
"node"
"typescript"
"python"
"go"
"java"
"kotlin"
"ruby"
"terraform"
"cli"
"php"
"csharp"
ReturnsExpand Collapse
class Build:
id: str

Build ID

config_commit: str
created_at: datetime
documented_spec: Optional[DocumentedSpec]
Accepts one of the following:
class DocumentedSpecUnionMember0:
content: str
type: Literal["content"]
Accepts one of the following:
"content"
class DocumentedSpecUnionMember1:
expires: datetime
type: Literal["url"]
Accepts one of the following:
"url"
url: str
object: Literal["build"]
Accepts one of the following:
"build"
org: str
project: str
targets: Targets
cli: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
csharp: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
go: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
java: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
kotlin: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
node: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
php: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
python: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
ruby: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
terraform: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
typescript: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted:
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted:
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued:
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress:
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed:
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
updated_at: datetime
Create build
from stainless_v0 import Stainless

client = Stainless(
    api_key="My API Key",
)
build = client.builds.create(
    project="project",
    revision="string",
)
print(build.id)
{
  "id": "id",
  "config_commit": "config_commit",
  "created_at": "2019-12-27T18:11:19.117Z",
  "documented_spec": {
    "content": "content",
    "type": "content"
  },
  "object": "build",
  "org": "org",
  "project": "project",
  "targets": {
    "cli": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "csharp": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "go": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "java": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "kotlin": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "node": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "php": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "python": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "ruby": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "terraform": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "typescript": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    }
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}
Returns Examples
{
  "id": "id",
  "config_commit": "config_commit",
  "created_at": "2019-12-27T18:11:19.117Z",
  "documented_spec": {
    "content": "content",
    "type": "content"
  },
  "object": "build",
  "org": "org",
  "project": "project",
  "targets": {
    "cli": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "csharp": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "go": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "java": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "kotlin": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "node": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "php": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "python": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "ruby": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "terraform": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    },
    "typescript": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "lint": {
        "status": "not_started"
      },
      "object": "build_target",
      "status": "not_started",
      "test": {
        "status": "not_started"
      },
      "build": {
        "status": "not_started"
      }
    }
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}