Create deployment with the Vercel API

Starts a deployment and returns it, with id, url and readyState. Send deploymentId to redeploy an existing deployment, or gitSource to deploy a branch or commit of the connected repository. Without target it is a preview; production makes it the production deployment. The build takes minutes: follow it with Get deployment.

Identifier
vercel_create_deployment

The request

POST https://connect.reportei.com/api/tools/vercel_create_deployment/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "name": "<name>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoWith a Full Account token, the id of the team from List teams that owns the project. Omit it for the personal account or with a team token.
namestringYesName of the project, from List projects.
projectstringNoThe id or name of the project, from List projects. When sent, it wins over name.
deploymentIdstringNoThe uid of an existing deployment from List deployments, to build it again with the same settings.
withLatestCommitbooleanNoWith deploymentId, builds the latest commit of the branch instead of the original one.
gitSourceobjectNoBranch or commit to deploy. For github send org and repo, for gitlab send projectId, and for bitbucket send owner and slug.
targetstringNoproduction, staging or the slug of a custom environment. Omit it for a preview.
forceNewstringNoSend 1 to build even when an identical deployment already exists.Values: 0, 1

Supported connections

Your customer connects their Vercel account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/vercel_create_deployment. It becomes your agent's tool definition with no conversion.

Other Vercel tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.