Skip to content
Stainless Stainless Stainless
FeedbackDashboard
API Reference
Builds
Target Outputs

Download build target output

builds.target_outputs.retrieve(**kwargs) -> TargetOutputRetrieveResponse
GET/v0/build_target_outputs

Retrieve a method to download an output for a given build target.

If the requested type of output is source, and the requested output method is url, a download link to a tarball of the source files is returned. If the requested output method is git, a Git remote, ref, and access token (if necessary) is returned.

Otherwise, the possible types of outputs are specific to the requested target, and the output method must be url. See the documentation for type for more information.

ParametersExpand Collapse
build_id: String

Build ID

target: :node | :typescript | :python | 10 more

SDK language target name

One of the following:
:node
:typescript
:python
:go
:java
:kotlin
:ruby
:terraform
:cli
:php
:csharp
:sql
:openapi
type: :source | :dist | :wheel | 4 more
One of the following:
:source
:dist
:wheel
:"openapi-with-transforms"
:"openapi-with-code-samples"
:"openapi-sdk-spec"
:file
output: :url | :git

Output format: url (download URL) or git (temporary access token).

One of the following:
:url
:git
path: String

The path of the file to get when used with "type": "file".

ReturnsExpand Collapse
TargetOutputRetrieveResponse = { output, target, type, 2 more} | { token, output, ref, 3 more}
One of the following:
class URL { output, target, type, 2 more }
output: :url
target: Target
One of the following:
:node
:typescript
:python
:go
:java
:kotlin
:ruby
:terraform
:cli
:php
:csharp
:sql
:openapi
type: :source | :dist | :wheel | 4 more
One of the following:
:source
:dist
:wheel
:"openapi-with-transforms"
:"openapi-with-code-samples"
:"openapi-sdk-spec"
:file
url: String

URL for direct download

path: String

The path of the file, which is only present when using with the type "file" option.

class Git { token, output, ref, 3 more }
token: String

Temporary GitHub access token

output: :git
ref: String

Git reference (commit SHA, branch, or tag)

target: Target
One of the following:
:node
:typescript
:python
:go
:java
:kotlin
:ruby
:terraform
:cli
:php
:csharp
:sql
:openapi
type: :source | :dist | :wheel | 4 more
One of the following:
:source
:dist
:wheel
:"openapi-with-transforms"
:"openapi-with-code-samples"
:"openapi-sdk-spec"
:file
url: String

URL to git remote

Download build target output

require "stainless_v0"

stainless = StainlessV0::Client.new(
  api_key: "My API Key",
  environment: "staging" # defaults to "production"
)

target_output = stainless.builds.target_outputs.retrieve(build_id: "build_id", target: :node, type: :source)

puts(target_output)
{
  "output": "url",
  "target": "node",
  "type": "source",
  "url": "url",
  "path": "path"
}
Returns Examples
{
  "output": "url",
  "target": "node",
  "type": "source",
  "url": "url",
  "path": "path"
}