Vercel SDK Reference

Using the Vercel SDK

The @vercel/sdk is a type-safe TypeScript SDK that allows you to access the resources and methods of the Vercel REST API.

Installing Vercel SDK

To download and install Vercel SDK, run the following command:

Authentication

Vercel 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:

Troubleshooting

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.

Endpoints

Browse all available SDK methods grouped by category.

Related Vercel documentation