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 Gateway19 endpointsAliases6 endpointsArtifacts7 endpointsAuthentication5 endpointsBilling3 endpointsBulk Redirects7 endpointsCerts5 endpointsChecks V210 endpointsConnect14 endpointsDeployments10 endpointsDNS4 endpointsDomains9 endpointsDomains Registrar19 endpointsDrains6 endpointsCDN Cache4 endpointsEnvironment11 endpointsFeature Flags21 endpointsGlobal Config18 endpointsIntegrations10 endpointsKms13 endpointsLogs1 endpointMarketplace25 endpointsMicrofrontends5 endpointsNetworking11 endpointsObservability2 endpointsOrganizations7 endpointsProject Routes8 endpointsProjectmembers3 endpointsProjects33 endpointsRolling Release8 endpointsSandboxes33 endpointsSecurity17 endpointsStatic Ips1 endpointStorage3 endpointsTeams16 endpointsUser4 endpointsVCR27 endpointsVercel Ci23 endpointsWeb Analytics4 endpointsWebhooks4 endpoints