Listar projetos no Vercel, por uma API
Lista os projetos da conta ou de um time, com suas configurações, vínculo com Git e últimos deployments. Cada item tem id e name, que as outras tools usam como o projeto. Pagine passando pagination.next da resposta como from.
- Identificador
- vercel_list_projects
A chamada
POST https://connect.reportei.com/api/tools/vercel_list_projects/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"teamId": "<teamId>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| teamId | string | Não | With a Full Account token, the id of a team from List teams, to act on that team. Omit it for the personal account or with a team token. |
| search | string | Não | Text matched against the project name. |
| repo | string | Não | Only projects connected to this Git repository, such as owner/name. |
| limit | string | Não | Maximum number of projects to return, as a number such as 20. |
| from | string | Não | For the next page, the pagination.next of the previous response. |
Conexões possíveis
O seu cliente conecta a conta do Vercel uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/vercel_list_projects. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Vercel
- Listar timesGETLista os times a que a conta pertence. Cada item tem id, o teamId que as outras tools usam, e slug. Só um token de Full Account precisa de teamId: um token criado para um time já atua nesse time. Pagine passando pagination.next da resposta como until.
- Criar projetoPOSTCria um projeto e o retorna, com seu id. Com gitRepository, cada push no repositório faz deploy automaticamente; o app da Vercel do provedor Git precisa ter acesso ao repositório. Configurações de build omitidas são detectadas pela Vercel.
- Atualizar projetoPATCHAltera o nome ou as configurações de build de um projeto e o retorna. Só os campos enviados mudam. As novas configurações valem a partir do próximo deployment.
- Listar deploymentsGETLista deployments, do mais novo ao mais antigo, com state, target, url e metadados do Git. Cada item tem uid, o id do deployment. Pagine passando pagination.next da resposta como until.
- Obter deploymentGETRetorna um deployment pelo id ou pela url, com readyState, target, alias, projectId e, para um build que falhou, errorCode e errorMessage.
- Criar deploymentPOSTInicia um deployment e o retorna, com id, url e readyState. Envie deploymentId para refazer o deploy de um deployment existente, ou gitSource para fazer deploy de um branch ou commit do repositório conectado. Sem target é um preview; production o torna o deployment de produção. O build leva minutos: acompanhe com Get deployment.
- Cancelar deploymentPATCHInterrompe um deployment ainda na fila ou em build e o retorna com readyState CANCELED.
- Promover deploymentPOSTAponta os domínios de produção de um projeto para um deployment existente, sem fazer o build de novo, como para reverter a produção a um deployment de produção mais antigo. Para colocar um preview em produção com um novo build, use Create deployment com seu deploymentId e target production. Responde 201 ou 202 quando aceito.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
