{"openapi":"3.1.0","info":{"title":"GTmetrix Account (BYOK) API","version":"0.1.0","description":"GTmetrix Account (BYOK) lets an AI assistant read your own GTmetrix Account data through the GTmetrix Account API with a key you supply (GTmetrix API key). Read-only: 7 tools (get_account_status, list_locations, get_location, list_browsers, get_browser, list_simulated_devices, get_simulated_device). The BYOK key travels with each request, is used for that one call only and is never stored, logged...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-gtmetrix-account.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-gtmetrix-account/docs"},"termsOfService":"https://connectorbay.com/byok-gtmetrix-account/terms"},"servers":[{"url":"https://byok-gtmetrix-account.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-gtmetrix-account/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/get_account_status":{"post":{"operationId":"get_account_status","summary":"Show the account behind the key: API credit balance, next refill time and amount, plan type and whether PRO options, PRO","description":"Show the account behind the key: API credit balance, next refill time and amount, plan type and whether PRO options, PRO locations and white-label PDFs are available. Reading this costs no credits. Use for \"How many GTmetrix API credits do I have left and when do they refill\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_account_statusArguments","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_locations":{"post":{"operationId":"list_locations","summary":"List GTmetrix test locations with name, region, whether your plan can use them, supported browser ids and how many serve","description":"List GTmetrix test locations with name, region, whether your plan can use them, supported browser ids and how many servers are up. Use for \"Which GTmetrix test locations can my plan use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_locationsArguments","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_location":{"post":{"operationId":"get_location","summary":"Get one test location: name, region, access for your plan, supported browsers and server count. Use for \"Is the Sydney G","description":"Get one test location: name, region, access for your plan, supported browsers and server count. Use for \"Is the Sydney GTmetrix location up\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"location_id":{"description":"Test location ID (from list_locations).","maxLength":32,"title":"Location Id","type":"string"}},"required":["location_id"],"title":"get_locationArguments","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_browsers":{"post":{"operationId":"list_browsers","summary":"List the test browsers available to you with platform (desktop or android), device type and feature support such as thro","description":"List the test browsers available to you with platform (desktop or android), device type and feature support such as throttling, video and Lighthouse. Use for \"Which browsers can I test with in GTmetrix\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_browsersArguments","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_browser":{"post":{"operationId":"get_browser","summary":"Get one test browser with its platform and supported features. Use for \"Does this GTmetrix browser support video\".","description":"Get one test browser with its platform and supported features. Use for \"Does this GTmetrix browser support video\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"browser_id":{"description":"Browser ID (from list_browsers).","maxLength":32,"title":"Browser Id","type":"string"}},"required":["browser_id"],"title":"get_browserArguments","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_simulated_devices":{"post":{"operationId":"list_simulated_devices","summary":"List the simulated phone and tablet devices GTmetrix can emulate, with manufacturer, category, viewport size and pixel r","description":"List the simulated phone and tablet devices GTmetrix can emulate, with manufacturer, category, viewport size and pixel ratio. Use for \"Which phones can GTmetrix simulate\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_simulated_devicesArguments","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_simulated_device":{"post":{"operationId":"get_simulated_device","summary":"Get one simulated device with its viewport size and pixel ratio. Use for \"What screen size does GTmetrix use for iphone_","description":"Get one simulated device with its viewport size and pixel ratio. Use for \"What screen size does GTmetrix use for iphone_xs_max\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"simulated_device_id":{"description":"Simulated device ID (from list_simulated_devices), for example iphone_xs_max.","maxLength":64,"title":"Simulated Device Id","type":"string"}},"required":["simulated_device_id"],"title":"get_simulated_deviceArguments","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}}}}