Skip to main content
Vercel is the platform for frontend developers, providing the speed and reliability innovators need to create at the moment of inspiration. With Relevance AI’s Vercel integration, you can seamlessly connect your Vercel projects to your AI agents, enabling them to manage deployments, monitor project status, and automate your development workflows, making your deployment processes more efficient and intelligent.
The Vercel integration in Relevance AI was built by Relevance AI, and is therefore supported by our team, not Vercel. If you have a question or issue with using Vercel in Relevance AI, please reach out to our support team. If you have a question or issue that is only about Vercel, you can reach out to Vercel support.

​
Connect the integration

Connecting your Vercel account to Relevance AI is a straightforward process:
  1. Go to the “Integrations” page in the sidebar of your Relevance AI dashboard.
  2. Click on “Vercel” from the available integrations.
  3. Click on the “Add Integration” button.
  4. In the pop-up window, sign into your Vercel account.
  5. Grant the necessary permissions for Relevance AI to access your Vercel projects and deployments.
  6. Once authenticated, your Vercel account will appear as a connected integration.

​
Tool steps for Vercel

The Vercel integration provides a comprehensive set of actions that your agents can use to interact with your deployments and development workflows. These actions can be incorporated into your agent’s workflows as tool steps, enabling sophisticated deployment automation capabilities.

​
Deployment Management

Create Deployment

Create a new deployment for a Vercel project with custom configurations

List Deployments

Retrieve a list of deployments with filtering options

Cancel Deployment

Cancel an ongoing or queued deployment

​
Advanced Operations

Vercel API Call

Make authorized requests to any Vercel API endpoint
Type “Vercel” in the tool step search bar to see all available Vercel actions when building your tools.

​
Use the integration’s API tool step (Advanced)

In addition to the pre-built actions available in the tool directory, you can build custom tools that perform Vercel-specific activities using the Vercel API Call tool step.

​
How to use the Vercel API Call tool step

1

Create a new tool

Create a new tool in Relevance AI or open an existing tool you want to add Vercel functionality to.
2

Add the Vercel API Call tool step

  1. Scroll down to Tool-steps
  2. Search for “Vercel API Call” in the tool step search bar
  3. Add the Vercel API Call tool step to your workflow
3

Select your Vercel account

Select your connected Vercel account from the dropdown menu.
4

Configure the API endpoint

Configure the API endpoint, method, and parameters according to your needs:
  • Method: Select the HTTP method (GET, POST, PUT, DELETE, PATCH)
  • Path: Enter the API endpoint path (e.g., /v13/deployments)
  • Body: Add any required request body data
  • Headers: Add any custom headers if needed
5

Test your API call

Test your configuration to ensure it works correctly before deploying.

​
Example: Getting Deployment Details

Here’s a practical example of using the Vercel API Call tool step to retrieve details about a specific deployment: API Endpoint: GET /v13/deployments/{id} Configuration: 
{
  "method": "GET",
  "path": "/v13/deployments/dpl_ABC123xyz",
  "headers": {}
}
This configuration:
  • Uses the GET method to retrieve deployment information
  • Specifies the deployment ID in the path
  • Returns comprehensive details about the deployment including status, creator, and metadata
You can find Vercel’s complete API documentation at https://vercel.com/docs/rest-api.

​
Common Vercel API Endpoints

Here are some commonly used Vercel API endpoints you can use with the API Call tool step:
  • List deployments: GET /v6/deployments
  • Get deployment: GET /v13/deployments/{id}
  • Create deployment: POST /v13/deployments
  • Cancel deployment: PATCH /v12/deployments/{id}/cancel
  • Delete deployment: DELETE /v13/deployments/{id}
View API Documentation
  • List projects: GET /v9/projects
  • Get project: GET /v9/projects/{id}
  • Create project: POST /v10/projects
  • Update project: PATCH /v9/projects/{id}
  • Delete project: DELETE /v9/projects/{id}
View API Documentation
  • List domains: GET /v5/domains
  • Get domain: GET /v5/domains/{domain}
  • Add domain: POST /v10/projects/{id}/domains
  • Remove domain: DELETE /v9/projects/{id}/domains/{domain}
View API Documentation
  • List env variables: GET /v9/projects/{id}/env
  • Create env variable: POST /v10/projects/{id}/env
  • Update env variable: PATCH /v9/projects/{id}/env/{id}
  • Delete env variable: DELETE /v9/projects/{id}/env/{id}
View API Documentation
  • List teams: GET /v2/teams
  • Get team: GET /v2/teams/{id}
  • List team members: GET /v2/teams/{id}/members
View API Documentation

​
Example use cases

Here are some ways you can leverage the Vercel integration with your agents:
Create an agent that automatically triggers deployments when specific conditions are met, such as successful test runs, code reviews, or scheduled times. The agent can monitor your repository, validate changes, and deploy to the appropriate environment (production, staging, or preview) based on your workflow rules.
Build an agent that manages deployments across multiple environments simultaneously. The agent can coordinate staging deployments for testing, automatically promote successful builds to production, and maintain environment-specific configurations and variables.
Deploy an agent that continuously monitors deployment status, tracks build times, and alerts your team when deployments fail or take longer than expected. The agent can provide detailed reports on deployment health and performance metrics.
Create an agent that automatically detects deployment issues through error monitoring or performance degradation and initiates rollbacks to the last stable version. The agent can analyze logs, monitor error rates, and make intelligent decisions about when to rollback.
Build an agent that analyzes traffic patterns and schedules deployments during low-traffic periods to minimize user impact. The agent can optimize deployment timing based on historical data and current system load.
Deploy an agent that bridges your CI/CD pipeline with Vercel deployments, automatically triggering builds when tests pass, managing preview deployments for pull requests, and coordinating multi-stage deployment workflows.
Create an agent that sends customized notifications to different stakeholders (developers, QA, product managers) about deployment events. The agent can provide context-aware updates via Slack, email, or other channels based on deployment status and team preferences.
Build an agent that automatically creates and manages preview deployments for feature branches, assigns unique URLs, notifies reviewers, and cleans up old preview deployments to optimize resource usage.

​
Frequently asked questions (FAQs)

The integration requires permissions to manage deployments, access project information, and read deployment logs. You can review the specific permissions during the authentication process. Vercel uses OAuth for secure authentication, ensuring your credentials are never stored directly.
Yes, you can configure your tools and triggers to only interact with specific projects by setting the appropriate project parameters. Additionally, you can use Vercel’s team-based access controls to limit which projects are accessible through the integration.
When you connect your Vercel account through the Integrations page, Relevance AI handles authentication automatically using OAuth. When using the Vercel API Call tool step, simply select your connected Vercel account from the dropdown, and authentication will be handled for you.
Pre-built tool steps (like “Create Deployment” or “List Deployments”) are designed for specific, common tasks and have simplified interfaces with guided inputs. The Vercel API Call tool step gives you full access to Vercel’s REST API, allowing you to implement any functionality available in the API, including advanced or custom operations not covered by pre-built steps.
Yes! You can set up Vercel webhooks to trigger your agents when specific events occur in your projects (like deployment started, deployment completed, or deployment failed). Configure webhooks in your Vercel project settings to point to your agent’s webhook URL in Relevance AI.
Yes, Vercel enforces rate limits on API calls. The specific limits depend on your Vercel plan. Your agents should be designed to handle rate limiting gracefully. You can check your current rate limit status in the API response headers.
Yes! You can use the Vercel API Call tool step to create, update, and delete environment variables for your projects. This allows your agents to dynamically manage configuration across different environments.
Use the “Cancel Deployment” tool step or the Vercel API Call with the PATCH /v12/deployments/{id}/cancel endpoint. You’ll need the deployment ID, which you can obtain from the “List Deployments” tool step or from deployment creation responses.
Yes! When creating a deployment, you can specify the branch, environment (production, preview, or development), and other configuration options. This allows your agents to manage multi-environment deployment strategies effectively.