Vercel

Learn how to use Vercel with Composio

Overview

SLUG: VERCEL

Description

Vercel is a platform for frontend frameworks and static sites, enabling developers to host websites and web services that deploy instantly, scale automatically, and require minimal configuration.

Authentication Details

bearer_token
stringRequired
generic_id
string

Connecting to Vercel

Create an auth config

Use the dashboard to create an auth config for the Vercel toolkit. This allows you to connect multiple Vercel accounts to Composio for agents to use.

1

Select App

Navigate to Vercel.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Vercel Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4vercel_auth_config_id = "ac_YOUR_VERCEL_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": user_api_key}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Vercel for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, vercel_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Vercel toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["VERCEL"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Environment Variable

Description

Tool to add an environment variable to a vercel project. use after confirming the project exists and you need to configure secrets or configuration values across environments before deployment. example: "add api key=secret to production".

Action Parameters

comment
string
customEnvironmentIds
array
gitBranch
string
idOrName
stringRequired
key
stringRequired
slug
string
target
arrayRequired
teamId
string
type
stringRequired
upsert
boolean
value
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check Cache Artifact Exists

Description

Tool to check if a cache artifact exists by its hash. use when verifying whether a cache artifact is already stored before upload.

Action Parameters

hash
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check Domain Availability

Description

Tool to check if a domain is available for registration. use when you need to verify domain availability before purchase.

Action Parameters

name
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check Domain Price

Description

Tool to check the price for a domain before purchase. use when evaluating cost and availability prior to domain registration.

Action Parameters

name
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Auth Token

Description

Tool to create a new authentication token. use when you need to programmatically generate a new token after validating permissions. example: "create auth token named my-token"

Action Parameters

name
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Edge Config

Description

Tool to create a new edge config for a vercel project. use when you need to define edge caching settings before deploying your project across a specified repository.

Action Parameters

description
string
name
stringRequired
projectId
stringRequired
slug
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create new deployment

Description

Tool to create a new deployment. use when you need to deploy files or a git commit to a vercel project.

Action Parameters

deploymentId
string
files
array
forceNew
string
gitMetadata
object
gitSource
object
meta
object
name
string
project
string
projectSettings
object
skipAutoDetectionConfirmation
string
slug
string
target
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Auth Token

Description

Tool to delete an authentication token. use when you need to revoke a token programmatically after confirming its validity. example: "delete auth token with id abc123"

Action Parameters

tokenId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Deployment

Description

Tool to delete a specific deployment by its unique id. use after confirming the deployment identifier to clean up unused or failed deployments.

Action Parameters

id
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Environment Variable

Description

Tool to delete a specific environment variable from a project. use after verifying the correct variable id to remove it.

Action Parameters

customEnvironmentId
string
id
stringRequired
idOrName
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Vercel Project

Description

Tool to delete a specific project by its id or name. use after confirming the correct project id or name to permanently remove it.

Action Parameters

id
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Deploy Edge Function

Description

Deploy edge functions to vercel. use when you need to deploy serverless functions that run on the edge runtime with fast cold starts and global distribution.

Action Parameters

files
arrayRequired
name
stringRequired
project
string
projectSettings
object
target
stringDefaults to production
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get deployment details

Description

Tool to retrieve detailed information about a specific deployment. use after triggering a deployment and you need to inspect its status and configuration. example: "get details for deployment dpl 123abc".

Action Parameters

idOrUrl
stringRequired
slug
string
teamId
string
withGitRepoInfo
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Deployment Events

Description

Tool to retrieve events related to a specific deployment. use when monitoring or debugging deployment history or streaming real-time events. example: "get events for deployment dpl xxx since 1540095775941."

Action Parameters

builds
integer
delimiter
integer
direction
stringDefaults to forward
follow
integer
idOrUrl
stringRequired
limit
integer
name
string
since
integer
slug
string
statusCode
string
teamId
string
until
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Deployment Logs

Description

Tool to retrieve logs for a specific vercel deployment. use when monitoring deployment execution, debugging issues, or analyzing deployment performance. example: "get logs for deployment dpl xxx since 1540095775941."

Action Parameters

builds
integer
direction
stringDefaults to forward
follow
integer
idOrUrl
stringRequired
limit
integerDefaults to 100
since
integer
slug
string
statusCode
string
teamId
string
until
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Domain Transfer Info

Description

Tool to get information required to transfer a domain to vercel. use when you need to check transfer availability or current status before initiating a transfer.

Action Parameters

domain
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Edge Config

Description

Tool to retrieve details of a specific edge config. use when you need to inspect edge config metadata by id before updating or deleting.

Action Parameters

edgeConfigId
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Edge Config Item

Description

Tool to retrieve a specific item within an edge config. use after obtaining the edge config id and when you need to inspect or validate a particular configuration item by its key.

Action Parameters

edgeConfigId
stringRequired
edgeConfigItemKey
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Vercel Project

Description

Tool to retrieve information about a vercel project by id or name. use when you need project metadata after obtaining its identifier.

Action Parameters

projectIdOrName
stringRequired
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Vercel Aliases

Description

Tool to list all aliases for the authenticated user or team. use when you need to retrieve aliases filtered by various criteria.

Action Parameters

domain
array
limit
integer
projectId
string
rollbackDeploymentId
string
since
integer
slug
string
teamId
string
until
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Deployments

Description

Tool to list all deployments. use after authenticating to retrieve deployments under your user or team context. example: "list deployments for project qmx...".

Action Parameters

app
string
branch
string
limit
integer
projectId
string
rollbackCandidate
boolean
sha
string
since
integer
slug
string
state
string
target
string
teamId
string
until
integer
users
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Auth Tokens

Description

Tool to list authentication tokens. use when you need to retrieve all tokens for the current user or an optional team.

Action Parameters

teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Deployment Checks

Description

Tool to retrieve a list of checks for a specific deployment. use after a deployment to inspect check statuses and results.

Action Parameters

deploymentId
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Edge Configs

Description

Tool to list all edge configs. use when you need to enumerate all edge config definitions for your account or team.

Action Parameters

slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Environment Variables

Description

Tool to list environment variables for a specific project. use when you need to inspect or page through the environment settings before deployment.

Action Parameters

decrypt
boolean
gitBranch
string
limit
integerDefaults to 20
projectId
stringRequired
until
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Edge Config Items

Description

Tool to update items within a specific edge config. use when you need to batch modify, add, or remove key-value pairs in an existing edge config.

Action Parameters

dryRun
boolean
edgeConfigId
stringRequired
items
arrayRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Vercel Project

Description

Tool to update an existing project. use when you need to modify a vercel project’s configuration before deployment. use after confirming the project id or name.

Action Parameters

autoAssignCustomDomainsUpdatedBy
string
autoExposeSystemEnvs
boolean
commandForIgnoringBuildStep
string
customerSupportCodeVisibility
boolean
enableAffectedProjectsDeployments
boolean
gitForkProtection
boolean
idOrName
stringRequired
oidcTokenConfig
object
outputDirectory
string
passwordProtection
object
publicSource
boolean
rootDirectory
string
serverlessFunctionRegion
string
slug
string
sourceFilesOutsideRootDirectory
boolean
ssoProtection
object
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Edge Config Token

Description

Tool to create a new token for a specific edge config. use when you need a read-only access token after provisioning your edge config.

Action Parameters

edgeConfigId
stringRequired
label
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Edge Config Tokens

Description

Tool to delete tokens associated with a specific edge config. use when you need to revoke one or more access tokens from an existing edge config by its id.

Action Parameters

edgeConfigId
stringRequired
slug
string
teamId
string
tokens
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Auth Token Metadata

Description

Tool to retrieve metadata for an authentication token. use when you need to inspect details of a specific token for auditing or debugging.

Action Parameters

tokenId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Edge Config Token

Description

Tool to retrieve details of a specific token associated with an edge config. use when you need metadata for an existing edge config token.

Action Parameters

edgeConfigId
stringRequired
slug
string
teamId
string
token
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Edge Config Items

Description

Tool to retrieve a list of items within a specific edge config. use when you need to inspect or manage all key–value items after creating an edge config.

Action Parameters

edgeConfigId
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Edge Config Tokens

Description

Tool to retrieve a list of tokens for a specific edge config. use after obtaining an edge config's id to list its tokens.

Action Parameters

edgeConfigId
stringRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List All Teams

Description

Tool to list all teams accessible to the authenticated user. use after authentication to retrieve their ids and slugs.

Action Parameters

limit
integer
since
integer
until
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Edge Config

Description

Tool to update an existing edge config. use when you need to rename the slug of an edge config for reorganization or migration purposes. only the slug field may be updated; ensure you confirm the new slug before using.

Action Parameters

edgeConfigId
stringRequired
requestBody
objectRequired
slug
string
teamId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired