> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/vercel.md).

# Vercel

Manage Vercel projects, deployments, environment variables, domains, and aliases: list and inspect, create/update/delete projects, trigger and cancel deployments, and configure env vars per environment.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Vercel    | Access Token   |

### Vercel

Connect to Vercel to manage projects, deployments, environment variables, domains, and aliases using a personal or team-scoped access token.

#### Set up in Vercel

1. Sign in to Vercel and open Account Settings, then the Tokens page (<https://vercel.com/account/tokens>).
2. Click Create Token, give it a name, choose its scope (personal or a specific Team), and set an expiration.
3. Copy the token immediately; Vercel shows it only once.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Vercel**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                                                                                                                                                                                                        |
| ------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Access Token  | Yes                      | A Vercel access token. Create one at <https://vercel.com/account/tokens> -> Create Token. Give it the scope you need: 'Full Account' to reach all resources, or scope it to a specific Team. For team-owned projects, also fill in Team ID below (found at <https://vercel.com/account> -> your team -> Settings -> General -> Team ID). [Provider instructions](https://vercel.com/account/tokens). |
| Team ID       | Optional / as applicable | Optional. Vercel team identifier (starts with 'team\_'). Set this to operate on a team's projects, deployments, and domains. Leave blank to operate on your personal account. Find it at <https://vercel.com/\\><team-slug>/\~/settings under 'Team ID'. [Provider instructions](https://vercel.com/account).                                                                                        |

**Provider documentation:** [Setup reference](https://vercel.com/docs/rest-api/authentication/create-an-auth-token).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Vercel** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Projects

List Vercel projects, optionally filtered by name.

#### Inputs

| Field  | Type    | Required | Description                                                                               |
| ------ | ------- | -------- | ----------------------------------------------------------------------------------------- |
| Search | string  | No       | Substring match on project name (max 100 chars).                                          |
| Limit  | integer | No       | Maximum number of projects to return (default 20). Minimum: 1. Maximum: 100. Default: 20. |

#### Outputs

| Field          | Type          | Description                                                |
| -------------- | ------------- | ---------------------------------------------------------- |
| Projects       | object\_array | Project objects as returned by Vercel.                     |
| Returned Count | number        | Number of projects in this page (not the total on Vercel). |

### Get Project

Fetch details of a Vercel project by id or name.

#### Inputs

| Field   | Type            | Required | Description                                                                     |
| ------- | --------------- | -------- | ------------------------------------------------------------------------------- |
| Project | select (string) | Yes      | Pick a project or paste its id/name. Options load from the selected connection. |

#### Outputs

| Field      | Type   | Description                           |
| ---------- | ------ | ------------------------------------- |
| Project    | object | Project object as returned by Vercel. |
| Project ID | string | Resolved project id.                  |

### Create Project

Create a new Vercel project.

#### Inputs

| Field            | Type   | Required | Description                                        |
| ---------------- | ------ | -------- | -------------------------------------------------- |
| Project Name     | string | Yes      | Project name (lowercase, max 100 characters).      |
| Framework        | string | No       | Framework preset (e.g. 'nextjs', 'vite', 'astro'). |
| Git Repository   | object | No       | Optional Git repo to link the project to.          |
| Build Command    | string | No       | Override the framework's default build command.    |
| Install Command  | string | No       | Override the install command.                      |
| Output Directory | string | No       | Override the build output directory.               |
| Root Directory   | string | No       | Directory inside the repo containing the project.  |

#### Outputs

| Field      | Type   | Description                       |
| ---------- | ------ | --------------------------------- |
| Project    | object | The newly created project object. |
| Project ID | string | ID of the new project.            |

### Update Project

Update a Vercel project's settings.

#### Inputs

| Field            | Type            | Required | Description                                                       |
| ---------------- | --------------- | -------- | ----------------------------------------------------------------- |
| Project          | select (string) | Yes      | The project to update. Options load from the selected connection. |
| New Name         | string          | No       | New project name (max 100 chars).                                 |
| Framework        | string          | No       | New framework preset.                                             |
| Build Command    | string          | No       | New build command.                                                |
| Install Command  | string          | No       | New install command.                                              |
| Dev Command      | string          | No       | New dev command.                                                  |
| Output Directory | string          | No       | Build output directory.                                           |
| Root Directory   | string          | No       | Project root directory (for monorepos).                           |
| Node Version     | string          | No       | Node.js version label (e.g. '22.x', '20.x').                      |

#### Outputs

| Field   | Type   | Description                 |
| ------- | ------ | --------------------------- |
| Project | object | The updated project object. |

### Delete Project

Delete a Vercel project (irreversible).

#### Inputs

| Field   | Type            | Required | Description                                                                      |
| ------- | --------------- | -------- | -------------------------------------------------------------------------------- |
| Project | select (string) | Yes      | The project to delete (irreversible). Options load from the selected connection. |

#### Outputs

| Field      | Type    | Description                        |
| ---------- | ------- | ---------------------------------- |
| Success    | boolean | True if the project was deleted.   |
| Project ID | string  | ID or name of the deleted project. |

### List Deployments

List Vercel deployments with optional filtering by project, target, or state.

#### Inputs

| Field              | Type            | Required | Description                                                                                                                          |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Project            | select (string) | No       | Optional. Filter deployments to a specific project. Options load from the selected connection.                                       |
| Target Environment | select (string) | No       | 'production', 'staging', or leave blank for all. Available values: Production, Staging.                                              |
| State              | select (string) | No       | BUILDING, ERROR, INITIALIZING, QUEUED, READY, or CANCELED. Available values: Building, Error, Initializing, Queued, Ready, Canceled. |
| Branch             | string          | No       | Filter by git branch name.                                                                                                           |
| Commit SHA         | string          | No       | Filter by git commit SHA.                                                                                                            |
| Limit              | integer         | No       | Maximum deployments to return (default 20). Minimum: 1. Maximum: 100. Default: 20.                                                   |

#### Outputs

| Field          | Type          | Description                                                   |
| -------------- | ------------- | ------------------------------------------------------------- |
| Deployments    | object\_array | Deployment objects as returned by Vercel.                     |
| Returned Count | number        | Number of deployments in this page (not the total on Vercel). |

### Get Deployment

Fetch details of a Vercel deployment.

#### Inputs

| Field                 | Type    | Required | Description                                                       |
| --------------------- | ------- | -------- | ----------------------------------------------------------------- |
| Deployment ID or URL  | string  | Yes      | The deployment id (dpl\_...) or hostname.                         |
| Include Git Repo Info | boolean | No       | Include linked git repo metadata in the response. Default: false. |

#### Outputs

| Field      | Type   | Description               |
| ---------- | ------ | ------------------------- |
| Deployment | object | Full deployment object.   |
| URL        | string | Deployment URL.           |
| State      | string | Current deployment state. |

### Create Deployment

Trigger a new Vercel deployment (from Git or by redeploy).

#### Inputs

| Field              | Type            | Required | Description                                                                                 |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------- |
| Project Name       | string          | Yes      | Project name used in the deployment URL.                                                    |
| Project            | select (string) | No       | Target project id (overrides name lookup). Options load from the selected connection.       |
| Target Environment | select (string) | No       | 'production', 'staging', or leave blank for preview. Available values: Production, Staging. |
| Git Source         | object          | No       | Git source for the deployment.                                                              |
| Redeploy From      | string          | No       | Redeploy an existing deployment by id.                                                      |
| Use Latest Commit  | boolean         | No       | When redeploying, force using the latest commit on the branch. Default: false.              |

#### Outputs

| Field         | Type   | Description                                         |
| ------------- | ------ | --------------------------------------------------- |
| Deployment    | object | The newly created deployment.                       |
| Deployment ID | string | ID of the new deployment.                           |
| URL           | string | Deployment URL (may not be live until state=READY). |

### Cancel Deployment

Cancel a Vercel deployment that is currently building.

#### Inputs

| Field                | Type   | Required | Description                                          |
| -------------------- | ------ | -------- | ---------------------------------------------------- |
| Deployment ID or URL | string | Yes      | Id or hostname of the building deployment to cancel. |

#### Outputs

| Field      | Type    | Description                              |
| ---------- | ------- | ---------------------------------------- |
| Deployment | object  | Deployment object after cancellation.    |
| Success    | boolean | True if the cancel request was accepted. |

### Delete Deployment

Delete a Vercel deployment.

#### Inputs

| Field                | Type   | Required | Description                                 |
| -------------------- | ------ | -------- | ------------------------------------------- |
| Deployment ID or URL | string | Yes      | Id or hostname of the deployment to delete. |

#### Outputs

| Field         | Type    | Description                         |
| ------------- | ------- | ----------------------------------- |
| Success       | boolean | True if the deployment was deleted. |
| Deployment ID | string  | ID of the deleted deployment.       |

### List Environment Variables

List environment variables of a Vercel project.

#### Inputs

| Field                 | Type            | Required | Description                                                                    |
| --------------------- | --------------- | -------- | ------------------------------------------------------------------------------ |
| Project               | select (string) | Yes      | The project whose env vars to list. Options load from the selected connection. |
| Decrypt Secret Values | boolean         | No       | Return decrypted values (token must have decrypt permission). Default: false.  |

#### Outputs

| Field                 | Type          | Description                                                     |
| --------------------- | ------------- | --------------------------------------------------------------- |
| Environment Variables | object\_array | Env var objects with id, key, type, target, and optional value. |
| Returned Count        | number        | Number of env vars returned.                                    |

### Create Environment Variable

Create an env var on a Vercel project.

#### Inputs

| Field        | Type            | Required | Description                                                                                                                                                                        |
| ------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Project      | select (string) | Yes      | The project to add the env var to. Options load from the selected connection.                                                                                                      |
| Key          | string          | Yes      | Env var name (uppercase letters, digits, underscores).                                                                                                                             |
| Value        | secret          | Yes      | Env var value.                                                                                                                                                                     |
| Environments | array           | Yes      | Environments this var applies to: any subset of production, preview, development.                                                                                                  |
| Type         | select (string) | No       | encrypted (default), plain, secret, or sensitive. Available values: Encrypted (default secret), Plain (public), Secret (legacy), Sensitive (most restrictive). Default: encrypted. |
| Git Branch   | string          | No       | Optional. Restrict var to a specific git branch.                                                                                                                                   |
| Comment      | string          | No       | Optional human-readable note.                                                                                                                                                      |

#### Outputs

| Field                | Type   | Description                                               |
| -------------------- | ------ | --------------------------------------------------------- |
| Environment Variable | object | The created env var object (flat — no wrapping envelope). |
| Env Var ID           | string | ID of the created env var.                                |

### Update Environment Variable

Update a Vercel project env var.

#### Inputs

| Field                | Type            | Required | Description                                                                                                                                                  |
| -------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Project              | select (string) | Yes      | The project that owns the env var. Options load from the selected connection.                                                                                |
| Environment Variable | select (string) | Yes      | Pick an env var or paste its id. Options load from the selected connection.                                                                                  |
| New Value            | secret          | No       | New value.                                                                                                                                                   |
| Environments         | array           | No       | New target environments.                                                                                                                                     |
| Type                 | select (string) | No       | New type (encrypted, plain, secret, sensitive). Available values: Encrypted (default secret), Plain (public), Secret (legacy), Sensitive (most restrictive). |
| Git Branch           | string          | No       | New git branch restriction.                                                                                                                                  |
| Comment              | string          | No       | New human-readable note.                                                                                                                                     |

#### Outputs

| Field                | Type   | Description                 |
| -------------------- | ------ | --------------------------- |
| Environment Variable | object | The updated env var object. |

### Delete Environment Variable

Delete a Vercel project env var.

#### Inputs

| Field                | Type            | Required | Description                                                                   |
| -------------------- | --------------- | -------- | ----------------------------------------------------------------------------- |
| Project              | select (string) | Yes      | The project that owns the env var. Options load from the selected connection. |
| Environment Variable | select (string) | Yes      | The env var to delete. Options load from the selected connection.             |

#### Outputs

| Field      | Type    | Description                |
| ---------- | ------- | -------------------------- |
| Success    | boolean | True if deleted.           |
| Env Var ID | string  | ID of the deleted env var. |

### List Domains

List domains registered to the user or team.

#### Inputs

| Field | Type    | Required | Description                                                                    |
| ----- | ------- | -------- | ------------------------------------------------------------------------------ |
| Limit | integer | No       | Maximum domains to return (default 20). Minimum: 1. Maximum: 100. Default: 20. |

#### Outputs

| Field          | Type          | Description                     |
| -------------- | ------------- | ------------------------------- |
| Domains        | object\_array | Domain objects.                 |
| Returned Count | number        | Number of domains in this page. |

### Add Project Domain

Attach a domain or subdomain to a Vercel project.

#### Inputs

| Field                | Type            | Required | Description                                                                     |
| -------------------- | --------------- | -------- | ------------------------------------------------------------------------------- |
| Project              | select (string) | Yes      | The project to attach the domain to. Options load from the selected connection. |
| Domain               | string          | Yes      | The hostname to attach.                                                         |
| Git Branch           | string          | No       | Optional branch to alias this domain to.                                        |
| Redirect To          | string          | No       | Target hostname to redirect to (instead of serving).                            |
| Redirect Status Code | integer         | No       | 301, 302, 307, or 308 (only used when redirect is set).                         |

#### Outputs

| Field  | Type   | Description                 |
| ------ | ------ | --------------------------- |
| Domain | object | The attached domain object. |

### List Aliases

List Vercel aliases with optional project or domain filtering.

#### Inputs

| Field   | Type            | Required | Description                                                                      |
| ------- | --------------- | -------- | -------------------------------------------------------------------------------- |
| Project | select (string) | No       | Filter aliases to a specific project. Options load from the selected connection. |
| Domain  | string          | No       | Filter aliases to a specific domain.                                             |
| Limit   | integer         | No       | Maximum aliases (default 20). Minimum: 1. Maximum: 100. Default: 20.             |

#### Outputs

| Field          | Type          | Description                     |
| -------------- | ------------- | ------------------------------- |
| Aliases        | object\_array | Alias objects.                  |
| Returned Count | number        | Number of aliases in this page. |

### List Teams

List Vercel teams the authenticated token can access.

#### Inputs

| Field | Type    | Required | Description                                                        |
| ----- | ------- | -------- | ------------------------------------------------------------------ |
| Limit | integer | No       | Maximum teams (default 20). Minimum: 1. Maximum: 100. Default: 20. |

#### Outputs

| Field          | Type          | Description                   |
| -------------- | ------------- | ----------------------------- |
| Teams          | object\_array | Team objects.                 |
| Returned Count | number        | Number of teams in this page. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/vercel.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
