tools-only Documentation
- Getting Started: This step-by-step tutorial will help you get started with Vercel, an end-to-end platform for developers that allows you to create and deploy your web application.
- Projects and Deployments: Streamline your workflow with Vercel's project and deployment management. Boost productivity and scale effortlessly.
- Use a Template: Create a new project on Vercel by using a template
- Import Existing Project: Create a new project on Vercel by importing your existing frontend project, built on any of our supported frameworks.
- Add a Domain: Easily add a custom domain to your Vercel project. Enhance your brand presence and optimize SEO with just a few clicks.
- Buy a Domain: Purchase your domain with Vercel. Expand your online reach and establish a memorable online identity.
- Transfer an Existing Domain: Seamlessly integrate your existing domain with Vercel. Maximize flexibility and maintain your established online presence.
- Collaborate: Amplify collaboration and productivity with Vercel's CI/CD tools, such as Comments. Empower your team to build and deploy together seamlessly.
- Next Steps: Discover the next steps to take on your Vercel journey. Unlock new possibilities and harness the full potential of your projects.
- Supported Frameworks: Vercel supports a wide range of the most popular frameworks, optimizing how your application builds and runs no matter what tool you use.
- Full-stack: Vercel supports a wide range of the most popular backend frameworks, optimizing how your application builds and runs no matter what tooling you use.
- Frontends: Vercel supports a wide range of the most popular frontend frameworks, optimizing how your application builds and runs no matter what tooling you use.
- Astro: Learn how to use Vercel's features with Astro
- Vite: Learn how to use Vercel's features with Vite.
- React Router: Learn how to use Vercel's features with React Router as a framework.
- Gatsby: Learn how to use Vercel's features with Gatsby.
- Create React App: Learn how to use Vercel's features with Create React App
- Backends: Vercel supports a wide range of the most popular backend frameworks, optimizing how your application builds and runs no matter what tooling you use.
- Nitro: Deploy Nitro applications to Vercel with zero configuration. Learn about observability, ISR, and custom build configurations.
- Express: Deploy Express applications to Vercel with zero configuration. Learn about middleware and Vercel Functions.
- FastAPI: Deploy FastAPI applications to Vercel with zero configuration. Learn about the Python runtime, ASGI, static assets, and Vercel Functions.
- Fastify: Deploy Fastify applications to Vercel with zero configuration.
- Flask: Deploy Flask applications to Vercel with zero configuration. Learn about the Python runtime, WSGI, static assets, and Vercel Functions.
- Hono: Deploy Hono applications to Vercel with zero configuration. Learn about observability, ISR, and custom build configurations.
- NestJS: Deploy NestJS applications to Vercel with zero configuration.
- xmcp: Build MCP-compatible backends with xmcp and deploy to Vercel. Learn the project structure, tool format, middleware, and how to run locally and in production.
- All Frameworks: Learn about the frameworks that can be deployed to Vercel.
- Incremental Migration: Learn how to migrate your app or website to Vercel with minimal risk and high impact.
- Production Checklist: Ensure your application is ready for launch with this comprehensive production checklist by the Vercel engineering team. Covering operational excellence, security, reliability, performance efficiency, and cost optimization.
- Docs llms-full.txt: Learn about docs llms-full.txt features and configuration.
Access
- Account Management: Learn how to manage your Vercel account and team members.
- Activity Log: Learn how to use the Activity Log, which provides a list of all events on a Hobby team or team, chronologically organized since its creation.
- Deployment Protection: Learn how to secure your Vercel project's preview and production URLs with Deployment Protection. Configure fine-grained access control at the project level for different deployment environments.
- Bypass Deployment Protection: Learn how to bypass Deployment Protection for specific domains, or for all deployments in a project.
- Exceptions: Learn how to disable Deployment Protection for a list of preview domains.
- OPTIONS Allowlist: Learn how to disable Deployment Protection for CORS preflight requests for a list of paths.
- Protection Bypass for Automation: Learn how to bypass Vercel Deployment Protection for automated tooling (e.g. E2E testing).
- Sharable Links: Learn how to share your deployments with external users.
- Protect Deployments: Learn about the different methods to protect your deployments on Vercel, including Vercel Authentication, Password Protection, and Trusted IPs.
- Password Protection: Learn how to protect your deployments with a password.
- Trusted IPs: Learn how to restrict access to your deployments to a list of trusted IP addresses.
- Vercel Authentication: Learn how to use Vercel Authentication to restrict access to your deployments.
- Bypass Deployment Protection: Learn how to bypass Deployment Protection for specific domains, or for all deployments in a project.
- Directory Sync: Learn how to configure Directory Sync for your Vercel Team.
- SAML SSO: Learn how to configure SAML SSO for your organization on Vercel.
- Two-factor (2FA): Learn how to configure two-factor authentication for your Vercel account.
AI
- Vercel Agent: AI-powered development tools that speed up your workflow and help resolve issues faster
- Code Review: Get automatic AI-powered code reviews on your pull requests
- Managing Reviews: Customize which repositories get reviewed and track your review metrics and spending.
- Investigation: Let AI investigate your error alerts to help you debug faster
- Pricing: Understand how Vercel Agent pricing works and how to manage your credits
- Code Review: Get automatic AI-powered code reviews on your pull requests
- AI SDK: TypeScript toolkit for building AI-powered applications with React, Next.js, Vue, Svelte and Node.js
- AI Gateway: TypeScript toolkit for building AI-powered applications with React, Next.js, Vue, Svelte and Node.js
- Getting Started: Guide to getting started with AI Gateway
- Models & Providers: Learn about models and providers for the AI Gateway.
- Observability: Learn how to monitor and debug your AI Gateway requests.
- Pricing: Learn about pricing for the AI Gateway.
- Provider Options: Configure provider routing, ordering, and fallback behavior in Vercel AI Gateway
- OpenAI-Compatible API: Use OpenAI-compatible API endpoints with the AI Gateway for seamless integration with existing tools and libraries.
- Authentication: Learn how to authenticate with the AI Gateway using API keys and OIDC tokens.
- BYOK: Learn how to configure your own provider keys with the AI Gateway.
- Usage & Billing: Monitor your AI Gateway credit balance, usage, and generation details.
- Framework Integrations: Explore available community framework integrations with Vercel AI Gateway
- LangChain: Learn how to integrate Vercel AI Gateway with LangChain to access multiple AI models through a unified interface
- LangFuse: Learn how to integrate Vercel AI Gateway with LangFuse to access multiple AI models through a unified interface
- LiteLLM: Learn how to integrate Vercel AI Gateway with LiteLLM to access multiple AI models through a unified interface
- LlamaIndex: Learn how to integrate Vercel AI Gateway with LlamaIndex to access multiple AI models through a unified interface
- Mastra: Learn how to integrate Vercel AI Gateway with Mastra to access multiple AI models through a unified interface
- Pydantic AI: Learn how to integrate Vercel AI Gateway with Pydantic AI to access multiple AI models through a unified interface
- App Attribution: Attribute your requests so Vercel can identify and feature your app on AI Gateway pages
- Image Generation: Generate and edit images using AI models through Vercel AI Gateway with support for multiple providers and modalities.
- Model Variants: Enable provider-specific capabilities (like Anthropic 1M context) via headers when calling models through AI Gateway.
- MCP: Learn more about MCP and how you can use it on Vercel.
- Deploy MCP servers: Learn how to deploy Model Context Protocol (MCP) servers on Vercel with OAuth authentication and efficient scaling.
- Vercel MCP server: Vercel MCP has tools available for searching docs along with managing teams, projects, and deployments.
- Tools: Available tools in Vercel MCP for searching docs and managing teams, projects, and deployments.
- Integrations for Agents: Install AI agents and services through the Vercel Marketplace to automate workflows and build custom AI systems.
- Integrations for Models: Integrate powerful AI services and models seamlessly into your Vercel projects.
- Adding a Provider: Learn how to add a new AI provider to your Vercel projects.
- Adding a Model: Learn how to add a new AI model to your Vercel projects
- xAI: Learn how to add the xAI native integration with Vercel.
- Groq: Learn how to add the Groq native integration with Vercel.
- fal: Learn how to add the fal native integration with Vercel.
- Deep Infra: Learn how to add the Deep Infra native integration with Vercel.
- ElevenLabs: Learn how to add the ElevenLabs connectable account integration with Vercel.
- LMNT: Learn how to add LMNT connectable account integration with Vercel.
- OpenAI: Integrate your Vercel project with OpenAI's powerful suite of models.
- Perplexity: Learn how to add Perplexity connectable account integration with Vercel.
- Pinecone: Learn how to add Pinecone connectable account integration with Vercel.
- Replicate: Learn how to add Replicate connectable account integration with Vercel.
- Together AI: Learn how to add Together AI connectable account integration with Vercel.
- Workflow: Build durable, reliable, and observable applications and AI agents with the Workflow Development Kit (WDK).
API
- REST API: Learn about rest api features and configuration.
- Vercel SDK: Learn about vercel sdk features and configuration.
- Build Output API: The Build Output API is a file-system-based specification for a directory structure that can produce a Vercel deployment.
- Build Output Configuration: Learn about the Build Output Configuration file, which is used to configure the behavior of a Deployment.
- Features: Learn how to implement common Vercel platform features through the Build Output API.
- Vercel Primitives: Learn about the Vercel platform primitives and how they work together to create a Vercel Deployment.
Build & Deploy
- Builds: Understand how the build step works when creating a Vercel Deployment.
- Build Features: Learn how to customize your deployments using Vercel's build features.
- Build Image: Learn about the container image used for Vercel builds.
- Build Queues: Understand how concurrency and same branch build queues manage multiple simultaneous deployments.
- Configuring a Build: Vercel automatically configures the build settings for many front-end frameworks, but you can also customize the build according to your requirements.
- Managing Builds: Vercel allows you to increase the speed of your builds when needed in specific situations and workflows.
- Deploy Hooks: Learn how to create and trigger deploy hooks to integrate Vercel deployments with other systems.
- Deployment Checks: Set conditions that must be met before proceeding to the next phase of the deployment lifecycle.
- Deployment Retention: Learn how Deployment Retention policies affect a deployment's lifecycle
- Deployments: Learn how to create and manage deployments on Vercel.
- Environments: Environments are for developing locally, testing changes in a pre-production environment, and serving end-users in production.
- Generated URLs: When you create a new deployment, Vercel will automatically generate a unique URL which you can use to access that particular deployment.
- Managing Deployments: Learn how to manage your current and previously deployed projects to Vercel through the dashboard. You can redeploy at any time and even delete a deployment.
- Promoting Deployments: Learn how to promote deployments to production on Vercel.
- Troubleshoot Build Errors: Learn how to resolve common scenarios you may encounter during the Build step, including build errors that cancel a deployment and long build times.
- Accessing Build Logs: Learn how to use Vercel's build logs to monitor the progress of building or running your deployment, and check for possible errors or build failures.
- Claim Deployments: Learn how to take ownership of deployments on Vercel with the Claim Deployments feature.
- Inspect OG Metadata: Learn how to inspect and validate your Open Graph metadata through the Open Graph deployment tab.
- Preview Deployment Suffix: When you create a new deployment, Vercel will automatically generate a unique URL which you can use to access that particular deployment.
- Sharing a Preview Deployment: Learn how to share a preview deployment with your team and external collaborators.
- Troubleshoot project collaboration: Learn about common reasons for deployment issues related to team member requirements and how to resolve them.
- Environment Variables: Learn more about environment variables on Vercel.
- Framework Environment Variables: Framework environment variables are automatically populated by the Vercel, based on your project's framework.
- Managing Environment Variables: Learn how to create and manage environment variables for Vercel.
- Reserved Environment Variables: Reserved environment variables are reserved by Vercel Vercel Function runtimes.
- Sensitive Environment Variables: Environment variables that cannot be decrypted once created.
- Shared Environment Variables: Learn how to use Shared environment variables, which are environment variables that you define at the Team level and can link to multiple projects.
- System Environment Variables: System environment variables are automatically populated by Vercel, such as the URL of the deployment or the name of the Git branch deployed.
- Git Integrations: Vercel allows for automatic deployments on every branch push and merges onto the production branch of your GitHub, GitLab, and Bitbucket projects.
- GitHub: Vercel for GitHub automatically deploys your GitHub projects with Vercel, providing Preview Deployment URLs, and automatic Custom Domain updates.
- Azure DevOps: Vercel for Azure DevOps allows you to deploy Azure Pipelines to Vercel automatically.
- Bitbucket: Vercel for Bitbucket automatically deploys your Bitbucket projects with Vercel, providing Preview Deployment URLs, and automatic Custom Domain updates.
- GitLab: Vercel for GitLab automatically deploys your GitLab projects with Vercel, providing Preview Deployment URLs, and automatic Custom Domain updates.
- Instant Rollback: Learn how to perform an Instant Rollback on your production deployments and quickly roll back to a previously deployed production deployment.
- Microfrontends: Learn how to use microfrontends on Vercel to split apart large applications, improve developer experience and make incremental migrations easier.
- Getting Started: Learn how to get started with microfrontends on Vercel.
- Local Development: Learn how to run and test your microfrontends locally.
- Path Routing: Route paths on your domain to different microfrontends.
- Managing Microfrontends: Learn how to manage your microfrontends on Vercel.
- Security: Learn how to manage your Deployment Protection and Firewall for your microfrontend on Vercel.
- Using Vercel Toolbar: Learn how to use the Vercel Toolbar to make it easier to manage microfrontends.
- Testing & Troubleshooting: Learn about testing, common issues, and how to troubleshoot microfrontends on Vercel.
- Monorepos: Vercel provides support for monorepos. Learn how to deploy a monorepo here.
- Turborepo: Learn about Turborepo, a build system for monorepos that allows you to have faster incremental builds, content-aware hashing, and Remote Caching.
- Remote Caching: Vercel Remote Cache allows you to share build outputs and artifacts across distributed teams.
- Nx: Nx is an extensible build system with support for monorepos, integrations, and Remote Caching on Vercel. Learn how to deploy Nx to Vercel with this guide.
- Monorepos FAQ: Learn the answer to common questions about deploying monorepos on Vercel.
- Package Managers: Discover the package managers supported by Vercel for dependency management. Learn how Vercel detects and uses npm, Yarn, pnpm, and Bun for optimal build performance.
- Protected Git Scopes: Learn how to limit other Vercel teams from deploying from your Git repositories.
- Rolling Releases: Learn how to use Rolling Releases for more cautious deployments.
- Skew Protection: Learn how Vercel's Skew Protection ensures that the client and server stay in sync for any particular deployment.
- Webhooks: Learn how to set up webhooks and use them with Vercel Integrations.
- Webhooks API Reference: Vercel Integrations allow you to subscribe to certain trigger-based events through webhooks. Learn about the supported webhook events and how to use them.
CDN
- Overview: Vercel's CDN enables you to store content close to your customers and run compute in regions close to your data, reducing latency and improving end-user performance.
- Regions: View the list of regions supported by Vercel's CDN and learn about our global infrastructure.
- Headers: This reference covers the list of request, response, cache-control, and custom response headers included with deployments with Vercel.
- Security Headers: Learn how the Content Security Policy (CSP) offers defense against web vulnerabilities, its key features, and best practices.
- Cache-Control Headers: Learn about the cache-control headers sent to each Vercel deployment and how to use them to control the caching behavior of your application.
- Request Headers: Learn about the request headers sent to each Vercel deployment and how to use them to process requests before sending a response.
- Response Headers: Learn about the response headers sent to each Vercel deployment and how to use them to process responses before sending a response.
- Cache: Vercel's Cache caches your content at the edge in order to serve data to your users as fast as possible. Learn how Vercel caches works in this guide.
- Purge: Learn how to invalidate and purge cached content on Vercel's CDN, including cache keys and manual purging options.
- Encryption: Learn how Vercel encrypts data in transit and at rest.
- Compression: Vercel helps reduce data transfer and improve performance by supporting both Gzip and Brotli compression
- Incremental Static Regeneration: Learn how Vercel's Incremental Static Regeneration (ISR) provides better performance and faster builds.
- Getting Started: Learn how to use Incremental Static Regeneration (ISR) to regenerate your pages without rebuilding and redeploying your site.
- Usage & Pricing: This page outlines information on the limits that are applicable to using Incremental Static Regeneration (ISR), and the costs they can incur.
- Redirects: Learn how to use redirects on Vercel to instruct Vercel's platform to redirect incoming requests to a new URL.
- Rewrites: Learn how to use rewrites to send users to different URLs without modifying the visible URL.
- Domains: Learn the fundamentals of how domains, DNS, and nameservers work on Vercel.
- Working with Domains: Learn how domains work and the options Vercel provides for managing them.
- Adding a Domain: Learn how to add a custom domain to your Vercel project, verify it, and correctly set the DNS or Nameserver values.
- Adding a Domain to an Environment: Learn how to add a custom domain to your Vercel project, verify it, and correctly set the DNS or Nameserver values.
- Assigning a Domain to a Git Branch: Learn how to assign a domain to a different Git branch with this guide.
- Deploying & Redirecting Domains: Learn how to deploy your domains and set up domain redirects with this guide.
- Removing a Domain: Learn how to remove a domain from a Project and from your account completely with this guide.
- Renewing a Domain: Learn how to manage automatic and manual renewals for custom domains purchased through or registered with Vercel, and how to redeem expired domains with this guide.
- Transferring Domains: Domains can be transferred to another team or project within Vercel, or to and from a third-party registrar. Learn how to transfer domains with this guide.
- Viewing & Searching Domains: Learn how to view and search all registered domains that are assigned to Vercel Projects through the Vercel dashboard.
- Working with DNS: Learn how DNS works in order to properly configure your domain.
- Managing DNS Records: Learn how to add, verify, and remove DNS records for your domains on Vercel with this guide.
- Working with Nameservers: Learn about nameservers and the benefits Vercel nameservers provide.
- Managing Nameservers: Learn how to add custom nameservers and restore original nameservers for your domains on Vercel with this guide.
- Working with SSL: Learn how Vercel uses SSL certification to keep your site secure.
- Custom SSL Certificates: By default, Vercel provides all domains with a custom SSL certificates. However, Enterprise teams can upload their own custom SSL certificate.
- Pre-Generate SSL Certificates: test
- Supported Domains: Learn about supported domains for purchase features and configuration.
- Troubleshooting Domains: Learn about common reasons for domain misconfigurations and how to troubleshoot your domain on Vercel.
- Using Domains API: Programmatically search, price, purchase, renew, and manage domains with Vercel's domains registrar API endpoints.
- Working with Domains: Learn how domains work and the options Vercel provides for managing them.
- Image Optimization: Transform and optimize images to improve page load performance.
- Getting Started: Learn how you can leverage Vercel Image Optimization in your projects.
- Limits and Pricing: This page outlines information on the limits that are applicable when using Image Optimization, and the costs they can incur.
- Managing Usage & Costs: Learn how to measure and manage Image Optimization usage with this guide to avoid any unexpected costs.
- Legacy Pricing: This page outlines information on the pricing and limits for the source images-based legacy option.
- Manage CDN Usage: Learn how to understand the different charts in the Vercel dashboard. Learn how usage relates to billing, and how to optimize your usage for CDN.
- Request Collapsing: Learn how Vercel's CDN shields your origin during traffic surges for uncached routes.
Collaboration
- Comments: Comments allow teams and invited participants to give direct feedback on preview deployments. Learn more about Comments in this overview.
- Enabling Comments: Learn when and where Comments are available, and how to enable and disable Comments at the account, project, and session or interface levels.
- Using Comments: This guide will help you get started with using Comments with your Vercel Preview Deployments.
- Managing Comments: Learn how to manage Comments on your Preview Deployments from Team members and invited collaborators.
- Integrations: Learn how Comments integrates with Git providers like GitHub, GitLab, and BitBucket, as well as Vercel's Slack app.
- Draft Mode: Vercel's Draft Mode enables you to view your unpublished headless CMS content on your site before publishing it.
- Edit Mode: Discover how Vercel's Edit Mode enhances content management for headless CMSs, enabling real-time editing, and seamless collaboration.
- Feature Flags: Learn how to use feature flags with Vercel's DX platform.
- Flags Explorer: View and override your application's feature flags from the Vercel Toolbar
- Getting Started: Learn how to set up the Flags Explorer so you can see and override your application's feature flags
- Reference: In-depth reference for configuring the Flags Explorer
- Pricing: Learn about pricing for Flags Explorer.
- Flags SDK: The Flags SDK is a free open-source library that gives developers the tools they need to use feature flags in Next.js and SvelteKit applications.
- With Runtime Logs: Integrate your feature flag provider with runtime logs.
- With Vercel Platform: Integrate your feature flags with the Vercel Platform.
- With Web Analytics: Learn how to tag your page views and custom events with feature flags
- Flags Explorer: View and override your application's feature flags from the Vercel Toolbar
- Toolbar: Learn how to use the Vercel Toolbar to leave feedback, navigate through important dashboard pages, share deployments, use Draft Mode for previewing unpublished content, and Edit Mode for editing content in real-time.
- Add to Environments: Learn how to use the Vercel Toolbar in production and local environments.
- Add to Localhost: Learn how to use the Vercel Toolbar in your local environment.
- Add to Production: Learn how to add the Vercel Toolbar to your production environment and how your team members can use tooling to access the toolbar.
- Managing Toolbar: Learn how to enable or disable the Vercel Toolbar for your team, project, and session.
- Browser Extensions: The browser extensions enable you to use the toolbar in production environments, take screenshots and attach them to comments, and set personal preferences for how the toolbar behaves.
- Accessibility Audit Tool: Learn how to use the Accessibility Audit Tool to automatically check the Web Content Accessibility Guidelines 2.0 level A and AA rules.
- Interaction Timing Tool: The interaction timing tool allows you to inspect in detail each interaction's latency and get notified for interactions taking >200ms.
- Layout Shift Tool: The layout shift tool gives you insight into any elements that may cause layout shifts on the page.
- Add to Environments: Learn how to use the Vercel Toolbar in production and local environments.
Compute
- Fluid Compute: Learn about fluid compute, an execution model for Vercel Functions that provides a more flexible and efficient way to run your functions.
- Functions: Vercel Functions allow you to run server-side code without managing a server.
- Getting Started: Build your first Vercel Function in a few steps.
- [Streaming](https://vercel.com/docs/functions/stre
…(truncated)