Shadowgraph
About
Sign in

vercel/sdk

Vercel SDK is a type-safe Typescript SDK that gives you access to the Vercel REST API.

160

stars

292

commits

TypeScript

primary language

Sep 7, 2026

updated

README

Vercel

Develop. Preview. Ship.

Join the Vercel Community

@vercel/sdk

The @vercel/sdk is a type-safe Typescript SDK that gives you full control over the entire Vercel platform through the Vercel REST API.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @vercel/sdk

PNPM

pnpm add @vercel/sdk

Bun

bun add @vercel/sdk

Yarn

yarn add @vercel/sdk

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@vercel/sdk") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

Access Tokens

You need to pass a valid access token to be able to use any resource or operation. Refer to Creating an Access Token to learn how to create one. Make sure that you create a token with the correct Vercel scope. If you face permission (403) errors when you are already sending a token, it can be one of the following problems:

  • The token you are using has expired. Check the expiry date of the token in the Vercel dashboard.
  • The token does not have access to the correct scope, either not the right team or it does not have account level access.
  • The resource or operation you are trying to use is not available for that team. For example, AccessGroups is an Enterprise only feature and you are using a token for a team on the pro plan.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

NameTypeScheme
bearerTokenhttpHTTP Bearer

To authenticate with the API the bearerToken parameter must be set when initializing the SDK client instance. For example:

import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
  });

  console.log(result);
}

run();

SDK Example Usage

Update an existing project

Update the fields of a project using either its name or id.

import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.updateProject({
    idOrName: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "a-project-name",
      sandbox: {
        region: "iad1",
        failoverRegions: [
          "sfo1",
          "cle1",
        ],
      },
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Vercel SDK

AccessGroups

AiGateway

Aliases

ApiAiGateway

Artifacts

Authentication

Billing

BulkRedirects

Certs

Checks

ChecksV2

Connect

Deployments

Dns

Domains

DomainsRegistrar

Drains

EdgeCache

Environment

FeatureFlags

GlobalConfig

Integrations

Kms

LogDrains

Logs

Marketplace

Microfrontends

Networking

Observability

ProjectRoutes

ProjectMembers

Projects

RollingRelease

Sandboxes

Security

StaticIps

Storage

Teams

User

Vcr

WebAnalytics

Webhooks

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { Vercel } from "@vercel/sdk";
import { openAsBlob } from "node:fs";

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

async function run() {
  const result = await vercel.artifacts.uploadArtifact({
    contentLength: 3848.22,
    xArtifactDuration: 400,
    xArtifactClientCi: "VERCEL",
    xArtifactClientInteractive: 0,
    xArtifactTag: "Tc0BmHvJYMIYJ62/zx87YqO0Flxk+5Ovip25NY825CQ=",
    hash: "12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: await openAsBlob("example.file"),
  });

  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel();

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
  });

  console.log(result);
}

run();

Error Handling

VercelError is the base class for all HTTP error responses. It has the following properties:

PropertyTypeDescription
error.messagestringError message
error.statusCodenumberHTTP response status code eg 404
error.headersHeadersHTTP response headers
error.bodystringHTTP body. Can be empty string if no body is returned.
error.rawResponseResponseRaw HTTP response
error.data$Optional. Some errors may contain structured data. See Error Classes.

Example

import { Vercel } from "@vercel/sdk";
import { CreateApiKeysResponseResponseBody } from "@vercel/sdk/models/createapikeysop.js";
import { VercelError } from "@vercel/sdk/models/vercelerror.js.js";

const vercel = new Vercel();

async function run() {
  try {
    const result = await vercel.createApiKeys({
      purpose: "<value>",
      projectId: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
      name: "API Key for App 123",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof VercelError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof CreateApiKeysResponseResponseBody) {
        console.log(error.data$.error); // models.CreateApiKeysError
      }
    }
  }
}

run();

Error Classes

Primary error:

  • VercelError: The base class for HTTP error responses.
Less common errors (37)

Network errors:

Inherit from VercelError:

  • HttpApiDecodeError: The request did not match the expected schema. Status code 400. Applicable to 17 of 404 methods.*
  • Unauthorized: Unauthorized. Status code 401. Applicable to 17 of 404 methods.*
  • NotAuthorizedForScope: NotAuthorizedForScope. Status code 403. Applicable to 17 of 404 methods.*
  • TooManyRequests: TooManyRequests. Status code 429. Applicable to 17 of 404 methods.*
  • InternalServerError: InternalServerError. Status code 500. Applicable to 17 of 404 methods.*
  • ConnectError: Error response returned by a Connect API operation. Applicable to 11 of 404 methods.*
  • Forbidden: NotAuthorizedForScope. Status code 403. Applicable to 10 of 404 methods.*
  • TldNotSupported: The TLD is not currently supported. Status code 400. Applicable to 7 of 404 methods.*
  • DomainTooShort: The domain name (excluding the TLD) is too short. Status code 400. Applicable to 5 of 404 methods.*
  • DomainNotRegistered: The domain is not registered with Vercel. Status code 400. Applicable to 5 of 404 methods.*
  • DomainNotFound: The domain was not found in our system. Status code 404. Applicable to 5 of 404 methods.*
  • BadRequest: There was something wrong with the request. Status code 400. Applicable to 4 of 404 methods.*
  • ExpectedPriceMismatch: The expected price passed does not match the actual price. Status code 400. Applicable to 4 of 404 methods.*
  • DomainNotAvailable: The domain is not available. Status code 400. Applicable to 4 of 404 methods.*
  • NotFound: NotFound. Status code 404. Applicable to 3 of 404 methods.*
  • OrderTooExpensive: The total price of the order is too high. Status code 400. Applicable to 2 of 404 methods.*
  • InvalidAdditionalContactInfo: Additional contact information provided for the TLD is invalid. Status code 400. Applicable to 2 of 404 methods.*
  • AdditionalContactInfoRequired: Additional contact information is required for the TLD. Status code 400. Applicable to 2 of 404 methods.*
  • LanguageCodeRequired: A language code is required for punycode domains. Status code 400. Applicable to 2 of 404 methods.*
  • TooManyDomains: The number of domains in the order is too high. Status code 400. Applicable to 1 of 404 methods.*
  • DuplicateDomains: Duplicate domains were provided. Status code 400. Applicable to 1 of 404 methods.*
  • DomainAlreadyOwned: The domain is already owned by another team or user. Status code 400. Applicable to 1 of 404 methods.*
  • DNSSECEnabled: The operation cannot be completed because DNSSEC is enabled for the domain. Status code 400. Applicable to 1 of 404 methods.*
  • DomainAlreadyRenewing: The domain is already renewing. Status code 400. Applicable to 1 of 404 methods.*
  • DomainNotRenewable: The domain is not renewable. Status code 400. Applicable to 1 of 404 methods.*
  • BoughtTooRecently: The domain was bought too recently to determine verification status. Status code 400. Applicable to 1 of 404 methods.*
  • CreateApiKeysResponseResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 404 methods.*
  • CreateApiKeysResponse403ResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 404 methods.*
  • DomainCannotBeTransferedOutUntil: The domain cannot be transfered out until the specified date. Status code 409. Applicable to 1 of 404 methods.*
  • CreateApiKeysResponse429ResponseBody: . Status code 429. Applicable to 1 of 404 methods.*
  • CreateApiKeysResponse500ResponseBody: . Status code 500. Applicable to 1 of 404 methods.*
  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  serverURL: "https://api.vercel.com",
});

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Vercel } from "@vercel/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@vercel/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Vercel({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Vercel } from "@vercel/sdk";

const sdk = new Vercel({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

Contributors

github-actions[bot]

159 commits

ismaelrumzan

109 commits

logangingerich

4 commits

simplesagar

4 commits

Similar repos

cloudflare/cloudflare-typescript

The official TypeScript library for the Cloudflare API

808

dropbox/dropbox-sdk-js

The Official Dropbox API V2 SDK for Javascript

970

vercel/vercel-plugin

Comprehensive Vercel ecosystem plugin — relational knowledge graph, skills for every major product,…

280

same org

vercel/v0-sdk

SDK for the v0 Platform API

513

same org

vercel/sandbox

Vercel Sandbox is an ephemeral compute primitive designed to safely run untrusted or user-generated…

197

same org

vercel/vercel

Develop. Preview. Ship.

16,231

same org

openai/openai-node

Official JavaScript / TypeScript library for the OpenAI API

11,171

openai/skills

Skills Catalog for Codex

26,868

Languages

TypeScript

100.0%

vercel/sdk

Vercel SDK is a type-safe Typescript SDK that gives you access to the Vercel REST API.

160

stars

292

commits

TypeScript

primary language

Sep 7, 2026

updated

README

Vercel

Develop. Preview. Ship.

Join the Vercel Community

@vercel/sdk

The @vercel/sdk is a type-safe Typescript SDK that gives you full control over the entire Vercel platform through the Vercel REST API.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @vercel/sdk

PNPM

pnpm add @vercel/sdk

Bun

bun add @vercel/sdk

Yarn

yarn add @vercel/sdk

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@vercel/sdk") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

Access Tokens

You need to pass a valid access token to be able to use any resource or operation. Refer to Creating an Access Token to learn how to create one. Make sure that you create a token with the correct Vercel scope. If you face permission (403) errors when you are already sending a token, it can be one of the following problems:

  • The token you are using has expired. Check the expiry date of the token in the Vercel dashboard.
  • The token does not have access to the correct scope, either not the right team or it does not have account level access.
  • The resource or operation you are trying to use is not available for that team. For example, AccessGroups is an Enterprise only feature and you are using a token for a team on the pro plan.

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

NameTypeScheme
bearerTokenhttpHTTP Bearer

To authenticate with the API the bearerToken parameter must be set when initializing the SDK client instance. For example:

import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
  });

  console.log(result);
}

run();

SDK Example Usage

Update an existing project

Update the fields of a project using either its name or id.

import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.updateProject({
    idOrName: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "a-project-name",
      sandbox: {
        region: "iad1",
        failoverRegions: [
          "sfo1",
          "cle1",
        ],
      },
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Vercel SDK

AccessGroups

AiGateway

Aliases

ApiAiGateway

Artifacts

Authentication

Billing

BulkRedirects

Certs

Checks

ChecksV2

Connect

Deployments

Dns

Domains

DomainsRegistrar

Drains

EdgeCache

Environment

FeatureFlags

GlobalConfig

Integrations

Kms

LogDrains

Logs

Marketplace

Microfrontends

Networking

Observability

ProjectRoutes

ProjectMembers

Projects

RollingRelease

Sandboxes

Security

StaticIps

Storage

Teams

User

Vcr

WebAnalytics

Webhooks

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { Vercel } from "@vercel/sdk";
import { openAsBlob } from "node:fs";

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

async function run() {
  const result = await vercel.artifacts.uploadArtifact({
    contentLength: 3848.22,
    xArtifactDuration: 400,
    xArtifactClientCi: "VERCEL",
    xArtifactClientInteractive: 0,
    xArtifactTag: "Tc0BmHvJYMIYJ62/zx87YqO0Flxk+5Ovip25NY825CQ=",
    hash: "12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: await openAsBlob("example.file"),
  });

  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel();

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
  });

  console.log(result);
}

run();

Error Handling

VercelError is the base class for all HTTP error responses. It has the following properties:

PropertyTypeDescription
error.messagestringError message
error.statusCodenumberHTTP response status code eg 404
error.headersHeadersHTTP response headers
error.bodystringHTTP body. Can be empty string if no body is returned.
error.rawResponseResponseRaw HTTP response
error.data$Optional. Some errors may contain structured data. See Error Classes.

Example

import { Vercel } from "@vercel/sdk";
import { CreateApiKeysResponseResponseBody } from "@vercel/sdk/models/createapikeysop.js";
import { VercelError } from "@vercel/sdk/models/vercelerror.js.js";

const vercel = new Vercel();

async function run() {
  try {
    const result = await vercel.createApiKeys({
      purpose: "<value>",
      projectId: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
      name: "API Key for App 123",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof VercelError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof CreateApiKeysResponseResponseBody) {
        console.log(error.data$.error); // models.CreateApiKeysError
      }
    }
  }
}

run();

Error Classes

Primary error:

  • VercelError: The base class for HTTP error responses.
Less common errors (37)

Network errors:

Inherit from VercelError:

  • HttpApiDecodeError: The request did not match the expected schema. Status code 400. Applicable to 17 of 404 methods.*
  • Unauthorized: Unauthorized. Status code 401. Applicable to 17 of 404 methods.*
  • NotAuthorizedForScope: NotAuthorizedForScope. Status code 403. Applicable to 17 of 404 methods.*
  • TooManyRequests: TooManyRequests. Status code 429. Applicable to 17 of 404 methods.*
  • InternalServerError: InternalServerError. Status code 500. Applicable to 17 of 404 methods.*
  • ConnectError: Error response returned by a Connect API operation. Applicable to 11 of 404 methods.*
  • Forbidden: NotAuthorizedForScope. Status code 403. Applicable to 10 of 404 methods.*
  • TldNotSupported: The TLD is not currently supported. Status code 400. Applicable to 7 of 404 methods.*
  • DomainTooShort: The domain name (excluding the TLD) is too short. Status code 400. Applicable to 5 of 404 methods.*
  • DomainNotRegistered: The domain is not registered with Vercel. Status code 400. Applicable to 5 of 404 methods.*
  • DomainNotFound: The domain was not found in our system. Status code 404. Applicable to 5 of 404 methods.*
  • BadRequest: There was something wrong with the request. Status code 400. Applicable to 4 of 404 methods.*
  • ExpectedPriceMismatch: The expected price passed does not match the actual price. Status code 400. Applicable to 4 of 404 methods.*
  • DomainNotAvailable: The domain is not available. Status code 400. Applicable to 4 of 404 methods.*
  • NotFound: NotFound. Status code 404. Applicable to 3 of 404 methods.*
  • OrderTooExpensive: The total price of the order is too high. Status code 400. Applicable to 2 of 404 methods.*
  • InvalidAdditionalContactInfo: Additional contact information provided for the TLD is invalid. Status code 400. Applicable to 2 of 404 methods.*
  • AdditionalContactInfoRequired: Additional contact information is required for the TLD. Status code 400. Applicable to 2 of 404 methods.*
  • LanguageCodeRequired: A language code is required for punycode domains. Status code 400. Applicable to 2 of 404 methods.*
  • TooManyDomains: The number of domains in the order is too high. Status code 400. Applicable to 1 of 404 methods.*
  • DuplicateDomains: Duplicate domains were provided. Status code 400. Applicable to 1 of 404 methods.*
  • DomainAlreadyOwned: The domain is already owned by another team or user. Status code 400. Applicable to 1 of 404 methods.*
  • DNSSECEnabled: The operation cannot be completed because DNSSEC is enabled for the domain. Status code 400. Applicable to 1 of 404 methods.*
  • DomainAlreadyRenewing: The domain is already renewing. Status code 400. Applicable to 1 of 404 methods.*
  • DomainNotRenewable: The domain is not renewable. Status code 400. Applicable to 1 of 404 methods.*
  • BoughtTooRecently: The domain was bought too recently to determine verification status. Status code 400. Applicable to 1 of 404 methods.*
  • CreateApiKeysResponseResponseBody: The request is not authorized. Status code 401. Applicable to 1 of 404 methods.*
  • CreateApiKeysResponse403ResponseBody: You do not have permission to access this resource. Status code 403. Applicable to 1 of 404 methods.*
  • DomainCannotBeTransferedOutUntil: The domain cannot be transfered out until the specified date. Status code 409. Applicable to 1 of 404 methods.*
  • CreateApiKeysResponse429ResponseBody: . Status code 429. Applicable to 1 of 404 methods.*
  • CreateApiKeysResponse500ResponseBody: . Status code 500. Applicable to 1 of 404 methods.*
  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  serverURL: "https://api.vercel.com",
});

async function run() {
  const result = await vercel.replaceDomainsByDomainRecords({
    domain: "example.com",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Vercel } from "@vercel/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@vercel/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Vercel({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Vercel } from "@vercel/sdk";

const sdk = new Vercel({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

Similar repos

cloudflare/cloudflare-typescript

The official TypeScript library for the Cloudflare API

808

dropbox/dropbox-sdk-js

The Official Dropbox API V2 SDK for Javascript

970

vercel/vercel-plugin

Comprehensive Vercel ecosystem plugin — relational knowledge graph, skills for every major product,…

280

same org

vercel/v0-sdk

SDK for the v0 Platform API

513

same org

vercel/sandbox

Vercel Sandbox is an ephemeral compute primitive designed to safely run untrusted or user-generated…

197

same org

vercel/vercel

Develop. Preview. Ship.

16,231

same org

openai/openai-node

Official JavaScript / TypeScript library for the OpenAI API

11,171

openai/skills

Skills Catalog for Codex

26,868

Contributors

github-actions[bot]

159 commits

ismaelrumzan

109 commits

logangingerich

4 commits

simplesagar

4 commits

Languages

TypeScript

100.0%