Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Buyer Syndication API

3 actions 3 updates phrasing extends openapi/scope3-syndication-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 3

$.info
$.paths['/advertisers/{advertiserId}/syndicate'].post
$.paths['/advertisers/{advertiserId}/syndication-status'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Scope3 Buyer Syndication API
  version: 1.0.0
extends: openapi/scope3-syndication-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: 2
- target: $.paths['/advertisers/{advertiserId}/syndicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn syndication on or off for an audience or catalog
      effect: write
      questions:
      - Can I share an audience, event source or catalog with a specific AdCP agent?
      - How do I stop syndicating a resource to an agent?
      instructions:
      - text: Enable syndication of {resource_type} {resource_id} to agents {agent_ids} for advertiser {advertiser_id}, setting enabled to {enabled}.
        slots:
          resource_type: requestBody.resourceType
          resource_id: requestBody.resourceId
          agent_ids: requestBody.adcpAgentIds
          advertiser_id: path.advertiserId
          enabled: requestBody.enabled
      - text: Switch syndication to {enabled} for {resource_type} {resource_id} under advertiser {advertiser_id} with agents {agent_ids}.
        slots:
          enabled: requestBody.enabled
          resource_type: requestBody.resourceType
          resource_id: requestBody.resourceId
          advertiser_id: path.advertiserId
          agent_ids: requestBody.adcpAgentIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiserId}/syndication-status'].get
  update:
    x-apievangelist-phrasing:
      intent: See what an advertiser is syndicating
      effect: read
      questions:
      - Which of my audiences and catalogs are currently syndicated to agents?
      - Can I filter syndication records by agent or by enabled state?
      instructions:
      - text: Show syndication status for advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiserId
      - text: List what advertiser {advertiser_id} syndicates to agent {agent_id}.
        slots:
          advertiser_id: path.advertiserId
          agent_id: query.adcpAgentId
      method: generated
      generated: '2026-10-01'