[Integrations](https://spiral.ai/integrations) › [dots](https://spiral.ai/integrations/dots) › [Vercel REST API endpoint reference](https://spiral.ai/integrations/dots/vercel-rest-api-endpoint-reference)

# How to Use Vercel REST API endpoint reference in dots

Returns entries from Vercel's REST API endpoint index. Use it to locate documented operations for deployments, domains, projects, or environment variables before reading their reference pages.

|  |  |
| --- | --- |
| Model | Vercel REST API endpoint reference |
| Available through | Alexandria |
| Category | Developer |
| Price | $0.00873 per call. |
| Returns | json |
| Runs | In the background |
| Setup | About 2 minutes, with a Spiral API key |

## Prompts to try with Vercel REST API endpoint reference in dots

- Every Monday at 9am: use Vercel REST API endpoint reference to look this up and give me the result as a table.
- Pull the latest numbers from Vercel REST API endpoint reference and tell me what changed since last week.
- Check Vercel REST API endpoint reference and summarize what you find in three bullet points.
- Pull the newest data from Vercel REST API endpoint reference and give me the result as a table.
- Check Vercel REST API endpoint reference every morning and tell me only when something changed.

## How to set up Vercel REST API endpoint reference in dots

Pick the way that suits you. Each takes about two minutes.

### Use the Spiral skill

1. **Send dots this message**: Your agent reads Spiral's skill and sets itself up.

```
set up https://spiral.ai/SKILL.md
```

2. **Sign in or paste a key**: Approve Spiral in the browser, or give the agent a key from the console.

### Use Spiral's MCP server

1. **Create an API key**: In the console, open API keys and create a key for your dot. Copy it.

2. **Send your dot this message**: Your dot reads Spiral's skill and asks for your API key.

```text
set up https://spiral.ai/SKILL.md
```

3. **Give your dot the key**: When your dot asks for the key, add it where your dot keeps secrets, never in the chat itself.

### Use the Spiral CLI

1. **Install and sign in**: Installs the Spiral CLI, signs you in and adds its skill to your coding agents.

```bash
npx -y spiral-cli@latest init
```

### Call the Spiral API

1. **Create an API key**: In the console, under API keys.

2. **Run Vercel REST API endpoint reference**: One request; the result comes back by polling or a webhook.

```bash
curl https://api.spiral.ai/v1/runs \
  -H "Authorization: Bearer $SPIRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "provider": "alexandria",
    "model": "vercel-com/developer-documentation/list_rest_api_endpoints",
    "input": {
      "q": "<q>"
    }
  }'
```

Then paste one of the prompts above: dots finds Vercel REST API endpoint reference on Spiral, shows the price and runs it.

Setup guide in the docs: https://spiral.ai/docs/quickstarts/dots

## Vercel REST API endpoint reference tools and prices

- [Vercel · List rest api endpoints](https://spiral.ai/tools/alexandria/vercel-com/developer-documentation/list_rest_api_endpoints) (Alexandria): $0.00873 per call.

## Settings you can ask for

| Setting | Allowed values | Default | Description |
| --- | --- | --- | --- |
| q |  | — | Words, e.g. `deployment events` or `env`. |
| group |  | — | Group heading as listed in `groups`, e.g. `Deployments` (case-insensitive). |
| limit | 1 to 500 | — | Results per call, 1 to 500. Defaults to 25. |
| method |  | — | HTTP method: GET, POST, PATCH, PUT or DELETE. |
| offset | 0 to 100000 | — | Skip this many matches; pass the previous `next_offset` (also the continuation). |

## What can you do with Vercel REST API endpoint reference in dots?

Prepare a recurring Vercel research digest for the services your application depends on. A scheduled agent can revisit public references and compare returned material with earlier results to flag items for review.

### Plan a Next.js AI application

Prepare an architecture brief with documentation, engineering articles, release announcements, model candidates, a starter template, Marketplace services, plan feature boundaries, and documented automation operations.

### Research a move to Vercel

Assess a move for an AI application: compare framework guidance and starters, identify replacement integrations and models, check plan features, and locate deployment automation references.

### Build an internal Vercel reference library

Organize public guidance, announcements, model references, plan comparisons, integration listings, API references, and starters into a searchable engineering reference with source links.

### Design deployment automation

Find documented deployment and domain operations, read their references, and use guides, announcements, and plan feature information to draft an implementation checklist.

### Review a starter's production requirements

Research a starter's framework guidance, supporting integrations, plan feature requirements, and documented project operations before adopting it for a business application.

## Overview

- [Alexandria](https://spiral.ai/providers/alexandria)
- [All dots guides](https://spiral.ai/integrations/dots)

## Vercel REST API endpoint reference in other agents

- [Amp](https://spiral.ai/integrations/amp/vercel-rest-api-endpoint-reference)
- [ChatGPT](https://spiral.ai/integrations/chatgpt/vercel-rest-api-endpoint-reference)
- [Claude](https://spiral.ai/integrations/claude-desktop/vercel-rest-api-endpoint-reference)
- [Claude Code](https://spiral.ai/integrations/claude-code/vercel-rest-api-endpoint-reference)
- [Cline](https://spiral.ai/integrations/cline/vercel-rest-api-endpoint-reference)
- [Codex](https://spiral.ai/integrations/codex/vercel-rest-api-endpoint-reference)
- [Cursor](https://spiral.ai/integrations/cursor/vercel-rest-api-endpoint-reference)
- [Devin](https://spiral.ai/integrations/devin/vercel-rest-api-endpoint-reference)
- [Factory Droid](https://spiral.ai/integrations/factory-droid/vercel-rest-api-endpoint-reference)
- [Gemini](https://spiral.ai/integrations/gemini/vercel-rest-api-endpoint-reference)
- [Gemini CLI](https://spiral.ai/integrations/gemini-cli/vercel-rest-api-endpoint-reference)
- [Google Antigravity](https://spiral.ai/integrations/antigravity/vercel-rest-api-endpoint-reference)
- [goose](https://spiral.ai/integrations/goose/vercel-rest-api-endpoint-reference)
- [Grok](https://spiral.ai/integrations/grok/vercel-rest-api-endpoint-reference)
- [Grok Build](https://spiral.ai/integrations/grok-build/vercel-rest-api-endpoint-reference)
- [Hermes](https://spiral.ai/integrations/hermes/vercel-rest-api-endpoint-reference)
- [Instinct](https://spiral.ai/integrations/instinct/vercel-rest-api-endpoint-reference)
- [Manus](https://spiral.ai/integrations/manus/vercel-rest-api-endpoint-reference)
- [Muse](https://spiral.ai/integrations/muse/vercel-rest-api-endpoint-reference)
- [Muse Code](https://spiral.ai/integrations/muse-code/vercel-rest-api-endpoint-reference)
- [n8n](https://spiral.ai/integrations/n8n/vercel-rest-api-endpoint-reference)
- [Notion](https://spiral.ai/integrations/notion/vercel-rest-api-endpoint-reference)
- [OpenClaw](https://spiral.ai/integrations/openclaw/vercel-rest-api-endpoint-reference)
- [opencode](https://spiral.ai/integrations/opencode/vercel-rest-api-endpoint-reference)
- [Perplexity](https://spiral.ai/integrations/perplexity/vercel-rest-api-endpoint-reference)
- [Raycast](https://spiral.ai/integrations/raycast/vercel-rest-api-endpoint-reference)
- [VS Code](https://spiral.ai/integrations/vscode/vercel-rest-api-endpoint-reference)
- [Windsurf](https://spiral.ai/integrations/windsurf/vercel-rest-api-endpoint-reference)
- [Zapier](https://spiral.ai/integrations/zapier/vercel-rest-api-endpoint-reference)

## More dots guides

- [Vercel Marketplace integrations](https://spiral.ai/integrations/dots/vercel-marketplace-integrations)
- [Vercel blog posts](https://spiral.ai/integrations/dots/vercel-blog-posts)
- [Vercel AI Gateway model details](https://spiral.ai/integrations/dots/vercel-ai-gateway-model-details)
- [Vercel changelog entries](https://spiral.ai/integrations/dots/vercel-changelog-entries)
- [Vercel AI Gateway model catalog](https://spiral.ai/integrations/dots/vercel-ai-gateway-model-catalog)
- [Vercel documentation page](https://spiral.ai/integrations/dots/vercel-documentation-page)

## Questions about Vercel REST API endpoint reference in dots

**Can dots use Vercel REST API endpoint reference?**

Yes. Add Spiral to dots as an MCP server, and dots can find and run Vercel REST API endpoint reference like any built-in tool.

**How much does Vercel REST API endpoint reference cost in dots?**

$0.00873 per call. You pay from your Spiral balance as you go, with no subscription, and a failed run is not charged. Your dots plan is separate.

**Do I need an Alexandria account to use Vercel REST API endpoint reference in dots?**

You need no Alexandria account. dots uses one Spiral API key for every tool, and Spiral runs Vercel REST API endpoint reference on its own Alexandria account.

**How long does it take to set up Vercel REST API endpoint reference in dots?**

About two minutes: create an API key, then send your dot this message, then give your dot the key.

**Does dots wait while Vercel REST API endpoint reference runs?**

Vercel REST API endpoint reference runs in the background. dots starts the run, checks on it and gives you the json when it's ready.

**Does this data include my deployed application's logs or project settings?**

The coverage is limited to public Vercel pages and catalogs. Private project records and runtime logs are outside that boundary.

**Are documentation search results the full documentation?**

Vercel describes its sitemap as a high-level semantic index and explicitly says it does not replace individual docs. Read the linked page for the full explanation.

**What does the documentation's update date mean?**

Vercel's Markdown metadata defines the date as the day the source page last changed. That date describes the documentation page.

**Do Markdown documentation pages retain code examples and tables?**

Yes. Vercel says the Markdown body preserves headings, links, fenced code blocks, and tables.

**Does Vercel provide a separate index for product announcements?**

Yes. Vercel publishes a dedicated Markdown changelog sitemap, separate from its documentation sitemap.

