Canva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canva Connect Designs API

4 actions 4 updates phrasing extends openapi/canva-designs-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['/designs'].get
$.paths['/designs'].post
$.paths['/designs/{designId}'].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 Designs API
  version: 1.0.0
extends: openapi/canva-designs-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['/designs'].get
  update:
    x-apievangelist-phrasing:
      intent: List designs I can access
      effect: read
      questions:
      - What designs can I access in Canva?
      - Can I search my designs and page through the results?
      - How do I sort the design list by relevance or modification date?
      instructions:
      - text: Show all my designs.
      - text: Find designs matching {query}.
        slots:
          query: query.query
      - text: List {limit} designs sorted by {sort_by}.
        slots:
          limit: query.limit
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/designs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a design
      effect: write
      questions:
      - How do I create a new doc, whiteboard or presentation?
      - Can I insert an asset and set a title when creating a design?
      instructions:
      - text: Create a new {design_type} design.
        slots:
          design_type: requestBody.design_type
      - text: Create a {design_type} titled {title} with asset {asset_id}.
        slots:
          design_type: requestBody.design_type
          title: requestBody.title
          asset_id: requestBody.asset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/designs/{designId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a design
      effect: read
      questions:
      - How many pages does a design have and when was it updated?
      - How do I get a design's title and URLs by its ID?
      instructions:
      - text: Get design {designId}.
        slots:
          designId: path.designId
      - text: Show the page count and timestamps for design {designId}.
        slots:
          designId: path.designId
      method: generated
      generated: '2026-09-26'