Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Schematic (BYOK) — connector documentation

  • MCP endpoint: https://byok-schematic.connectorbay.com/mcp
  • REST API: POST https://byok-schematic.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-schematic.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Schematic Schematic secret API key (a read-only key is recommended), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-schematic.connectorbay.com/health · Tool schemas: https://byok-schematic.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-schematic · agent@connectorbay.com

What Schematic (BYOK) is for

Schematic (BYOK) lets an AI assistant read your own Schematic data through the Schematic API with a key you supply (Schematic secret API key (a read-only key is recommended)). Read-only: 7 tools (list_plans, list_companies, list_features, list_credits, list_credit_bundles, list_plan_entitlements, list_feature_usage). 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 api.schematichq.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Schematic. Schematic and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Schematic plans do I have and how many companies are on each?"
  • "Which Schematic companies are past due or on a trial?"
  • "Which features are defined in Schematic and which are metered?"
  • "Which credit types does my Schematic account have?"
  • "Which credit bundles can customers buy in Schematic?"
  • "What limits does each Schematic plan give for each feature?"

What it does

  • list_plans: List plans and add-ons with name, type, charge type, billing strategy, number of companies, trial days and monthly and yearly prices.
  • list_companies: List companies (your customers) with their current plan, subscription status, total price, billing interval and user count. Payment method and billing email details are not returned.
  • list_features: List features with name, type (boolean, event or trait), description and lifecycle phase.
  • list_credits: List billing credit types with name, description, burn strategy, expiry defaults and rollover policy.
  • list_credit_bundles: List purchasable credit bundles with name, credit type, quantity, status, bundle type and expiry settings.
  • list_plan_entitlements: List plan entitlements: which feature each plan grants, the value type, numeric limit or boolean value, soft limit and metric period.
  • list_feature_usage: List feature usage per entitlement: allocation, usage so far, percent used, period and reset time. Pass a company id to see one customer's usage.

BYOK key

You bring your own Schematic Schematic secret API key (a read-only key is recommended) (https://docs.schematichq.com/quickstart/account-setup). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.schematichq.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Schematic API (api.schematichq.com) with a BYOK key; documentation: https://docs.schematichq.com/api-reference/authentication. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Schematic. Schematic and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Schematic account.

Built for: Worldwide. Languages: English.