{"openapi":"3.1.0","info":{"title":"Carbonmark (BYOK) API","version":"0.1.0","description":"Carbonmark (BYOK) lets an AI assistant read your own Carbonmark data through the Carbonmark API with a key you supply (Carbonmark API key (a free sandbox key works for reads)). Read-only: 6 tools (list_countries, list_vintages, list_methodology_categories, search_projects_by_text, filter_projects, get_project). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-carbonmark.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-carbonmark/docs"},"termsOfService":"https://connectorbay.com/byok-carbonmark/terms"},"servers":[{"url":"https://byok-carbonmark.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-carbonmark/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_countries":{"post":{"operationId":"list_countries","summary":"List the country values that can be used to filter carbon projects. Use for \"Which countries have carbon projects on Car","description":"List the country values that can be used to filter carbon projects. Use for \"Which countries have carbon projects on Carbonmark\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_countriesArguments","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_vintages":{"post":{"operationId":"list_vintages","summary":"List the vintage years that can be used to filter carbon projects. Use for \"Which carbon credit vintages are available\".","description":"List the vintage years that can be used to filter carbon projects. Use for \"Which carbon credit vintages are available\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_vintagesArguments","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_methodology_categories":{"post":{"operationId":"list_methodology_categories","summary":"List the methodology categories (for example Forestry, Renewable Energy, Blue Carbon) that can be used to filter carbon ","description":"List the methodology categories (for example Forestry, Renewable Energy, Blue Carbon) that can be used to filter carbon projects. Use for \"What methodology categories do carbon projects fall into\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_methodology_categoriesArguments","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/search_projects_by_text":{"post":{"operationId":"search_projects_by_text","summary":"Search carbon projects by a text string matched against project name and description, for example 'REDD+'. Use for \"Find","description":"Search carbon projects by a text string matched against project name and description, for example 'REDD+'. Use for \"Find carbon projects about REDD+\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search":{"description":"Text to match in project names and descriptions.","maxLength":200,"title":"Search","type":"string"},"asset_price_type":{"anyOf":[{"enum":["listing","klimaprotocol"],"type":"string"},{"type":"null"}],"default":null,"description":"Pricing source to use: listing (seller listings on Carbonmark) or klimaprotocol (Klima protocol pool prices).","title":"Asset Price Type"}},"required":["search"],"title":"search_projects_by_textArguments","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/filter_projects":{"post":{"operationId":"filter_projects","summary":"Find carbon projects filtered by country, methodology category and vintage (use the list tools for valid values), with r","description":"Find carbon projects filtered by country, methodology category and vintage (use the list tools for valid values), with registry, supply stats and price. Use for \"Which renewable energy projects in India have a 2012 vintage\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"country":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Country value from list_countries, for example 'India'.","title":"Country"},"category":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Methodology category from list_methodology_categories, for example 'Renewable Energy'.","title":"Category"},"vintage":{"anyOf":[{"maxLength":4,"type":"string"},{"type":"null"}],"default":null,"description":"Vintage year from list_vintages, for example '2012'.","title":"Vintage"},"asset_price_type":{"anyOf":[{"enum":["listing","klimaprotocol"],"type":"string"},{"type":"null"}],"default":null,"description":"Pricing source to use: listing (seller listings on Carbonmark) or klimaprotocol (Klima protocol pool prices).","title":"Asset Price Type"}},"title":"filter_projectsArguments","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_project":{"post":{"operationId":"get_project","summary":"Get one carbon project by its key (registry and project id, for example VCS-274): registry link, methodologies, vintages","description":"Get one carbon project by its key (registry and project id, for example VCS-274): registry link, methodologies, vintages, supply stats, price and sustainable development goals. Use for \"Show details of carbon project VCS-274\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_key":{"description":"Project key as returned by the search tools, for example 'VCS-274'.","maxLength":40,"title":"Project Key","type":"string"},"asset_price_type":{"anyOf":[{"enum":["listing","klimaprotocol"],"type":"string"},{"type":"null"}],"default":null,"description":"Pricing source to use: listing (seller listings on Carbonmark) or klimaprotocol (Klima protocol pool prices).","title":"Asset Price Type"}},"required":["project_key"],"title":"get_projectArguments","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}}}}