Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for calculator Scope3 Carbon Calculator Creative API

2 actions 2 updates phrasing extends openapi/scope3-creative-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Scope3's API. It is a proposal applied on top of the contract, not a document Scope3 publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/creative'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for calculator Scope3 Carbon Calculator Creative API
  version: 1.0.0
extends: openapi/scope3-creative-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/creative'].post
  update:
    x-apievangelist-phrasing:
      intent: Calculate the carbon footprint of a creative
      effect: read
      questions:
      - How much carbon does running a particular ad creative produce?
      - Can I see the per-row breakdown when estimating a creative's emissions?
      - Which methodology framework is used for creative carbon calculations by default?
      instructions:
      - text: 'Calculate the carbon footprint of these creative rows: {rows}.'
        slots:
          rows: requestBody.rows
      - text: Estimate creative emissions for {rows} using the {framework} framework.
        slots:
          rows: requestBody.rows
          framework: query.framework
      method: generated
      generated: '2026-10-01'