Canva · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canva Connect Assets API

5 actions 5 updates phrasing extends openapi/canva-assets-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['/assets/{assetId}'].get
$.paths['/assets/{assetId}'].delete
$.paths['/asset-uploads'].post
$.paths['/asset-uploads/{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 Assets API
  version: 1.0.0
extends: openapi/canva-assets-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['/assets/{assetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an asset's details
      effect: read
      questions:
      - What is the import status and owner of one of my assets?
      - How do I fetch the type, tags and thumbnail for an asset?
      instructions:
      - text: Get the details of asset {assetId}.
        slots:
          assetId: path.assetId
      - text: Show the owner and import status of asset {assetId}.
        slots:
          assetId: path.assetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/{assetId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an asset
      effect: destructive
      questions:
      - Can I delete an image I uploaded to my Canva account?
      - How do I remove an unwanted asset from my account?
      instructions:
      - text: Delete asset {assetId} from my account.
        slots:
          assetId: path.assetId
      - text: Remove asset {assetId}.
        slots:
          assetId: path.assetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/asset-uploads'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an image or video asset
      effect: write
      questions:
      - How do I upload an image or video to my Canva account?
      - Does the asset name need to be Base64-encoded in the upload header?
      instructions:
      - text: Upload the attached image using metadata {metadata}.
        slots:
          metadata: header.Asset-Upload-Metadata
      - text: Upload this video to my Canva account with upload metadata {metadata}.
        slots:
          metadata: header.Asset-Upload-Metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/asset-uploads/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an asset upload job
      effect: read
      questions:
      - Is my image upload done, and what asset did it create?
      - How can I tell whether an asset upload job has completed?
      instructions:
      - text: Check upload job {jobId}.
        slots:
          jobId: path.jobId
      - text: Get the asset created by upload job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'