GET
/
v8
/
artifacts
/
{hash}
downloadArtifact
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.artifacts.downloadArtifact({
    xArtifactClientCi: "VERCEL",
    xArtifactClientInteractive: 0,
    hash: "12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Headers

​
x-artifact-client-ci
string

The continuous integration or delivery environment where this artifact is downloaded.

Maximum length: 50
Example:

"VERCEL"

​
x-artifact-client-interactive
integer

1 if the client is an interactive shell. Otherwise 0

Required range: 0 <= x <= 1
Example:

0

Path Parameters

​
hash
string
required

The artifact hash

Example:

"12HKQaOmR5t5Uy6vdcQsNIiZgHGB"

Query Parameters

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

The artifact was found and is downloaded as a stream. Content-Length should be verified.

An octet stream response that will be piped to the response stream.