Canva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canva Connect Brand Template API

5 actions 5 updates phrasing extends openapi/canva-brand-template-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 5

$.info
$.paths['/v1/brand-templates'].get
$.paths['/v1/brand-templates'].post
$.paths['/v1/brand-templates/{brandTemplateId}'].get
$.paths['/v1/brand-templates/{brandTemplateId}/dataset'].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 Canva Connect Brand Template API
  version: 1.0.0
extends: openapi/canva-brand-template-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: 4
- target: $.paths['/v1/brand-templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List brand templates
      effect: read
      questions:
      - Which brand templates does my team have?
      - Can I search brand templates by name and only show ones with autofill datasets?
      - How do I sort brand templates by when they were last modified?
      instructions:
      - text: List our brand templates.
      - text: Search brand templates for {query}.
        slots:
          query: query.query
      - text: List brand templates owned by {ownership}, sorted by {sort_by}.
        slots:
          ownership: query.ownership
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a design as a brand template
      effect: write
      questions:
      - How do I turn one of my designs into a brand template?
      - What role do I need to publish a brand template?
      instructions:
      - text: Publish design {design_id} as a brand template.
        slots:
          design_id: requestBody.design_id
      - text: Make design {design_id} available to the team as a brand template.
        slots:
          design_id: requestBody.design_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-templates/{brandTemplateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand template
      effect: read
      questions:
      - How do I look up a single brand template's title and URLs?
      - What metadata is available for a specific brand template?
      instructions:
      - text: Get brand template {brandTemplateId}.
        slots:
          brandTemplateId: path.brandTemplateId
      - text: Show the details of brand template {brandTemplateId}.
        slots:
          brandTemplateId: path.brandTemplateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/brand-templates/{brandTemplateId}/dataset'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand template's autofill fields
      effect: read
      questions:
      - What data fields does a brand template expect for autofill?
      - Which fields in a template take an image versus text or a chart?
      instructions:
      - text: List the autofill fields of brand template {brandTemplateId}.
        slots:
          brandTemplateId: path.brandTemplateId
      - text: Show the dataset definition for brand template {brandTemplateId}.
        slots:
          brandTemplateId: path.brandTemplateId
      method: generated
      generated: '2026-09-26'