Canva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canva Connect Design Import API

5 actions 5 updates phrasing extends openapi/canva-design-import-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/imports'].post
$.paths['/v1/imports/{jobId}'].get
$.paths['/v1/url-imports'].post
$.paths['/v1/url-imports/{jobId}'].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 Design Import API
  version: 1.0.0
extends: openapi/canva-design-import-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/imports'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an uploaded file as a design
      effect: write
      questions:
      - How do I turn a PDF or PowerPoint file into an editable Canva design?
      - Where does the title of an imported file go when I send raw bytes?
      instructions:
      - text: Import the attached file as a new design with metadata {metadata}.
        slots:
          metadata: header.Import-Metadata
      - text: Start a design import for this file using import metadata {metadata}.
        slots:
          metadata: header.Import-Metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/imports/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a file import job
      effect: read
      questions:
      - Has my uploaded file finished importing as a design?
      - How do I get the new design from a file import job?
      instructions:
      - text: Check file import job {jobId}.
        slots:
          jobId: path.jobId
      - text: Get the designs created by import job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/url-imports'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a file from a URL as a design
      effect: write
      questions:
      - Can Canva import a presentation from a link instead of an upload?
      - Do I have to tell it the file's MIME type when importing from a URL?
      instructions:
      - text: Import {url} as a new design titled {title}.
        slots:
          url: requestBody.url
          title: requestBody.title
      - text: Import the {mime_type} file at {url} as design {title}.
        slots:
          mime_type: requestBody.mime_type
          url: requestBody.url
          title: requestBody.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/url-imports/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a URL import job
      effect: read
      questions:
      - Is my import from a URL done yet?
      - What does a URL import job return when it fails?
      instructions:
      - text: Check URL import job {jobId}.
        slots:
          jobId: path.jobId
      - text: Get the design created by URL import job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'