{"openapi":"3.1.0","info":{"title":"Metorial (BYOK) API","version":"0.1.0","description":"Metorial (BYOK) lets an AI assistant read your own Metorial data through the Metorial API with a key you supply (Metorial secret API key). Read-only: 9 tools (list_providers, get_provider, list_provider_versions, list_provider_tools, list_provider_auth_methods, list_provider_deployments, get_provider_deployment, list_custom_providers, get_custom_provider). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-metorial-providers.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-metorial-providers/docs"},"termsOfService":"https://connectorbay.com/byok-metorial-providers/terms"},"servers":[{"url":"https://byok-metorial-providers.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-metorial-providers/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_providers":{"post":{"operationId":"list_providers","summary":"List or search the Metorial providers (MCP servers and integrations) with publisher, current version, access level and O","description":"List or search the Metorial providers (MCP servers and integrations) with publisher, current version, access level and OAuth status. Use for \"Which Metorial providers mention GitHub\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search over provider names, for example 'github'.","title":"Search"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last item of the previous page; leave empty for the first page.","title":"After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order by creation time.","title":"Order"}},"title":"list_providersArguments","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_provider":{"post":{"operationId":"get_provider","summary":"Get one Metorial provider by id with publisher, current version, access level and OAuth status. Use for \"Show Metorial p","description":"Get one Metorial provider by id with publisher, current version, access level and OAuth status. Use for \"Show Metorial provider prv_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"provider_id":{"description":"Provider id from list_providers.","maxLength":200,"title":"Provider Id","type":"string"}},"required":["provider_id"],"title":"get_providerArguments","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_provider_versions":{"post":{"operationId":"list_provider_versions","summary":"List the versions of Metorial providers, optionally for one provider, with the current version flagged. Use for \"What ve","description":"List the versions of Metorial providers, optionally for one provider, with the current version flagged. Use for \"What versions exist for Metorial provider prv_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"provider_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only versions of this provider id.","title":"Provider Id"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last item of the previous page; leave empty for the first page.","title":"After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order by creation time.","title":"Order"}},"title":"list_provider_versionsArguments","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_provider_tools":{"post":{"operationId":"list_provider_tools","summary":"List the tools a provider version offers with key, description and read-only or destructive tags (no input schemas). Use","description":"List the tools a provider version offers with key, description and read-only or destructive tags (no input schemas). Use for \"Which tools does Metorial provider version pvr_1 expose and which are destructive\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"provider_version_id":{"description":"Provider version id from list_provider_versions or get_provider.","maxLength":100,"title":"Provider Version Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last item of the previous page; leave empty for the first page.","title":"After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order by creation time.","title":"Order"}},"required":["provider_version_id"],"title":"list_provider_toolsArguments","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_provider_auth_methods":{"post":{"operationId":"list_provider_auth_methods","summary":"List the authentication methods (OAuth, token, custom) a provider version supports with scopes and adapters. Use for \"Ho","description":"List the authentication methods (OAuth, token, custom) a provider version supports with scopes and adapters. Use for \"How can I authenticate against Metorial provider version pvr_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"provider_version_id":{"description":"Provider version id from list_provider_versions or get_provider.","maxLength":100,"title":"Provider Version Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last item of the previous page; leave empty for the first page.","title":"After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order by creation time.","title":"Order"}},"required":["provider_version_id"],"title":"list_provider_auth_methodsArguments","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_provider_deployments":{"post":{"operationId":"list_provider_deployments","summary":"List your provider deployments with locked version, default flag and status, optionally filtered by provider or status. ","description":"List your provider deployments with locked version, default flag and status, optionally filtered by provider or status. Use for \"Which provider deployments do I have in Metorial\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"provider_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments of this provider id.","title":"Provider Id"},"status":{"anyOf":[{"enum":["active","archived","deleted"],"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments with this status.","title":"Status"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search over deployment names.","title":"Search"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last item of the previous page; leave empty for the first page.","title":"After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order by creation time.","title":"Order"}},"title":"list_provider_deploymentsArguments","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_provider_deployment":{"post":{"operationId":"get_provider_deployment","summary":"Get one provider deployment by id with locked version, default flag and status. Use for \"Show Metorial provider deployme","description":"Get one provider deployment by id with locked version, default flag and status. Use for \"Show Metorial provider deployment pdp_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"provider_deployment_id":{"description":"Deployment id from list_provider_deployments.","maxLength":200,"title":"Provider Deployment Id","type":"string"}},"required":["provider_deployment_id"],"title":"get_provider_deploymentArguments","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_custom_providers":{"post":{"operationId":"list_custom_providers","summary":"List your custom providers (function, container or remote MCP) with type, status and linked repository (no config or sec","description":"List your custom providers (function, container or remote MCP) with type, status and linked repository (no config or secrets). Use for \"Which custom providers have I built in Metorial\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["function","container","remote"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this type.","title":"Type"},"status":{"anyOf":[{"enum":["active","archived","deleted"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this status.","title":"Status"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search over names.","title":"Search"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor: the id of the last item of the previous page; leave empty for the first page.","title":"After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order by creation time.","title":"Order"}},"title":"list_custom_providersArguments","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_custom_provider":{"post":{"operationId":"get_custom_provider","summary":"Get one custom provider by id with type, status and linked repository (no config or secrets). Use for \"Show Metorial cus","description":"Get one custom provider by id with type, status and linked repository (no config or secrets). Use for \"Show Metorial custom provider cpr_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"custom_provider_id":{"description":"Custom provider id from list_custom_providers.","maxLength":200,"title":"Custom Provider Id","type":"string"}},"required":["custom_provider_id"],"title":"get_custom_providerArguments","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}}}}