{"openapi":"3.1.0","info":{"title":"Tebex (BYOK) API","version":"0.1.0","description":"Tebex (BYOK) lets an AI assistant read your own Tebex data through the Tebex API with a key you supply (Tebex game server secret key (creator.tebex.io > Game Servers > Edit)). Read-only: 6 tools (get_store_information, list_sales, list_community_goals, get_community_goal, list_coupons, get_coupon). 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-tebex-plugin.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-tebex-plugin/docs"},"termsOfService":"https://connectorbay.com/byok-tebex-plugin/terms"},"servers":[{"url":"https://byok-tebex-plugin.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-tebex-plugin/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_store_information":{"post":{"operationId":"get_store_information","summary":"Show the Tebex store and game server the secret key belongs to: store id, name, domain, currency, game type and server n","description":"Show the Tebex store and game server the secret key belongs to: store id, name, domain, currency, game type and server name. Use for \"Which Tebex store is my secret key connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_store_informationArguments","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_sales":{"post":{"operationId":"list_sales","summary":"List the active sales on the store with the packages or categories they apply to, discount type and amount, start and ex","description":"List the active sales on the store with the packages or categories they apply to, discount type and amount, start and expiry time. Use for \"Which sales are running on my Tebex store\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_salesArguments","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_community_goals":{"post":{"operationId":"list_community_goals","summary":"List the community goals with target, current progress, status and how often they were achieved. Use for \"How far along ","description":"List the community goals with target, current progress, status and how often they were achieved. Use for \"How far along are my Tebex community goals\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_community_goalsArguments","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_community_goal":{"post":{"operationId":"get_community_goal","summary":"Get one community goal by id. Use for \"Show Tebex community goal 4\".","description":"Get one community goal by id. Use for \"Show Tebex community goal 4\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"community_goal":{"description":"Numeric community goal id from list_community_goals.","minimum":1,"title":"Community Goal","type":"integer"}},"required":["community_goal"],"title":"get_community_goalArguments","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_coupons":{"post":{"operationId":"list_coupons","summary":"List coupon rules with code, what they apply to, discount, redemption limits, start date and minimum basket. Restricted ","description":"List coupon rules with code, what they apply to, discount, redemption limits, start date and minimum basket. Restricted usernames and notes are left out. Use for \"Which coupons exist on my Tebex store\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_couponsArguments","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_coupon":{"post":{"operationId":"get_coupon","summary":"Get one coupon rule by id. Restricted username and note are left out. Use for \"Show Tebex coupon 2\".","description":"Get one coupon rule by id. Restricted username and note are left out. Use for \"Show Tebex coupon 2\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Coupon id from list_coupons.","maxLength":20,"title":"Id","type":"string"}},"required":["id"],"title":"get_couponArguments","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}}}}