> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Canva

> Canva offers a drag-and-drop design suite for creating social media graphics, presentations, and marketing materials with prebuilt templates and a vast element library

Canva offers a drag-and-drop design suite for creating social media graphics, presentations, and marketing materials with prebuilt templates and a vast element library

`canva` · **48 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth canva
run auth canva --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run canva          # common commands
run canva --all    # every command
```

```ts theme={"theme":"github-dark"}
import { canva } from "@boxd/run";
```

## Common tools

| Tool                                           | What it does                                                                                                                                                            |
| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `create-asset-upload-job`                      | Uploads an asset file to the user's Canva content library. This endpoint initiates an asynchronous upload job for images, videos, audio files, PDFs, or fonts.          |
| `create-design-export-job`                     | DEPRECATED: Use CANVA\_POST\_EXPORTS instead. Exports a Canva design to various file formats.                                                                           |
| `create-design-with-optional-asset`            | DEPRECATED: Use CANVA\_POST\_DESIGNS instead. Creates a new Canva design with specified dimensions or from an asset.                                                    |
| `create-design-comment-in-preview-api`         | Creates a new comment thread on a Canva design. This preview API allows adding text comments to designs for collaboration and feedback.                                 |
| `create-design-import-job`                     | Imports an external file as a new Canva design. This endpoint converts documents (PDF, Word, PowerPoint, Excel) and design files (PSD, AI) into editable Canva designs. |
| `create-design-resize-job`                     | Creates a resized copy of an existing design (Canva Pro/Enterprise only).                                                                                               |
| `create-url-asset-upload-job`                  | Tool to create an asynchronous Canva asset import job from a public URL.                                                                                                |
| `fetch-asset-upload-job-status`                | Polls for asset upload job completion status. Use this after CANVA\_CREATE\_ASSET\_UPLOAD\_JOB to check the upload progress.                                            |
| `fetch-current-user-details`                   | Returns the User ID, Team ID, and display name of the user account associated with the provided access token.                                                           |
| `fetch-design-metadata-and-access-information` | Gets the metadata for a design. This includes owner information, URLs for editing and viewing, and thumbnail information.                                               |
| `get-design-export-job-result`                 | Polls for design export job completion status. Use this after CANVA\_CREATE\_DESIGN\_EXPORT\_JOB to check the export progress.                                          |
| `get-designs-designid-export-formats`          | Lists available file formats for exporting a design. Use this to check which export formats (PDF, JPG, PNG, SVG, PPTX, GIF, MP4) are supported for a specific design.   |
| `get-url-asset-uploads-jobid`                  | Tool to retrieve the status and result of a URL-based asset upload job.                                                                                                 |
| `get-url-imports-jobid`                        | Polls for URL import job completion status. Use this after creating a URL import job to check the import progress.                                                      |
| `get-users-me-capabilities`                    | Lists the API capabilities for the user account associated with the provided access token.                                                                              |
| `list-user-designs`                            | Provides a summary of Canva user designs, includes search filtering, and allows showing both self-created and shared designs with sorting options.                      |
| `post-designs`                                 | Creates a new Canva design with preset type or custom dimensions.                                                                                                       |
| `post-exports`                                 | Starts a new asynchronous job to export a Canva design file.                                                                                                            |
| `post-folders`                                 | Tool to create a folder in Canva. Use when you need to organize designs, assets, or create nested folder structures in a user's projects or uploads folder.             |
| `post-url-imports`                             | Tool to start an asynchronous job to import an external file from a URL as a new design in Canva.                                                                       |
| `retrieve-asset-metadata-by-id`                | You can retrieve the metadata of an asset by specifying its `assetId`.                                                                                                  |
| `retrieve-design-import-job-status`            | Polls for design import job completion status. Use this after CANVA\_CREATE\_DESIGN\_IMPORT\_JOB to check the import progress.                                          |
| `retrieve-design-resize-job-status`            | Retrieves the status and results of a design resize job. Polls for design resize job completion status.                                                                 |

<Accordion title="All 48 tools" icon="list">
  | Tool                                              | What it does                                                                                                                                                            |
  | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `access-user-specific-brand-templates-list`       | Lists brand templates available to the user (Canva Enterprise only).                                                                                                    |
  | `create-asset-upload-job`                         | Uploads an asset file to the user's Canva content library. This endpoint initiates an asynchronous upload job for images, videos, audio files, PDFs, or fonts.          |
  | `create-design-export-job`                        | DEPRECATED: Use CANVA\_POST\_EXPORTS instead. Exports a Canva design to various file formats.                                                                           |
  | `create-design-with-optional-asset`               | DEPRECATED: Use CANVA\_POST\_DESIGNS instead. Creates a new Canva design with specified dimensions or from an asset.                                                    |
  | `create-comment-reply-in-design`                  | This preview API allows replying to comments within a design on Canva, with a limit of 100 replies per comment.                                                         |
  | `create-design-comment-in-preview-api`            | Creates a new comment thread on a Canva design. This preview API allows adding text comments to designs for collaboration and feedback.                                 |
  | `create-design-import-job`                        | Imports an external file as a new Canva design. This endpoint converts documents (PDF, Word, PowerPoint, Excel) and design files (PSD, AI) into editable Canva designs. |
  | `create-design-resize-job`                        | Creates a resized copy of an existing design (Canva Pro/Enterprise only).                                                                                               |
  | `create-url-asset-upload-job`                     | Tool to create an asynchronous Canva asset import job from a public URL.                                                                                                |
  | `delete-asset-by-id`                              | You can delete an asset by specifying its `assetId`. This operation mirrors the behavior in the Canva UI.                                                               |
  | `exchange-oauth20-access-or-refresh-token`        | The OAuth 2.0 endpoint issues time-limited (4-hour) access tokens of up to 4KB for user authorization via codes or refresh tokens.                                      |
  | `fetch-asset-upload-job-status`                   | Polls for asset upload job completion status. Use this after CANVA\_CREATE\_ASSET\_UPLOAD\_JOB to check the upload progress.                                            |
  | `fetch-connect-signing-public-keys`               | The API for verifying Canva webhooks, 'connect/keys,' is in preview, meaning unstable, not for public integrations, and provides a rotating JWK for...                  |
  | `fetch-current-user-details`                      | Returns the User ID, Team ID, and display name of the user account associated with the provided access token.                                                           |
  | `fetch-design-metadata-and-access-information`    | Gets the metadata for a design. This includes owner information, URLs for editing and viewing, and thumbnail information.                                               |
  | `get-design-comment-replies`                      | Retrieves a list of replies for a comment or suggestion thread on a design.                                                                                             |
  | `get-design-comment-reply`                        | Retrieves a specific reply to a comment or suggestion thread on a design.                                                                                               |
  | `get-design-export-job-result`                    | Polls for design export job completion status. Use this after CANVA\_CREATE\_DESIGN\_EXPORT\_JOB to check the export progress.                                          |
  | `get-designs-designid-comments-threadid`          | Retrieves metadata for a comment or suggestion thread on a design.                                                                                                      |
  | `get-designs-designid-export-formats`             | Lists available file formats for exporting a design. Use this to check which export formats (PDF, JPG, PNG, SVG, PPTX, GIF, MP4) are supported for a specific design.   |
  | `get-url-asset-uploads-jobid`                     | Tool to retrieve the status and result of a URL-based asset upload job.                                                                                                 |
  | `get-url-imports-jobid`                           | Polls for URL import job completion status. Use this after creating a URL import job to check the import progress.                                                      |
  | `get-users-me-capabilities`                       | Lists the API capabilities for the user account associated with the provided access token.                                                                              |
  | `initiate-design-autofill-job`                    | Upcoming brand template ID updates require migration within 6 months.                                                                                                   |
  | `list-design-pages-with-pagination`               | Preview API for Canva: subject to unannounced changes and not for public integrations.                                                                                  |
  | `list-folder-items-by-type-with-sorting`          | Lists the items in a folder, including each item's `type`. Folders can contain: - Other folders. - Designs, such as Instagram posts, Presentations...                   |
  | `list-user-designs`                               | Provides a summary of Canva user designs, includes search filtering, and allows showing both self-created and shared designs with sorting options.                      |
  | `move-item-to-specified-folder`                   | Transfers an item to a different folder by specifying both the destination folder's ID and the item's ID.                                                               |
  | `post-designs`                                    | Creates a new Canva design with preset type or custom dimensions.                                                                                                       |
  | `post-designs-designid-comments`                  | Creates a comment thread on a Canva design. Use when you need to add feedback or collaboration comments to a specific design.                                           |
  | `post-designs-designid-comments-threadid-replies` | Tool to create a reply to a comment or suggestion thread on a Canva design.                                                                                             |
  | `post-exports`                                    | Starts a new asynchronous job to export a Canva design file.                                                                                                            |
  | `post-folders`                                    | Tool to create a folder in Canva. Use when you need to organize designs, assets, or create nested folder structures in a user's projects or uploads folder.             |
  | `post-url-imports`                                | Tool to start an asynchronous job to import an external file from a URL as a new design in Canva.                                                                       |
  | `remove-folder-and-move-contents-to-trash`        | Deletes a folder by moving the user's content to Trash and reassigning other users' content to their top-level projects.                                                |
  | `retrieve-app-public-key-set`                     | Returns the Json Web Key Set (public keys) of an app. These keys are used to verify JWTs sent to app backends.                                                          |
  | `retrieve-asset-metadata-by-id`                   | You can retrieve the metadata of an asset by specifying its `assetId`.                                                                                                  |
  | `retrieve-brand-template-dataset-definition`      | Canva's brand template IDs will change later this year, including a 6-month integration migration.                                                                      |
  | `retrieve-enterprise-brand-template-metadata`     | Upcoming update will change brand template IDs; integrations must migrate within 6 months.                                                                              |
  | `retrieve-design-autofill-job-status`             | API users with Canva Enterprise membership can retrieve design autofill job results, potentially requiring multiple requests until a `success` or...                    |
  | `retrieve-design-import-job-status`               | Polls for design import job completion status. Use this after CANVA\_CREATE\_DESIGN\_IMPORT\_JOB to check the import progress.                                          |
  | `retrieve-design-resize-job-status`               | Retrieves the status and results of a design resize job. Polls for design resize job completion status.                                                                 |
  | `retrieve-folder-details-by-id`                   | Gets the name and other details of a folder using a folder's `folderID`.                                                                                                |
  | `retrieve-user-profile-data`                      | Currently, this returns the display name of the user account associated with the provided access token.                                                                 |
  | `revoke-oauth-tokens`                             | Revoke a refresh token to end its lineage and user consent, requiring re-authentication.                                                                                |
  | `update-asset-s-name-and-tags-by-id`              | You can update the name and tags of an asset by specifying its `assetId`.                                                                                               |
  | `update-folder-details-by-id`                     | Updates a folder's details using its `folderID`. Currently, you can only update a folder's name.                                                                        |
  | `validate-oauth-token-properties`                 | Check an access token's validity and properties via introspection, requiring authentication.                                                                            |
</Accordion>

[Open Canva in the console →](https://app.boxd.sh/integrations/detail/canva)
