Canva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canva Connect Merge API

3 actions 3 updates phrasing extends openapi/canva-merge-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 3

$.info

$.paths['/v1/merges'].post

$.paths['/v1/merges/{jobId}'].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 Merge API
  version: 1.0.0
extends: openapi/canva-merge-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: 2
- target: $.paths['/v1/merges'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge design pages into a design
      effect: write
      questions:
      - How do I combine pages from several designs into one?
      - Can I insert, move or delete pages to produce a new design?
      instructions:
      - text: Start a merge job that combines these design pages into a new design.
      - text: Apply the page insert, move and delete operations I list to build a merged design.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/merges/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a design merge job
      effect: read
      questions:
      - Has my page merge finished?
      - What design does a completed merge job return?
      instructions:
      - text: Check merge job {jobId}.
        slots:
          jobId: path.jobId
      - text: Get the design created or updated by merge job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'