Skip to content
Stainless Stainless Stainless
FeedbackDashboard
API Reference
Overview

API Reference

Libraries

TypeScript
0.1.0-alpha.22
npm install @stainless-api/sdk
Read Docs
Python
0.0.1
pip install git+ssh://git@github.com/stainless-sdks/stainless-v0-python.git
Read Docs
Java
0.0.1
implementation("com.stainless.api:stainless-java:0.0.1")
Read Docs
Go
0.27.1
go get -u 'github.com/stainless-api/stainless-api-go@v0.0.1'
Read Docs
Ruby
0.0.1
gem "stainless-v0"
Read Docs
CLI tool
0.1.0-alpha.70
<!-- x-release-please-start-version -->

## Installation

### Installing with Homebrew

~~~sh
brew tap stainless-api/tap
brew install stl
~~~

### Installing with Go

To test or install the CLI locally, you need [Go](https://go.dev/doc/install) version 1.22 or later installed.

~~~sh
go install 'github.com/stainless-api/stainless-api-cli/cmd/stl@latest'
~~~

Once you have run `go install`, the binary is placed in your Go bin directory:

- **Default location**: `$HOME/go/bin` (or `$GOPATH/bin` if GOPATH is set)
- **Check your path**: Run `go env GOPATH` to see the base directory

If commands aren't found after installation, add the Go bin directory to your PATH:

~~~sh
# Add to your shell profile (.zshrc, .bashrc, etc.)
export PATH="$PATH:$(go env GOPATH)/bin"
~~~

<!-- x-release-please-end -->
Read Docs
C#
0.0.1
git clone git@github.com:stainless-sdks/stainless-v0-csharp.git
dotnet add reference stainless-v0-csharp/src/StainlessV0
Read Docs

API Overview

Projects

Retrieve project
GET/v0/projects/{project}
Update project
PATCH/v0/projects/{project}
List projects
GET/v0/projects
Create project
POST/v0/projects
Generate an AI commit message for a specific SDK
POST/v0/projects/{project}/generate_commit_message

ProjectsBranches

Create a new project branch
POST/v0/projects/{project}/branches
Retrieve a project branch
GET/v0/projects/{project}/branches/{branch}
List project branches
GET/v0/projects/{project}/branches
Delete a project branch
DELETE/v0/projects/{project}/branches/{branch}
Rebase a project branch
PUT/v0/projects/{project}/branches/{branch}/rebase
Reset
PUT/v0/projects/{project}/branches/{branch}/reset

ProjectsConfigs

Retrieve configuration files
GET/v0/projects/{project}/configs
Generate config suggestions
POST/v0/projects/{project}/configs/guess

Builds

List project builds
GET/v0/builds
Create build
POST/v0/builds
Retrieve build
GET/v0/builds/{buildId}
Creates two comparable builds
POST/v0/builds/compare

BuildsDiagnostics

Get diagnostics for a build
GET/v0/builds/{buildId}/diagnostics

BuildsTarget Outputs

Download build target output
GET/v0/build_target_outputs

Orgs

List organizations
GET/v0/orgs
Retrieve an organization
GET/v0/orgs/{org}