Get deployment with the Vercel API

Returns a deployment by its id or its url, with readyState, target, alias, projectId and, for a failed build, errorCode and errorMessage.

Identifier
vercel_get_deployment

The request

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

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

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
idOrUrlstringYesThe uid of the deployment from List deployments, or its hostname, such as my-site-abc123.vercel.app.
teamIdstringNoWith a Full Account token, the id of the team from List teams that owns the deployment. Omit it for the personal account or with a team token.
withGitRepoInfostringNoSend true to add gitSource, with the commit, branch and repository.Values: true, false

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_get_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.