The @vercel/sdk is a type-safe TypeScript SDK that allows you to access the resources and methods of the Vercel REST API.
To download and install Vercel SDK, run the following command:
Terminal
pnpm i @vercel/sdkVercel Access Tokens are required to authenticate and use the Vercel SDK. Once you have created a token, you can use it to initialize the SDK as follows:
run.ts
import { Vercel } from '@vercel/sdk';
const vercel = new Vercel({ bearerToken: '<YOUR_BEARER_TOKEN_HERE>',});Make sure that you create a token with the correct Vercel team. 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.
Browse all available SDK methods grouped by category.
Access Groups11 endpointsAi Gateway4 endpointsAliases6 endpointsAPI Ai Gateway8 endpointsArtifacts7 endpointsAuthentication5 endpointsBilling3 endpointsBulk Redirects7 endpointsCerts5 endpointsChecks V210 endpointsConnect13 endpointsDeployments10 endpointsDNS4 endpointsDomains9 endpointsDomains Registrar17 endpointsDrains6 endpointsEdge Cache4 endpointsEnvironment11 endpointsFeature Flags21 endpointsGlobal Config18 endpointsIntegrations10 endpointsKms13 endpointsLogs1 endpointMarketplace25 endpointsMicrofrontends5 endpointsNetworking11 endpointsObservability2 endpointsProject Routes8 endpointsProjectmembers3 endpointsProjects32 endpointsRolling Release8 endpointsSandboxes30 endpointsSecurity13 endpointsStatic Ips1 endpointStorage3 endpointsTeams16 endpointsUser4 endpointsVCR27 endpointsWeb Analytics4 endpointsWebhooks4 endpoints
Cross-link map: Vercel SDK Reference (/docs/rest-api/sdk)
From the Vercel docs graph (built 2026-09-06T06:25:16.735Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json
Semantically closest pages
- Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.
- Audit Logs — Learn how to track and analyze your team members' activities.
- Update an existing Drain — PATCH /v1/drains/{id} — Update the configuration of an existing drain.
- Working with Drains — Drains collect logs, traces, speed insights, and analytics from your applications. Forward observability data to custom
- Retrieve a list of all Drains — GET /v1/drains — Allows to retrieve the list of Drains of the authenticated team.
This page links to (2)
- Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.
- REST API Errors — General and specific errors you may encounter when using the Vercel REST API.
Pages that link here (10)
By site: vercel-changelog (1) · vercel-docs (9)
From vercel-changelog
From vercel-docs
- Programmatic Domain Management — Programmatically search, price, purchase, renew, and manage domains with Vercel's domains registrar API endpoints.
- Vercel for Platforms — Build platforms where agents and users deploy apps with isolated projects or shared multi-tenant deployments.
- Multi-Project Platforms Reference — API reference, error codes, troubleshooting, and FAQ for multi-project platforms on Vercel.
- Configuring Custom Domains — Add, verify, redirect, and remove wildcard and custom domains for a multi-tenant application using the Vercel SDK.
- Multi-Tenant Platform Quickstart — Set up wildcard domains, custom domains, domain verification, and redirects for a multi-tenant application on Vercel.
- Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.
- Make Your First Vercel API Request — Create a scoped Vercel access token, make a read-only REST API request, and call the same operation with the Vercel SDK.
- Vercel Documentation Sitemap — Browse Vercel documentation pages with summaries, prerequisites, and topics.
- Using the REST API with the Firewall — Learn how to interact with the security endpoints of the Vercel REST API programmatically.