### View Integration Setup Guides and Code Snippets

Source: https://vercel.com/docs/cli/integration

Displays getting started guides and code snippets for a specific marketplace integration. Supports targeting specific products in multi-product integrations and selecting framework guides without interactive prompts.

```bash
vercel integration guide <integration-name>
vercel integration guide <integration>/<product>
```

```bash
# View guides for an integration
vercel integration guide neon

# View guides for a specific product
vercel integration guide aws/aws-dynamodb

# View the Next.js guide without prompts
vercel integration guide neon --framework nextjs
```

--------------------------------

### Run OpenClaw (Clawdbot) Onboarding Wizard

Source: https://vercel.com/docs/ai-gateway/chat-platforms/openclaw

Starts the interactive setup wizard for OpenClaw (Clawdbot) configuration. The --install-daemon flag enables daemon installation for background service operation. Guides users through model selection, authentication, and communication channel setup.

```bash
clawdbot onboard --install-daemon
```

--------------------------------

### Install Neon Integration Example

Source: https://vercel.com/docs/cli/install

A practical example of using the vercel install command to install the Neon marketplace integration and provision its associated resources.

```bash
# Install an integration and provision a resource
vercel install neon
```

--------------------------------

### vercel integration guide

Source: https://vercel.com/docs/cli/integration

This command shows getting started guides and code snippets for using a marketplace integration in your project. It supports targeting specific products within multi-product integrations and selecting framework-specific guides.

```APIDOC
## CLI Command vercel integration guide

### Description
This command shows getting started guides and code snippets for using a marketplace integration in your project.

### Method
CLI Command

### Endpoint
vercel integration guide <integration-name>
vercel integration guide <integration>/<product>

### Parameters
#### Path Parameters
- **integration-name** (string) - Required - The name of the integration.
- **integration>/<product** (string) - Required - Target a specific product from a multi-product integration.

#### Query Parameters
- **--framework, -f** (string) - Optional - Select a framework guide without prompts (e.g., `nextjs`, `remix`, `astro`, `nuxtjs`, `sveltekit`).

### Request Example
```bash
# View guides for an integration
vercel integration guide neon

# View guides for a specific product
vercel integration guide aws/aws-dynamodb

# View the Next.js guide without prompts
vercel integration guide neon --framework nextjs
```

### Response
#### Success Response (200)
Displays getting started guides and code snippets for the specified integration or product.
```

--------------------------------

### GET / (Marketplace Installation)

Source: https://vercel.com/docs/integrations/create-integration/submit-integration

Handles the redirection and query parameters when an integration is installed directly from the Vercel Marketplace.

```APIDOC
## GET / (Marketplace Redirect)

### Description
This endpoint receives the installation details when a user initiates an installation from the Vercel Marketplace.

### Method
GET

### Endpoint
[Your Redirect URL]

### Parameters
#### Query Parameters
- **code** (string) - Required - The authorization code received from Vercel.
- **teamId** (string) - Optional - The ID of the team if a team scope was selected.
- **configurationId** (string) - Required - The ID of the specific configuration created.
- **next** (string) - Required - Encoded URL to redirect the user to once your internal setup is complete.
- **source** (string) - Required - Set to `marketplace` for this flow.

### Request Example
GET /callback?code=jMIukZ1DBCKXHje3X14BCkU0&teamId=team_LLHUOMOoDlqOp8wPE4kFo9pE&configurationId=icfg_6uKSUQ359QCbPfECTAY9murE&source=marketplace

### Response
#### Success Response (200)
- **status** (string) - Success confirmation

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### GET / (Deploy Button Installation)

Source: https://vercel.com/docs/integrations/create-integration/submit-integration

Handles the installation flow triggered by a Vercel Deploy Button, including project-specific identifiers.

```APIDOC
## GET / (Deploy Button Redirect)

### Description
Receives parameters when a user installs an integration as part of a project deployment via the Deploy Button.

### Method
GET

### Endpoint
[Your Redirect URL]

### Parameters
#### Query Parameters
- **code** (string) - Required - The authorization code.
- **teamId** (string) - Optional - The ID of the team.
- **configurationId** (string) - Required - The ID of the configuration.
- **next** (string) - Required - Encoded URL to redirect to after setup.
- **currentProjectId** (string) - Optional - The ID of the newly created project.
- **external-id** (string) - Optional - Custom reference ID provided in the deploy button.
- **source** (string) - Required - Set to `deploy-button` for this flow.

### Request Example
GET /callback?code=jMIukZ1DBCKXHje3X14BCkU0&currentProjectId=QmXGTs7mvAMMC7WW5ebrM33qKG32QK3h4vmQMjmY&source=deploy-button

### Response
#### Success Response (200)
- **message** (string) - Installation processed successfully.
```

--------------------------------

### GET /integrations/:slug/new

Source: https://vercel.com/docs/integrations/create-integration/submit-integration

Initiates the installation process from an external application using the integration's unique slug.

```APIDOC
## GET /integrations/:slug/new

### Description
Starting point for initiating a Vercel integration installation from your own application.

### Method
GET

### Endpoint
https://vercel.com/integrations/:slug/new

### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique name/slug of your integration.

#### Query Parameters
- **code** (string) - Required - The code received during the flow.
- **teamId** (string) - Optional - The ID of the team selected.
- **configurationId** (string) - Required - The ID of the configuration.
- **next** (string) - Required - Encoded URL for post-installation redirection.
- **state** (string) - Optional - Random string used to protect against CSRF attacks.
- **source** (string) - Required - Set to `external` for this flow.

### Request Example
GET https://vercel.com/integrations/my-app/new?state=xyzABC123

### Response
#### Success Response (302)
- **Location** (string) - Redirects to the Vercel installation UI.
```

--------------------------------

### Install Integration via Vercel CLI

Source: https://vercel.com/docs/integrations/install-an-integration/product-integration

Install a native integration and provision resources directly from the command line using the vercel integration add command. This example demonstrates installing a Neon integration with interactive mode, which prompts for configuration details.

```bash
vercel integration add neon
```

--------------------------------

### Build, Archive, and Deploy Prebuilt Project

Source: https://vercel.com/docs/cli/deploy

This example demonstrates a two-step process: first building the Vercel project locally using `vercel build`, then deploying the pre-built output. The `--archive=tgz` option is used to compress the build output, which can help minimize upload size and avoid limits.

```bash
# Build the project locally
vercel build

# Deploy the pre-built project, archiving it as a .tgz file
vercel deploy --prebuilt --archive=tgz
```

--------------------------------

### Getting Started with Vercel Registrar API

Source: https://vercel.com/docs/domains/registrar-api

This section provides an overview of how to get started with the Vercel domains registrar API, including token creation and examples using the Vercel SDK and cURL.

```APIDOC
## Getting Started with Vercel Registrar API

To begin using the domains registrar API, you need to create an access token and then use it either with the Vercel SDK or by making direct API calls.

### Vercel SDK Example

This example demonstrates how to use the Vercel SDK to get supported TLDs.

```ts
import { Vercel } from '@vercel/sdk';

const vercel = new Vercel({
  bearerToken: '<YOUR_BEARER_TOKEN_HERE>',
});

const result = await vercel.domainsRegistrar.getSupportedTlds();
```

### cURL Example

This example shows how to fetch supported TLDs using cURL.

```bash
curl --request GET \
  --url https://api.vercel.com/v1/registrar/tlds/supported \
  --header 'Authorization: Bearer <token>'
```
```

--------------------------------

### Set up local development environment

Source: https://vercel.com/docs/frameworks/backend/fastapi

Commands to initialize a Python virtual environment, install necessary dependencies from requirements.txt, and start the Vercel local development server.

```bash
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
vercel dev
```

--------------------------------

### GET /v1/installations/{installationId}/resource-transfer-requests/{providerClaimId}/verify

Source: https://vercel.com/docs/integrations/create-integration/marketplace-api/reference/partner/verify-resource-transfer

Validates a resource transfer request by providing a potential target installation and requesting necessary prerequisite information for resource setup. Multiple sources/teams may verify the same transfer, but only incomplete transfers can be verified. The installation ID in the URL must be the target installation ID, not the source.

```APIDOC
## GET /v1/installations/{installationId}/resource-transfer-requests/{providerClaimId}/verify

### Description
Validate a resource transfer request and provide prerequisite information for the target installation. This endpoint is used by Vercel to verify transfers and request any necessary setup information to support resources in the target team.

### Method
GET

### Endpoint
```
/v1/installations/{installationId}/resource-transfer-requests/{providerClaimId}/verify
```

### Path Parameters
- **installationId** (string) - Required - The target installation ID (not the source installation ID)
- **providerClaimId** (string) - Required - The provider claim ID for the resource transfer request

### Header Parameters
- **X-Vercel-Auth** (string) - Optional - The auth style used in the request (system, user, etc)

### Authentication
**System Authentication (OIDC)**

This endpoint uses OpenID Connect Protocol (OIDC) for authentication. Vercel sends a JSON Web Token (JWT) signed with Vercel's private key and verifiable using Vercel's public JSON Web Key Sets (JWKS) available at `https://marketplace.vercel.com/.well-known/jwks`.

#### JWT Token Claims Schema
```json
{
  "iss": "https://marketplace.vercel.com",
  "sub": "account:[0-9a-fA-F]+",
  "aud": "oac_9f4YG9JFjgKkRlxoaaGG0y05",
  "type": "access_token|id_token",
  "installation_id": "icfg_9bceb8ccT32d3U417ezb5c8p",
  "account_id": "string"
}
```

### Important Notes
- The installation ID in the URL must be the **target installation ID**, not the source one
- Only transfers that have not been completed can be verified
- Multiple sources/teams may verify the same transfer

### Response
The endpoint returns verification status and any prerequisite information required for resource setup in the target team.

### Error Handling
- Transfers that have already been completed cannot be verified
- Invalid installation IDs or provider claim IDs will result in appropriate error responses
```

--------------------------------

### Examples for connecting to a Vercel Sandbox

Source: https://vercel.com/docs/vercel-sandbox/cli-reference

These examples demonstrate practical applications of the `sandbox connect` command. They show how to connect to a sandbox using its ID, specify a working directory for the session, and configure environment variables along with elevated privileges.

```bash
# Connect to an existing sandbox
sandbox connect sb_1234567890

# Connect with a specific working directory
sandbox connect --workdir /app sb_1234567890

# Connect with environment variables and sudo
sandbox connect --env DEBUG=true --sudo sb_1234567890
```

--------------------------------

### Install Nitro with Package Managers

Source: https://vercel.com/docs/frameworks/full-stack/tanstack-start

Install the Nitro package in your TanStack Start project using your preferred package manager. Nitro enables deployment to Vercel and integrates with Vercel's features. Choose from pnpm, yarn, npm, or bun based on your project setup.

```bash
pnpm i nitro
```

```bash
yarn i nitro
```

```bash
npm i nitro
```

```bash
bun i nitro
```

--------------------------------

### Prerender Configuration Example

Source: https://vercel.com/docs/build-output-api/primitives

Demonstrates a practical example of a prerender configuration file showing how to configure caching, fallback files, and query parameter handling for a Prerender Function.

```APIDOC
## Prerender Configuration Example

### Description
Shows a real-world example of an `example.prerender-config.json` configuration file with common settings for managing cached prerender assets.

### Example Configuration File
```json
{
  "expiration": 60,
  "group": 1,
  "bypassToken": "03326da8bea31b919fa3a31c85747ddc",
  "fallback": "example.prerender-fallback.html",
  "allowQuery": ["id"]
}
```

### Configuration Explanation

- **expiration**: 60 - The cached asset will be re-generated every 60 seconds
- **group**: 1 - This asset belongs to group 1 and will be re-validated together with other group 1 assets
- **bypassToken**: "03326da8bea31b919fa3a31c85747ddc" - Token used for Draft Mode to bypass CDN cache
- **fallback**: "example.prerender-fallback.html" - Static fallback file served while runtime cache is being generated
- **allowQuery**: ["id"] - Only the "id" query parameter will be cached independently; other query parameters are ignored for caching

### Fallback File Behavior

When a fallback file is configured:
1. The fallback file is served by Vercel while there is not yet a cached version generated during runtime
2. The Vercel Function is invoked "out-of-band" to re-generate a new version of the asset
3. The newly generated asset is cached and served for future HTTP requests
```

--------------------------------

### Example JSON Response for Domain Configuration

Source: https://vercel.com/docs/rest-api/sdk/domains/get-a-domain-s-configuration

This JSON snippet provides an example of the data returned by the 'Get a Domain's configuration' API endpoint. It details various aspects of the domain's setup, including its configuration status (configuredBy), challenge types, recommended DNS records (IPv4 and CNAME), and a flag indicating if it's misconfigured.

```json
{
  "configuredBy": "A",
  "acceptedChallenges": [],
  "recommendedIPv4": [
    {
      "rank": "123",
      "value": []
    }
  ],
  "recommendedCNAME": [
    {
      "rank": "123",
      "value": "string"
    }
  ],
  "misconfigured": "false"
}
```

--------------------------------

### Initialize Vercel SDK and Get Deployment Events

Source: https://vercel.com/docs/rest-api/sdk/deployments/get-deployment-events

Demonstrates how to initialize the Vercel SDK with authentication and retrieve deployment events with various filtering options. The example shows how to query events for a specific deployment using parameters like direction, time range, status code filtering, and pagination limits.

```TypeScript
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.deployments.getDeploymentEvents({
    idOrUrl: "dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd",
    direction: "backward",
    follow: 1,
    limit: 100,
    name: "bld_cotnkcr76",
    since: 1540095775941,
    until: 1540106318643,
    statusCode: "5xx",
    delimiter: 1,
    builds: 1,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
```

--------------------------------

### Get Installation HTTP Request

Source: https://vercel.com/docs/integrations/create-integration/marketplace-api/reference/partner/get-installation

HTTP GET request to retrieve installation details from the Vercel Marketplace API. Requires the installationId path parameter and uses OIDC authentication with JWT tokens.

```http
GET /v1/installations/{installationId}
Host: api.vercel.com
X-Vercel-Auth: system
```

--------------------------------

### Initialize LangChain project directory

Source: https://vercel.com/docs/ai-gateway/ecosystem/framework-integrations/langchain

Create a new project directory and initialize it using pnpm.

```bash
mkdir langchain-ai-gateway
cd langchain-ai-gateway
pnpm dlx init -y
```

--------------------------------

### Initialize Hono Project with Vercel CLI

Source: https://vercel.com/docs/frameworks/backend/hono

Start a new Hono project by using the Vercel CLI's 'init' command. This command clones the official Hono example repository into a new directory, providing a ready-to-use Hono application structure.

```bash
vc init hono
```

--------------------------------

### Initialize xmcp project via Vercel CLI

Source: https://vercel.com/docs/frameworks/backend/xmcp

Scaffold a new xmcp project by cloning the official example repository using the Vercel CLI init command.

```bash
vc init xmcp
```

--------------------------------

### GET /v1/installations/{installationId}

Source: https://vercel.com/docs/integrations/create-integration/marketplace-api/reference/partner

This endpoint retrieves the details of a specific installation. It requires the unique identifier of the installation to fetch its information.

```APIDOC
## GET /v1/installations/{installationId}

### Description
This endpoint retrieves the details of a specific installation. It requires the unique identifier of the installation to fetch its information.

### Method
GET

### Endpoint
/v1/installations/{installationId}

### Parameters
#### Path Parameters
- **installationId** (string) - Required - The unique identifier of the installation.

### Request Example
{}

### Response
#### Success Response (200)

#### Response Example
{}
```

--------------------------------

### Initialize Node.js project for AI Video

Source: https://vercel.com/docs/ai-gateway/getting-started/video

Commands to create a new directory and initialize a Node.js project using pnpm.

```bash
mkdir ai-video-demo
cd ai-video-demo
pnpm init
```

--------------------------------

### Create Koa Server with Router

Source: https://vercel.com/docs/frameworks/backend/koa

Initialize a Koa application with basic routing setup. This example creates a simple HTTP server that listens on port 3000 and responds to GET requests at the root path. The code demonstrates importing Koa and the Router middleware, setting up a route handler, and applying middleware to the application.

```TypeScript
import Koa from 'koa';
import { Router } from '@koa/router';

const app = new Koa();
const router = new Router();

router.get('/', (ctx) => {
  ctx.body = { message: 'Hello from Koa!' };
});

app.use(router.routes());
app.use(router.allowedMethods());

app.listen(3000);
```

--------------------------------

### Provisioning Resources with Vercel Integration Add Command

Source: https://vercel.com/docs/cli/integration

Demonstrates various ways to use the `vercel integration add` command to provision resources. Examples cover interactive provisioning, targeting specific products, custom naming, adding metadata, specifying billing plans, connecting to specific environments, and controlling post-provisioning behaviors like connection and environment variable pulling, as well as using environment variable prefixes.

```bash
# Provision a resource interactively
vercel integration add neon

# Target a specific product from a multi-product integration
vercel integration add acme/acme-redis

# Provision with a custom resource name
vercel integration add neon --name my-database

# Provision with metadata options
vercel integration add neon --metadata region=us-east-1
vercel integration add neon -m region=us-east-1 -m version=16

# Provision with a specific billing plan
vercel integration add neon --plan pro

# Connect to specific environments only
vercel integration add neon --environment production
vercel integration add neon -e production -e preview

# Provision without connecting to the current project
vercel integration add neon --no-connect

# Provision without pulling environment variables
vercel integration add neon --no-env-pull

# Use a prefix for environment variable names
vercel integration add neon --prefix NEON2_

# Show available products and metadata keys
vercel integration add neon --help
```

--------------------------------

### Install OpenClaw (Clawdbot) - macOS/Linux Quick Install

Source: https://vercel.com/docs/ai-gateway/chat-platforms/openclaw

One-line installation script for OpenClaw (Clawdbot) on macOS and Linux systems. Downloads and executes the official installation script from clawd.bot. Provides the fastest setup method for Unix-like operating systems.

```bash
curl -fsSL https://clawd.bot/install.sh | bash
```

--------------------------------

### Complete Vercel config.json Example

Source: https://vercel.com/docs/build-output-api/configuration

A complete example of a Vercel configuration file demonstrating routes, image optimization, wildcards, overrides, and cron jobs.

```json
{
  "version": 3,
  "routes": [
    {
      "src": "/redirect",
      "status": 308,
      "headers": { "Location": "https://example.com/" }
    },
    {
      "src": "/blog",
      "dest": "/blog.$wildcard.html"
    }
  ],
  "images": {
    "sizes": [640, 750, 828, 1080, 1200],
    "domains": [],
    "minimumCacheTTL": 60,
    "formats": ["image/avif", "image/webp"],
    "qualities": [25, 50, 75],
    "localPatterns": [{
      "pathname": "^/assets/.*$",
      "search": ""
    }],
    "remotePatterns": [
      {
        "protocol": "https",
        "hostname": "^via\\.placeholder\\.com$",
        "port": "",
        "pathname": "^/1280x640/.*$",
        "search": "?v=1"
      }
    ]
  },
  "wildcard": [
    {
      "domain": "example.com",
      "value": "en-US"
    },
    {
      "domain": "example.nl",
      "value": "nl-NL"
    },
    {
      "domain": "example.fr",
      "value": "fr"
    }
  ],
  "overrides": {
    "blog.html": {
      "path": "blog"
    }
  },
  "cache": [".cache/**", "node_modules/**"],
  "framework": {
    "version": "1.2.3"
  },
  "crons": [
    {
      "path": "/api/cron",
      "schedule": "* * * * *"
    }
  ]
}
```

--------------------------------

### Install OpenClaw (Clawdbot) - Windows PowerShell Quick Install

Source: https://vercel.com/docs/ai-gateway/chat-platforms/openclaw

One-line installation script for OpenClaw (Clawdbot) on Windows using PowerShell. Downloads and executes the official Windows installation script from clawd.bot. Provides the fastest setup method for Windows systems.

```powershell
iwr -useb https://clawd.bot/install.ps1 | iex
```

--------------------------------

### GET /v1/installations/{installationId}

Source: https://vercel.com/docs/integrations/create-integration/marketplace-api/reference/partner/get-installation

Retrieves the details of a specific integration installation. This is primarily used by marketplace partners to verify installation status and associated account metadata.

```APIDOC
## GET /v1/installations/{installationId}

### Description
Retrieves details for a specific Vercel integration installation using its unique identifier. This endpoint requires OIDC-based system authentication.

### Method
GET

### Endpoint
/v1/installations/{installationId}

### Parameters
#### Path Parameters
- **installationId** (string) - Required - The ID of the installation (e.g., icfg_9bceb8ccT32d3U417ezb5c8p).

#### Header Parameters
- **X-Vercel-Auth** (string) - Optional - The auth style used in the request (e.g., system, user).
- **Authorization** (string) - Required - Bearer token (JWT) signed with Vercel's private key.

### Request Example
GET /v1/installations/icfg_9bceb8ccT32d3U417ezb5c8p HTTP/1.1
Host: marketplace.vercel.com
X-Vercel-Auth: system
Authorization: Bearer <JWT_TOKEN>

### Response
#### Success Response (200)
- **id** (string) - The installation ID.
- **accountId** (string) - The ID of the account or team associated with the installation.
- **integrationId** (string) - The ID of the integration.

#### Response Example
{
  "id": "icfg_9bceb8ccT32d3U417ezb5c8p",
  "accountId": "team_9f4YG9JFjgKkRlxoaaGG0y05",
  "integrationId": "oac_9f4YG9JFjgKkRlxoaaGG0y05",
  "createdAt": 1672531200000
}
```

--------------------------------

### List Vercel deployments skipping setup questions (Bash)

Source: https://vercel.com/docs/cli/list

Use the `--yes` option to automatically answer setup questions with default values when listing deployments. This is useful for scripting or automated environments.

```bash
vercel list --yes
```

--------------------------------

### GET /v1/installations/{installationId}

Source: https://vercel.com/docs/integrations/create-integration/marketplace-api

Retrieve installation details including the current notification. Use this endpoint to fetch the complete installation object and check the current notification status.

```APIDOC
## GET /v1/installations/{installationId}

### Description
Retrieve the installation details including the current notification field. This endpoint allows you to check the current notification status and other installation information.

### Method
GET

### Endpoint
`https://api.vercel.com/v1/installations/{installationId}`

### Parameters
#### Path Parameters
- **installationId** (string) - Required - The unique identifier of the installation (e.g., icfg_abc123)

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication

### Request Example
```
GET https://api.vercel.com/v1/installations/icfg_abc123
Authorization: Bearer {token}
```

### Response
#### Success Response (200)
- **id** (string) - The installation ID
- **notification** (object or null) - The current notification object if set, or null if no notification exists
  - **title** (string) - The notification title
  - **message** (string) - The notification message
  - **href** (string) - The notification link URL
  - **type** (string) - The notification type (info, warning, or error)

#### Response Example
```json
{
  "id": "icfg_abc123",
  "notification": {
    "title": "Review your usage",
    "message": "Your monthly usage report is ready",
    "href": "sso:https://your-integration.com/dashboard/usage",
    "type": "info"
  }
}
```
```

--------------------------------

### POST /installations

Source: https://vercel.com/docs/integrations/create-integration/marketplace-api/reference/partner/upsert-installation

Creates a new installation for a partner integration. This endpoint handles the setup of billing plans and provides notification details upon successful creation.

```APIDOC
## POST /installations

### Description
Creates a new installation for a partner integration. This process associates a billing plan with the installation and returns configuration details.

### Method
POST

### Endpoint
/installations

### Parameters
#### Request Body
- **installationData** (object) - Required - The data required to initialize the installation.

### Request Example
{
  "integrationId": "string",
  "configurationId": "string"
}

### Response
#### Success Response (200)
- **billingPlan** (object) - Required - Partner-provided billing plan details including ID, type, and cost.
- **notification** (object) - Required - Notification details containing level, title, and message.

#### Response Example
{
  "billingPlan": {
    "id": "pro200",
    "type": "subscription",
    "name": "Hobby",
    "description": "Use all you want up to 20G",
    "paymentMethodRequired": true,
    "cost": "$20.00/month"
  },
  "notification": {
    "level": "info",
    "title": "Installation Successful",
    "message": "Your installation is now active."
  }
}

#### Success Response (204)
- **Description**: The installation was created successfully with no content returned.

### Error Handling
#### 400 Bad Request
- **error** (object) - Input has failed validation. Contains error code, system message, and user-facing messages.

#### 403 Forbidden
- **error** (object) - Operation failed because the authentication is not allowed to perform this operation.

#### 409 Conflict
- **error** (object) - Operation failed because of a conflict with the current state of the resource.
```

--------------------------------

### Initialize LibreChat Repository

Source: https://vercel.com/docs/ai-gateway/chat-platforms/librechat

Clone the LibreChat repository and create the initial environment file from the example template.

```bash
git clone https://github.com/danny-avila/LibreChat.git
cd LibreChat
cp .env.example .env
```

--------------------------------

### Install @vercel/toolbar Package with Package Managers

Source: https://vercel.com/docs/vercel-toolbar/in-production-and-localhost/add-to-localhost

Install the @vercel/toolbar package using pnpm, yarn, npm, or bun. Choose the package manager appropriate for your project setup. After installation, link your local project to Vercel using the vercel link command.

```bash
pnpm i @vercel/toolbar
```

```bash
yarn i @vercel/toolbar
```

```bash
npm i @vercel/toolbar
```

```bash
bun i @vercel/toolbar
```

```bash
vercel link [path-to-directory]
```

--------------------------------

### Slack Integration Setup and Configuration

Source: https://vercel.com/docs/comments/integrations

Initial setup and reconfiguration instructions for the Vercel Slack integration. Includes steps for updating existing integrations and connecting projects to Slack channels.

```APIDOC
## Slack Integration Setup

### Description
Setup and configuration process for the Vercel Slack integration. Apps configured before October 4th, 2023 require reconfiguration to access new features.

### Initial Configuration Steps

#### Step 1: Access Integrations Dashboard
1. Visit your team's [dashboard](/dashboard)
2. Open **Integrations** in the sidebar
3. Locate Slack in your list of integrations

#### Step 2: Configure the App
1. Select **Manage** next to Slack
2. On the next page, select **Configure**
3. Configure your Slack app and re-authorize it

#### Step 3: Verify Setup
- Test with `/vercel help` command in a Slack channel
- Verify authentication with `/vercel whoami`

### Reconfiguration for Legacy Apps

#### Required For
- Apps configured before October 4th, 2023
- Apps needing new permissions

#### New Permissions Required
- Subscribe to new comment threads
- Link new channels

#### Reconfiguration Steps
1. Visit team dashboard → Integrations
2. Select **Manage** next to Slack
3. Select **Configure**
4. Re-authorize the Slack app with new permissions

#### Important Notes
- Previous linked channels continue to work
- Existing subscriptions remain active
- No data loss during reconfiguration
- Reconfiguration is optional but recommended for new features

### Connecting Projects to Channels

#### Method 1: Interactive UI
1. In target Slack channel, type: `/vercel subscribe`
2. Modal opens with configuration options
3. Select project, branches, and pages
4. Confirm subscription

#### Method 2: Direct Command
1. In target Slack channel, type: `/vercel subscribe team/project`
2. Channel immediately subscribes to project
3. Notifications begin appearing

#### Subscription Management
- View subscriptions: `/vercel subscribe list`
- Remove subscription: `/vercel unsubscribe team/project`
- Modify filters: `/vercel subscribe` (UI method)
```

--------------------------------

### Initialize Mastra Project

Source: https://vercel.com/docs/ai-gateway/ecosystem/framework-integrations/mastra

Create a new Mastra project using the CLI to set up the project structure and default provider settings.

```bash
pnpm dlx create-mastra@latest
```

--------------------------------

### Join Team - SDK Example

Source: https://vercel.com/docs/rest-api/sdk/teams/join-a-team

JavaScript/TypeScript example demonstrating how to use the Vercel SDK to join a team. Shows the complete setup with bearer token authentication and the joinTeam method call.

```APIDOC
## SDK Implementation Example

### Description
Complete example using the Vercel SDK to join a team with authentication and error handling.

### Code
```javascript
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.teams.joinTeam({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    requestBody: {
      inviteCode: "fisdh38aejkeivn34nslfore9vjtn4ls",
    },
  });

  console.log(result);
}

run();
```

### Parameters
- **teamId**: The unique identifier of the team to join
- **inviteCode**: Optional invite code for team access

### Returns
Promise resolving to team object with teamId, slug, name, and from properties
```

--------------------------------

### GET /v1/integrations/configurations

Source: https://vercel.com/docs/rest-api/integrations/retrieve-an-integration-configuration

Retrieve information about a single installation of an integration within an individual or team account.

```APIDOC
## GET /v1/integrations/configurations

### Description
A configuration represents information about a single installation of an integration within an individual or team account. This endpoint returns the configuration details including status, source, and permissions.

### Method
GET

### Endpoint
/v1/integrations/configurations

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **teamId** (string) - Optional - The ID of the team to filter configurations for.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the configuration.
- **integrationId** (string) - The unique identifier of the app the configuration was created for.
- **ownerId** (string) - The user or team ID that owns the configuration.
- **status** (string) - The configuration status (error, ready, pending, onboarding, suspended, resumed, uninstalled).
- **source** (string) - Source defines where the configuration was installed from (marketplace, deploy-button, external, v0, resource-claims, cli, oauth, backoffice).
- **installationType** (string) - Defines the installation type (marketplace, external).
- **disabledReason** (string) - Reason why the configuration was disabled (e.g., disabled-by-owner, account-plan-downgrade).
- **projects** (array) - List of project IDs the configuration is allowed to access.
- **scopes** (array) - The resources that are allowed to be accessed by the configuration.
- **createdAt** (number) - Timestamp when the configuration was created.
- **updatedAt** (number) - Timestamp when the configuration was updated.
- **completedAt** (number) - Timestamp when the configuration was installed successfully.
- **disabledAt** (number) - Timestamp when the configuration was disabled.
- **deletedAt** (number) - Timestamp when the configuration was deleted.
- **deleteRequestedAt** (number) - Timestamp when the configuration deletion was started.

### Response Example
{
  "id": "icfg_xxxxxxxxxxxx",
  "integrationId": "oac_xxxxxxxxxxxx",
  "ownerId": "team_xxxxxxxxxxxx",
  "status": "ready",
  "source": "marketplace",
  "installationType": "marketplace",
  "projects": ["prj_123", "prj_456"],
  "createdAt": 1625097600000,
  "updatedAt": 1625097600000
}
```

--------------------------------

### Complete domain setup workflow

Source: https://vercel.com/docs/domains/set-up-custom-domain

Full command sequence for setting up a custom domain on Vercel, from listing existing domains through DNS configuration, verification, SSL provisioning, and testing. Includes both apex domain and subdomain examples.

```bash
# 1. Check your existing domains
vercel domains ls

# 2. Add the domain to your project
vercel domains add example.com my-project

# 3. Check what DNS records are needed
vercel domains inspect example.com

# 4. Configure DNS records (apex domain)
vercel dns add example.com '@' A 76.76.21.21

# 4b. OR configure DNS records (subdomain)
vercel dns add example.com www CNAME cname.vercel-dns-0.com

# 5. Verify DNS configuration
vercel domains inspect example.com

# 6. Verify SSL certificate was provisioned
vercel certs ls

# 7. Test the domain
vercel httpstat /
vercel curl /
```

--------------------------------

### GET /v1/installations/{integrationConfigurationId}/resources

Source: https://vercel.com/docs/integrations/create-integration/marketplace-api/reference/vercel

Retrieves all integration resources for a given Vercel Marketplace installation.

```APIDOC
## GET /v1/installations/{integrationConfigurationId}/resources

### Description
Get Integration Resources

### Method
GET

### Endpoint
/v1/installations/{integrationConfigurationId}/resources

### Parameters
#### Path Parameters
- **integrationConfigurationId** (string) - Required - The ID of the integration configuration.

#### Query Parameters

#### Request Body

### Request Example
{}

### Response
#### Success Response (200)

#### Response Example
{}
```

--------------------------------

### Initialize FastAPI project with Vercel CLI

Source: https://vercel.com/docs/frameworks/backend/fastapi

Quickly bootstrap a new FastAPI project using the Vercel CLI init command. This clones the official Vercel FastAPI example repository into a local directory.

```bash
vc init fastapi
```