Canva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canva Connect Brand Templates API

4 actions 4 updates phrasing extends openapi/canva-brand-templates-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/brand-templates'].get

$.paths['/brand-templates/{brandTemplateId}'].get

$.paths['/brand-templates/{brandTemplateId}/dataset'].get

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 Canva Connect Brand Templates API
  version: 1.0.0
extends: openapi/canva-brand-templates-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/brand-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List brand templates
      effect: read
      questions:
      - What brand templates can I use in my Canva account?
      - Can I filter brand templates to only those that support autofill?
      - Is there a way to page through a long list of brand templates?
      instructions:
      - text: Show all my brand templates.
      - text: Find brand templates matching {query}.
        slots:
          query: query.query
      - text: List brand templates with dataset {dataset}.
        slots:
          dataset: query.dataset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/brand-templates/{brandTemplateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand template
      effect: read
      questions:
      - How do I get the metadata for one brand template?
      - Can I retrieve a single template's details by its ID?
      instructions:
      - text: Get brand template {brandTemplateId}.
        slots:
          brandTemplateId: path.brandTemplateId
      - text: Look up brand template {brandTemplateId}.
        slots:
          brandTemplateId: path.brandTemplateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/brand-templates/{brandTemplateId}/dataset'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand template's dataset
      effect: read
      questions:
      - Which fields can I autofill in a brand template?
      - What field types does a template dataset list?
      instructions:
      - text: Get the autofill dataset for brand template {brandTemplateId}.
        slots:
          brandTemplateId: path.brandTemplateId
      - text: List the data fields of brand template {brandTemplateId}.
        slots:
          brandTemplateId: path.brandTemplateId
      method: generated
      generated: '2026-09-26'