Skip to content
Stainless Stainless Stainless
FeedbackDashboard
API Reference

Builds

List project builds
$client->builds->list(string project, ?string branch, ?string cursor, ?float limit, ?Revision revision): Page<Build>
GET/v0/builds
Create build
$client->builds->create(string project, Revision revision, ?bool allowEmpty, ?string branch, ?string commitMessage, ?bool enableAICommitMessage, ?TargetCommitMessages targetCommitMessages, ?list<Target> targets): Build
POST/v0/builds
Retrieve build
$client->builds->retrieve(string buildID): Build
GET/v0/builds/{buildId}
Creates two comparable builds
$client->builds->compare(Base base, Head head, string project, ?list<Target> targets): BuildCompareResponse
POST/v0/builds/compare
ModelsExpand Collapse
string id

Build ID

string configCommit
\Datetime createdAt
?DocumentedSpec documentedSpec
Object_ object
string org
string project
Targets targets
\Datetime updatedAt
Commit commit
?string installURL
Object_ object
Status status
?CheckStep build
?CheckStep lint
?CheckStep test
One of the following:
NotStarted
"not_started" status
Queued
"queued" status
?string url
InProgress
"in_progress" status
?string url
Completed
Completed completed

deprecated

Conclusion conclusion
"completed" status
?string url

BuildsDiagnostics

Get diagnostics for a build
$client->builds->diagnostics->list(string buildID, ?string cursor, ?float limit, ?Severity severity, ?string targets): Page<BuildDiagnostic>
GET/v0/builds/{buildId}/diagnostics
ModelsExpand Collapse
string code

The kind of diagnostic.

bool ignored

Whether the diagnostic is ignored in the Stainless config.

Level level

The severity of the diagnostic.

string message

A description of the diagnostic.

?string configRef

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

?string oasRef

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

One of the following:
Markdown
string markdown
"markdown" type
Raw
string raw
"raw" type

BuildsTarget Outputs

Download build target output
$client->builds->targetOutputs->retrieve(string buildID, Target target, Type type, ?Output output, ?string path): TargetOutputGetResponse
GET/v0/build_target_outputs