{"openapi":"3.1.0","info":{"title":"Vercel Sandboxes (BYOK) API","version":"0.1.0","description":"Vercel Sandboxes (BYOK) lets an AI assistant read your own Vercel Sandboxes data through the Vercel Sandboxes API with a key you supply (access token). Read-only: 6 tools (list_sandboxes, get_sandbox, list_drives, get_drive, get_snapshot, get_session). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-vercel-sandboxes.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-vercel-sandboxes/docs"},"termsOfService":"https://connectorbay.com/byok-vercel-sandboxes/terms"},"servers":[{"url":"https://byok-vercel-sandboxes.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-vercel-sandboxes/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_sandboxes":{"post":{"operationId":"list_sandboxes","summary":"List named Vercel sandboxes with status, region, runtime, vCPUs, memory, persistence and usage totals. Filter by project","description":"List named Vercel sandboxes with status, region, runtime, vCPUs, memory, persistence and usage totals. Filter by project, name prefix or status. Use for \"Which of my Vercel sandboxes are running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items of this project (id or name).","title":"Project"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 50).","title":"Limit"},"sort_by":{"anyOf":[{"enum":["createdAt","name","statusUpdatedAt","currentSnapshotId"],"type":"string"},{"type":"null"}],"default":"createdAt","description":"Field to sort by.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Sort Order"},"name_prefix":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only sandboxes whose name starts with this text.","title":"Name Prefix"},"status":{"anyOf":[{"enum":["running","stopping","stopped"],"type":"string"},{"type":"null"}],"default":null,"description":"Only sandboxes in this state.","title":"Status"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Continuation cursor from pagination.next of the previous answer; leave empty for the first page.","title":"Cursor"},"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"}},"title":"list_sandboxesArguments","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_sandbox":{"post":{"operationId":"get_sandbox","summary":"Get one named sandbox: status, region, runtime, size, current session and snapshot, expiry and usage totals. Never resum","description":"Get one named sandbox: status, region, runtime, size, current session and snapshot, expiry and usage totals. Never resumes it. Use for \"Show details of my Vercel sandbox build-box\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"description":"Sandbox name, as returned by list_sandboxes.","maxLength":100,"title":"Name","type":"string"},"project_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Project (id or name) the sandbox belongs to.","title":"Project Id"},"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":["name"],"title":"get_sandboxArguments","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_drives":{"post":{"operationId":"list_drives","summary":"List sandbox drives (persistent volumes) with size limit, region, project and the sandbox they are attached to. Use for ","description":"List sandbox drives (persistent volumes) with size limit, region, project and the sandbox they are attached to. Use for \"Which Vercel sandbox drives do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only drives of this project (id).","title":"Project Id"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 50).","title":"Limit"},"name_prefix":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only drives whose name starts with this text.","title":"Name Prefix"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Continuation cursor from pagination.next of the previous answer; leave empty for the first page.","title":"Cursor"},"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"}},"title":"list_drivesArguments","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_drive":{"post":{"operationId":"get_drive","summary":"Get one sandbox drive by name or id: size limit, region, project and attached sandbox. Use for \"Show details of the Verc","description":"Get one sandbox drive by name or id: size limit, region, project and attached sandbox. Use for \"Show details of the Vercel drive cache-drive\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name_or_id":{"description":"Drive name or id.","maxLength":100,"title":"Name Or Id","type":"string"},"project_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Project (id) the drive belongs to.","title":"Project Id"},"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":["name_or_id"],"title":"get_driveArguments","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_snapshot":{"post":{"operationId":"get_snapshot","summary":"Get one sandbox snapshot by id: status, creation method, architecture, region, size, expiry and source session. Use for ","description":"Get one sandbox snapshot by id: status, creation method, architecture, region, size, expiry and source session. Use for \"Show details of Vercel sandbox snapshot snap_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"snapshot_id":{"description":"Snapshot id (snap_...).","maxLength":100,"title":"Snapshot 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":["snapshot_id"],"title":"get_snapshotArguments","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_session":{"post":{"operationId":"get_session","summary":"Get one sandbox session by id: status, region, runtime, size, start and stop time, duration and CPU time. Use for \"How l","description":"Get one sandbox session by id: status, region, runtime, size, start and stop time, duration and CPU time. Use for \"How long did Vercel sandbox session sess_1 run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"session_id":{"description":"Session id (sess_...).","maxLength":100,"title":"Session 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":["session_id"],"title":"get_sessionArguments","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}}}}