{"openapi":"3.1.0","info":{"title":"Vercel Checks (BYOK) API","version":"0.1.0","description":"Vercel Checks (BYOK) lets an AI assistant read your own Vercel Checks data through the Vercel Checks API with a key you supply (access token). Read-only: 6 tools (list_project_checks, get_project_check, list_check_runs, list_deployment_check_runs, list_deployment_checks, get_deployment_check). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-vercel-checks.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-vercel-checks/docs"},"termsOfService":"https://connectorbay.com/byok-vercel-checks/terms"},"servers":[{"url":"https://byok-vercel-checks.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-vercel-checks/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_project_checks":{"post":{"operationId":"list_project_checks","summary":"List the checks configured for a Vercel project: name, what each blocks (build start, deployment start, alias, promotion","description":"List the checks configured for a Vercel project: name, what each blocks (build start, deployment start, alias, promotion), when it needs the deployment, targets and timeout. Use for \"Which checks gate deployments of my Vercel project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Vercel project ID (prj_...) or name, for example 'my-site'.","maxLength":100,"title":"Project","type":"string"},"blocks":{"anyOf":[{"enum":["build-start","deployment-start","deployment-alias","deployment-promotion","none"],"type":"string"},{"type":"null"}],"default":null,"description":"Only checks that block this stage.","title":"Blocks"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"}},"required":["project"],"title":"list_project_checksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_project_check":{"post":{"operationId":"get_project_check","summary":"Get one project check: what it blocks, when it runs, targets, timeout and source kind. Use for \"Show Vercel project chec","description":"Get one project check: what it blocks, when it runs, targets, timeout and source kind. Use for \"Show Vercel project check chk_abc123 of my-site\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Vercel project ID (prj_...) or name, for example 'my-site'.","maxLength":100,"title":"Project","type":"string"},"check_id":{"description":"Check ID, as returned by list_project_checks.","maxLength":100,"title":"Check Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"}},"required":["project","check_id"],"title":"get_project_checkArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_check_runs":{"post":{"operationId":"list_check_runs","summary":"List the runs of one project check across deployments with status, conclusion, deployment and timing. Use for \"Did the L","description":"List the runs of one project check across deployments with status, conclusion, deployment and timing. Use for \"Did the Lighthouse check pass on recent deployments of my-site\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"description":"Vercel project ID (prj_...) or name, for example 'my-site'.","maxLength":100,"title":"Project","type":"string"},"check_id":{"description":"Check ID, as returned by list_project_checks.","maxLength":100,"title":"Check Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"}},"required":["project","check_id"],"title":"list_check_runsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_deployment_check_runs":{"post":{"operationId":"list_deployment_check_runs","summary":"List the check runs of one deployment with status, conclusion, what each blocks and timing. Use for \"Which checks ran fo","description":"List the check runs of one deployment with status, conclusion, what each blocks and timing. Use for \"Which checks ran for Vercel deployment dpl_abc123 and what were the results\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"Deployment ID (dpl_...), as returned by list_deployments in the Vercel connector.","maxLength":100,"title":"Deployment Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"}},"required":["deployment_id"],"title":"list_deployment_check_runsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_deployment_checks":{"post":{"operationId":"list_deployment_checks","summary":"List the integration checks registered on one deployment (older checks API) with status, conclusion, blocking flag and d","description":"List the integration checks registered on one deployment (older checks API) with status, conclusion, blocking flag and details link. Use for \"Which integration checks are running on Vercel deployment dpl_abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"Deployment ID (dpl_...), as returned by list_deployments in the Vercel connector.","maxLength":100,"title":"Deployment Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"}},"required":["deployment_id"],"title":"list_deployment_checksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_deployment_check":{"post":{"operationId":"get_deployment_check","summary":"Get one integration check of a deployment: status, conclusion, blocking flag, path, details link and timing. Use for \"Sh","description":"Get one integration check of a deployment: status, conclusion, blocking flag, path, details link and timing. Use for \"Show Vercel deployment check check_abc123 on dpl_abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"Deployment ID (dpl_...), as returned by list_deployments in the Vercel connector.","maxLength":100,"title":"Deployment Id","type":"string"},"check_id":{"description":"Check ID, as returned by list_deployment_checks.","maxLength":100,"title":"Check Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"}},"required":["deployment_id","check_id"],"title":"get_deployment_checkArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}