{"openapi":"3.1.0","info":{"title":"Eduzz (BYOK) API","version":"0.1.0","description":"Eduzz (BYOK) lets an AI assistant read your own Eduzz data through the Eduzz API with a key you supply (Eduzz personal access token (from your app in the Eduzz Console)). Read-only: 9 tools (list_products, get_product, get_product_offers, get_product_campaigns, list_product_coupons, get_sales_summary, list_sales, get_sale, list_subscriptions). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-eduzz.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-eduzz/docs"},"termsOfService":"https://connectorbay.com/byok-eduzz/terms"},"servers":[{"url":"https://byok-eduzz.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-eduzz/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_products":{"post":{"operationId":"list_products","summary":"List your Eduzz products with name, type, status, price and accepted payment methods. Paged. Use for \"Which products do ","description":"List your Eduzz products with name, type, status, price and accepted payment methods. Paged. Use for \"Which products do I sell on Eduzz and at what price\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"items_per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100).","title":"Items Per Page"}},"title":"list_productsArguments","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_product":{"post":{"operationId":"get_product","summary":"Get one Eduzz product: name, description, type, status, price and accepted payment methods. Use for \"What are the detail","description":"Get one Eduzz product: name, description, type, status, price and accepted payment methods. Use for \"What are the details of my Eduzz product 47998\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product_id":{"description":"Eduzz product id from list_products, for example '47998'.","maxLength":200,"title":"Product Id","type":"string"}},"required":["product_id"],"title":"get_productArguments","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_product_offers":{"post":{"operationId":"get_product_offers","summary":"Get the offers (price variants and checkout links) of an Eduzz product. Use for \"Which offers does my Eduzz product 4799","description":"Get the offers (price variants and checkout links) of an Eduzz product. Use for \"Which offers does my Eduzz product 47998 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product_id":{"description":"Eduzz product id from list_products, for example '47998'.","maxLength":200,"title":"Product Id","type":"string"}},"required":["product_id"],"title":"get_product_offersArguments","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_product_campaigns":{"post":{"operationId":"get_product_campaigns","summary":"Get the tracking campaigns of an Eduzz product with their links and per-click results. Use for \"Which campaigns exist fo","description":"Get the tracking campaigns of an Eduzz product with their links and per-click results. Use for \"Which campaigns exist for my Eduzz product 47998\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"product_id":{"description":"Eduzz product id from list_products, for example '47998'.","maxLength":200,"title":"Product Id","type":"string"}},"required":["product_id"],"title":"get_product_campaignsArguments","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_product_coupons":{"post":{"operationId":"list_product_coupons","summary":"List the discount coupons of your Eduzz products with value, quantity, expiry and the products they apply to. Use for \"W","description":"List the discount coupons of your Eduzz products with value, quantity, expiry and the products they apply to. Use for \"Which discount coupons are active on my Eduzz products\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"items_per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100).","title":"Items Per Page"}},"title":"list_product_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_sales_summary":{"post":{"operationId":"get_sales_summary","summary":"Get an aggregate sales report for a period: gross and net gain, fees, affiliate and partner gains and total. Use for \"Ho","description":"Get an aggregate sales report for a period: gross and net gain, fees, affiliate and partner gains and total. Use for \"How much did I earn on Eduzz in October 2026\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period, ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period, ISO 8601 date-time, for example 2026-10-31T23:59:59Z.","title":"End Date"},"status":{"anyOf":[{"enum":["open","processing","paid","canceled","waitingRefund","refunded"],"type":"string"},{"type":"null"}],"default":null,"description":"Sale status filter: open, processing, paid, canceled, waitingRefund, refunded or others as documented.","title":"Status"},"product_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only sales of this Eduzz product id.","title":"Product Id"}},"title":"get_sales_summaryArguments","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 Eduzz sales for a period with status, amounts, payment method, product, refund and UTM data (buyer identity is not ","description":"List Eduzz sales for a period with status, amounts, payment method, product, refund and UTM data (buyer identity is not returned). Paged. Use for \"Which Eduzz sales were paid this week and for how much\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"items_per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100).","title":"Items Per Page"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period, ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period, ISO 8601 date-time, for example 2026-10-31T23:59:59Z.","title":"End Date"},"reference_date":{"anyOf":[{"enum":["dueDate","paidAt","createdAt","updatedAt"],"type":"string"},{"type":"null"}],"default":null,"description":"Which date the period applies to: dueDate, paidAt, createdAt or updatedAt.","title":"Reference Date"},"status":{"anyOf":[{"enum":["open","processing","paid","canceled","waitingRefund","refunded"],"type":"string"},{"type":"null"}],"default":null,"description":"Sale status filter: open, processing, paid, canceled, waitingRefund, refunded or others as documented.","title":"Status"},"product_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only sales of this Eduzz product id.","title":"Product Id"}},"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/get_sale":{"post":{"operationId":"get_sale","summary":"Get one Eduzz sale: status, amounts, payment method, product, refund and UTM data (buyer identity is not returned). Use ","description":"Get one Eduzz sale: status, amounts, payment method, product, refund and UTM data (buyer identity is not returned). Use for \"What is the status of Eduzz sale 9876543\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sale_id":{"description":"Eduzz sale id from list_sales.","maxLength":200,"title":"Sale Id","type":"string"}},"required":["sale_id"],"title":"get_saleArguments","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_subscriptions":{"post":{"operationId":"list_subscriptions","summary":"List Eduzz subscriptions created or updated in a period with status, recurrence, charge counts, products and price (cust","description":"List Eduzz subscriptions created or updated in a period with status, recurrence, charge counts, products and price (customer identity is not returned). Paged. Use for \"Which Eduzz subscriptions are active and when is the next charge\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"items_per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Items per page (1 to 100).","title":"Items Per Page"},"start_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the period, ISO 8601 date-time, for example 2026-10-01T00:00:00Z.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the period, ISO 8601 date-time, for example 2026-10-31T23:59:59Z.","title":"End Date"},"filter_by":{"anyOf":[{"enum":["creation","update"],"type":"string"},{"type":"null"}],"default":"creation","description":"Whether the period applies to creation or update dates.","title":"Filter By"}},"title":"list_subscriptionsArguments","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}}}}