{"openapi":"3.1.0","info":{"title":"EnergyCAP Emissions (BYOK) API","version":"0.1.0","description":"EnergyCAP Emissions (BYOK) lets an AI assistant read your own EnergyCAP Emissions data through the EnergyCAP Emissions API with a key you supply (EnergyCAP API key). Read-only: 9 tools (list_emission_sources, get_emission_source, list_emission_records, get_emission_record, list_ghg_factors, get_ghg_factor_versions, list_ghg_factor_categories, list_ghg_factor_regions, list_ghg_scopes). The BYOK...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-energycap-emissions.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-energycap-emissions/docs"},"termsOfService":"https://connectorbay.com/byok-energycap-emissions/terms"},"servers":[{"url":"https://byok-energycap-emissions.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-energycap-emissions/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_emission_sources":{"post":{"operationId":"list_emission_sources","summary":"List GHG emission sources (for example purchased electricity at a building) with code, commodity, collection, linked met","description":"List GHG emission sources (for example purchased electricity at a building) with code, commodity, collection, linked meter, default scope category and default factor. Paged. Use for \"Which emission sources are set up in EnergyCAP\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":400,"type":"string"},{"type":"null"}],"default":null,"description":"Narrow the emission sources. Filter expression: field operator 'value' pairs joined by and, every value in single quotes, operators such as equals, not equals, like, one of ('a'|'b'), between ('a'|'b'), greater than, less than. Example: active equals 'true'.","title":"Filter"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Rows per page (1 to 1000; the service default is 250).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"title":"list_emission_sourcesArguments","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_emission_source":{"post":{"operationId":"get_emission_source","summary":"Get one emission source by ID with its code, commodity, collection, linked meter, scope category and default factor. Use","description":"Get one emission source by ID with its code, commodity, collection, linked meter, scope category and default factor. Use for \"Describe EnergyCAP emission source 321\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"emission_source_id":{"description":"Numeric emission source ID, for example 321 (from list_emission_sources).","minimum":1,"title":"Emission Source Id","type":"integer"}},"required":["emission_source_id"],"title":"get_emission_sourceArguments","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_emission_records":{"post":{"operationId":"list_emission_records","summary":"List emission records (period, quantity, total kgCO2e, scope category, factor and per-gas totals) across your emission s","description":"List emission records (period, quantity, total kgCO2e, scope category, factor and per-gas totals) across your emission sources. Paged. Use for \"Show the emission records for August 2026\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":400,"type":"string"},{"type":"null"}],"default":null,"description":"Narrow the emission records, for example by emissionSourceId or period dates. Filter expression: field operator 'value' pairs joined by and, every value in single quotes, operators such as equals, not equals, like, one of ('a'|'b'), between ('a'|'b'), greater than, less than. Example: startDate greater than equal '2026-08-01'.","title":"Filter"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Rows per page (1 to 1000; the service default is 250).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"title":"list_emission_recordsArguments","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_emission_record":{"post":{"operationId":"get_emission_record","summary":"Get one emission record by ID with period, quantity, total kgCO2e, scope category, factor and per-gas totals. Use for \"S","description":"Get one emission record by ID with period, quantity, total kgCO2e, scope category, factor and per-gas totals. Use for \"Show EnergyCAP emission record 4455\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"emission_record_id":{"description":"Numeric emission record ID, for example 4455 (from list_emission_records).","minimum":1,"title":"Emission Record Id","type":"integer"}},"required":["emission_record_id"],"title":"get_emission_recordArguments","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_ghg_factors":{"post":{"operationId":"list_ghg_factors","summary":"List the GHG emission factors (name, category, region, source organization, input unit) available for emission calculati","description":"List the GHG emission factors (name, category, region, source organization, input unit) available for emission calculations. Paged. Use for \"Which emission factors are available for the US\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"filter":{"anyOf":[{"maxLength":400,"type":"string"},{"type":"null"}],"default":null,"description":"Narrow the factors, for example by category or region. Filter expression: field operator 'value' pairs joined by and, every value in single quotes, operators such as equals, not equals, like, one of ('a'|'b'), between ('a'|'b'), greater than, less than. Example: factorRegionInfo like 'US'.","title":"Filter"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Rows per page (1 to 1000; the service default is 250).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"title":"list_ghg_factorsArguments","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_ghg_factor_versions":{"post":{"operationId":"get_ghg_factor_versions","summary":"Get the version history of one GHG emission factor: effective dates, source, units and the per-gas values of each versio","description":"Get the version history of one GHG emission factor: effective dates, source, units and the per-gas values of each version. Use for \"Show the version history of emission factor 17\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"factor_id":{"description":"Numeric GHG emission factor ID, for example 17 (from list_ghg_factors).","minimum":1,"title":"Factor Id","type":"integer"}},"required":["factor_id"],"title":"get_ghg_factor_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_ghg_factor_categories":{"post":{"operationId":"list_ghg_factor_categories","summary":"List the GHG emission factor categories (for example electricity, natural gas, refrigerants). Use for \"What emission fac","description":"List the GHG emission factor categories (for example electricity, natural gas, refrigerants). Use for \"What emission factor categories exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_ghg_factor_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/list_ghg_factor_regions":{"post":{"operationId":"list_ghg_factor_regions","summary":"List the GHG emission factor regions (countries and grid sub-regions). Use for \"What emission factor regions exist\".","description":"List the GHG emission factor regions (countries and grid sub-regions). Use for \"What emission factor regions exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_ghg_factor_regionsArguments","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_ghg_scopes":{"post":{"operationId":"list_ghg_scopes","summary":"List the GHG Protocol scopes with the scope categories under each one. Use for \"Which GHG scopes and scope categories ca","description":"List the GHG Protocol scopes with the scope categories under each one. Use for \"Which GHG scopes and scope categories can I use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_ghg_scopesArguments","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}}}}