Canva

Visão geral

O Canva é uma plataforma de design gráfico drag-and-drop que oferece templates prontos, uma vasta biblioteca de elementos e ferramentas para criar peças de redes sociais, apresentações e materiais de marketing. Com a integração Canva no SquadOS, seus agentes podem criar designs, importar e exportar arquivos, gerenciar pastas e assets, adicionar comentários e acionar fluxos de autofill em templates empresariais — tudo de forma programática.

• Site oficial: https://www.canva.com/
• Documentação na Composio: docs.composio.dev/toolkits/canva

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
client_id	Sim	ID único da sua integração Canva, obtido na aba Credentials do portal do desenvolvedor.
client_secret	Sim	Segredo da sua integração Canva. Começa com cnvca.

Como obter a credencial

1. Acesse o Portal do Desenvolvedor Canva e faça login.
2. Navegue até Your Integrations e clique em Create an integration.
3. Escolha o tipo de integração: pública (acessível a todos os usuários Canva após aprovação) ou privada (requer plano Canva Enterprise).
4. Na aba Configuration da integração criada, vá em Credentials para obter o Client ID e o Client Secret.
5. Na aba Authentication, em Authorized Redirects, adicione a URI: https://backend.composio.dev/api/v3/toolkits/auth/callback.
6. (Opcional) Configure os escopos necessários na aba Scopes e submeta para revisão.
7. No painel da Composio, clique em Create Auth Config, selecione Canva com OAuth 2.0 e cole o Client ID e o Client Secret.
8. Clique em Create Canva Auth Config e copie o ID gerado (começa com ac_) para usar no seu código.

Dica

Use as credenciais de uma integração dedicada para o SquadOS. O Canva permite revogar integrações individualmente sem afetar outras configurações. Para acesso Enterprise (templates de marca, autofill), certifique-se de que sua conta possui o plano adequado.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Canva.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth 2.0.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Perguntas frequentes

Como configurar credenciais OAuth personalizadas para o Canva?

Para um guia passo a passo sobre como criar e configurar suas próprias credenciais OAuth do Canva na Composio, consulte Como criar credenciais OAuth para o Canva.

Ações disponíveis

Listar brand templates do usuário

CANVA_ACCESS_USER_SPECIFIC_BRAND_TEMPLATES_LIST

Lista os brand templates disponíveis para o usuário (exclusivo Canva Enterprise). Recupera todos os brand templates acessíveis ao usuário. Brand templates são layouts pré-desenhados com campos de dados variáveis que podem ser preenchidos programaticamente via API de autofill. Retorna metadados dos templates, incluindo IDs, nomes e esquemas de dataset.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Não	Permite pesquisar os brand templates disponíveis ao usuário usando um ou mais termos de busca.
dataset	string	Não	Filtra a lista de brand templates com base nas definições de dataset. Pode ser any (padrão, com e sem dataset) ou non_empty (apenas templates com campos de dados definidos).
sort_by	string	Não	Ordena a lista de brand templates. Opções: relevance (padrão), modified_descending, modified_ascending, title_descending, title_ascending.
ownership	string	Não	Filtra com base na propriedade do usuário. Opções: any (padrão), owned (próprios), shared (compartilhados).
continuation	string	Não	Token de paginação retornado por uma resposta anterior. Use para recuperar mais templates da lista.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar job de upload de asset

CANVA_CREATE_ASSET_UPLOAD_JOB

Faz o upload de um arquivo de asset para a biblioteca de conteúdo do usuário no Canva. Inicia um job assíncrono de upload para imagens, vídeos, áudios, PDFs ou fontes. Retorna um ID de job para acompanhar o progresso. Após a conclusão, o asset pode ser usado em designs. Esta é uma operação assíncrona — use CANVA_FETCH_ASSET_UPLOAD_JOB_STATUS para verificar o status.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
file	object	Sim	Arquivo a fazer upload. Limites: imagens 50 MB, vídeos 100 MB, áudio 10 MB. Formatos suportados: JPEG/PNG/GIF/WebP/SVG, MP4/MOV/AVI, MP3/WAV, PDF, fontes TTF/OTF.
name	string	Sim	Nome de exibição do asset (máx. 50 caracteres). Usado para buscas no Canva.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar job de exportação de design Canva (Obsoleto)

CANVA_CREATE_CANVA_DESIGN_EXPORT_JOB

OBSOLETO: Use CANVA_POST_EXPORTS em seu lugar. Exporta um design Canva para vários formatos de arquivo. Inicia um job assíncrono de exportação. Suporta imagens (PNG, JPG, GIF), documentos (PDF, PPTX) e vídeo (MP4). Use CANVA_GET_DESIGN_EXPORT_JOB_RESULT para verificar o status até a conclusão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
format	string	Sim	Configuração do formato de exportação. Defina type como um dos seguintes: png, jpg, pdf, gif, mp4, pptx.
design_id	string	Sim	ID do design a exportar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar design Canva com asset opcional (Obsoleto)

CANVA_CREATE_CANVA_DESIGN_WITH_OPTIONAL_ASSET

OBSOLETO: Use CANVA_POST_DESIGNS em seu lugar. Cria um novo design Canva com dimensões especificadas ou a partir de um asset. Retorna o ID do design, URLs de edição e visualização, informações do proprietário e metadados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
title	string	Não	Título do design (1–255 caracteres). Aparece na UI do Canva e nas listas de designs.
asset_id	string	Não	ID de asset de imagem para criar o design. Apenas assets de imagem são suportados — assets de vídeo e PDF serão rejeitados.
design_type	object	Não	Configuração das dimensões do design. Obrigatório se asset_id não for fornecido. Exemplos: preset {'type': 'preset', 'name': 'presentation'} ou dimensões personalizadas {'type': 'custom', 'width': 1080, 'height': 1920}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar resposta a comentário em design

CANVA_CREATE_COMMENT_REPLY_IN_DESIGN

Esta API de pré-visualização permite responder a comentários em um design no Canva, com limite de 100 respostas por comentário. APIs de pré-visualização estão sujeitas a alterações sem aviso prévio e não são elegíveis para integrações públicas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
message	string	Sim	Mensagem de resposta ao comentário. Você pode mencionar usuários usando o formato [user_id:team_id].
commentId	string	Sim	ID do thread de comentário ao qual responder. Usado no caminho da URL.
attached_to	object	Sim	O objeto ao qual o comentário está vinculado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar comentário em design via API de pré-visualização

CANVA_CREATE_DESIGN_COMMENT_IN_PREVIEW_API

Cria um novo thread de comentário em um design Canva. Esta API de pré-visualização permite adicionar comentários de texto a designs para colaboração e feedback. Retorna o comentário criado com ID, informações do autor e timestamp.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
message	string	Sim	Texto do comentário (máx. 4096 caracteres). Mencione usuários com [user_id:team_id]. Sem suporte a markdown.
design_id	string	Sim	ID do design ao qual vincular o comentário.
assignee_id	string	Não	ID do usuário ao qual atribuir este comentário. Se fornecido, o usuário também deve ser mencionado no texto da mensagem.
attached_to	object	Sim	Referência obrigatória especificando onde o comentário deve ser vinculado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar job de importação de design

CANVA_CREATE_DESIGN_IMPORT_JOB

Importa um arquivo externo como novo design Canva. Converte documentos (PDF, Word, PowerPoint, Excel) e arquivos de design (PSD, AI) em designs Canva editáveis. A importação é assíncrona — use CANVA_RETRIEVE_DESIGN_IMPORT_JOB_STATUS para verificar o status até obter success ou failed.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
file	object	Sim	Documento ou arquivo de design a importar (máx. 100 MB). Formatos: PDF, Word, PowerPoint, Excel, Photoshop, Illustrator, Keynote, Pages, Numbers, OpenDocument. Arquivos protegidos por senha falharão.
title	string	Sim	Título para o design importado (máx. 50 caracteres). Aparece na UI do Canva.
mime_type	string	Não	Tipo MIME do arquivo. Se omitido, o tipo do arquivo é detectado automaticamente.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar job de redimensionamento de design

CANVA_CREATE_DESIGN_RESIZE_JOB

Cria uma cópia redimensionada de um design existente (exclusivo Canva Pro/Enterprise). A operação de redimensionamento é assíncrona e preserva o conteúdo na medida do possível. Use CANVA_RETRIEVE_DESIGN_RESIZE_JOB_STATUS para verificar o status até a conclusão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
design_id	string	Sim	ID do design de origem.
design_type	string	Sim	Configuração do tipo de design de destino.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar job de upload de asset via URL

CANVA_CREATE_URL_ASSET_UPLOAD_JOB

Cria um job assíncrono de importação de asset a partir de uma URL pública. Use quando precisar importar um asset para o Canva diretamente de uma URL acessível publicamente, sem necessidade de upload S3.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
url	string	Sim	URL HTTPS pública do arquivo a importar. Deve usar protocolo HTTPS.
name	string	Sim	Nome do asset (1–255 caracteres).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir asset por ID

CANVA_DELETE_ASSET_BY_ID

Exclui um asset especificando seu assetId. Esta operação espelha o comportamento da UI do Canva — excluir um item o move para a lixeira. Excluir um asset não o remove dos designs que já o utilizam.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
assetId	string	Sim	ID do asset.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Trocar token de acesso ou atualização OAuth 2.0

CANVA_EXCHANGE_OAUTH20_ACCESS_OR_REFRESH_TOKEN

O endpoint OAuth 2.0 emite tokens de acesso com validade de 4 horas e tamanho máximo de 4 KB para autorização de usuários via códigos ou tokens de atualização. Requer client ID e secret para autenticação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Verificar status do job de upload de asset

CANVA_FETCH_ASSET_UPLOAD_JOB_STATUS

Verifica o status de um job de upload de asset. Use após CANVA_CREATE_ASSET_UPLOAD_JOB para acompanhar o progresso. Chame repetidamente até receber success ou failed. Esta ação é exclusiva para jobs de upload direto — não use para jobs de importação via URL (use CANVA_GET_URL_ASSET_UPLOADS_JOBID nesses casos).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
jobId	string	Sim	ID do job de upload de asset retornado por CANVA_CREATE_ASSET_UPLOAD_JOB.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar chaves públicas de assinatura do Canva Connect

CANVA_FETCH_CANVA_CONNECT_SIGNING_PUBLIC_KEYS

API de pré-visualização para verificação de webhooks do Canva. Retorna um JWK rotativo para verificação de assinatura, impedindo ataques de replay. Faça cache das chaves para maior eficiência.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar detalhes do usuário atual

CANVA_FETCH_CURRENT_USER_DETAILS

Retorna o ID do usuário, ID do time e nome de exibição da conta associada ao token de acesso fornecido.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar metadados e informações de acesso do design

CANVA_FETCH_DESIGN_METADATA_AND_ACCESS_INFORMATION

Obtém os metadados de um design, incluindo informações do proprietário, URLs de edição e visualização, e informações de thumbnail.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
designId	string	Sim	ID do design.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter respostas de thread de comentário do design

CANVA_GET_DESIGN_COMMENT_REPLIES

Recupera a lista de respostas de um thread de comentário ou sugestão em um design. Use quando precisar visualizar todas as respostas de um thread específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número de respostas a retornar. Padrão: 50. Mínimo: 1, Máximo: 100.
designId	string	Sim	ID do design.
threadId	string	Sim	ID do thread.
continuation	string	Não	Token de paginação para recuperar mais itens da lista.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter resposta específica de comentário do design

CANVA_GET_DESIGN_COMMENT_REPLY

Recupera uma resposta específica de um thread de comentário ou sugestão em um design. Use quando precisar visualizar detalhes de uma resposta específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
replyId	string	Sim	Identificador da resposta específica.
designId	string	Sim	Identificador do design.
threadId	string	Sim	Identificador do thread de comentário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter resultado do job de exportação de design

CANVA_GET_DESIGN_EXPORT_JOB_RESULT

Verifica o status de um job de exportação de design. Use após CANVA_CREATE_CANVA_DESIGN_EXPORT_JOB para acompanhar o progresso. Chame repetidamente até a conclusão para receber os links de download das páginas exportadas. As URLs de download expiram em 30 dias.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
exportId	string	Sim	ID do job de exportação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter thread de comentário do design

CANVA_GET_DESIGNS_DESIGNID_COMMENTS_THREADID

Recupera os metadados de um thread de comentário ou sugestão em um design, incluindo conteúdo, autor, timestamps e status.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
designId	string	Sim	Identificador do design.
threadId	string	Sim	Identificador do thread.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter formatos de exportação do design

CANVA_GET_DESIGNS_DESIGNID_EXPORT_FORMATS

Lista os formatos de arquivo disponíveis para exportar um design. Use para verificar quais formatos (PDF, JPG, PNG, SVG, PPTX, GIF, MP4) são suportados para um design específico antes de iniciar a exportação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
designId	string	Sim	ID do design.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter status do job de upload de asset via URL

CANVA_GET_URL_ASSET_UPLOADS_JOBID

Recupera o status e o resultado de um job de upload de asset via URL. Use após criar um job de upload de asset via URL para verificar o progresso e obter o ID do asset quando bem-sucedido.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
jobId	string	Sim	Identificador do job de upload de asset.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter status do job de importação via URL

CANVA_GET_URL_IMPORTS_JOBID

Verifica o status de um job de importação via URL. Use após criar um job de importação via URL para acompanhar o progresso. Chame repetidamente até receber success ou failed para obter o ID do design importado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
jobId	string	Sim	ID do job de importação via URL.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter capacidades do usuário

CANVA_GET_USERS_ME_CAPABILITIES

Lista as capacidades da API para a conta associada ao token de acesso fornecido. Use para verificar quais recursos estão disponíveis com base no plano Canva do usuário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Iniciar job de autofill de design Canva

CANVA_INITIATE_CANVA_DESIGN_AUTOFILL_JOB

Inicia um job de autofill de design para usuários Canva Enterprise. Preenche automaticamente campos de dados do template com texto, imagens ou dados de gráficos. Monitore o job com CANVA_RETRIEVE_DESIGN_AUTOFILL_JOB_STATUS.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
data	object	Sim	Objeto de dados contendo os campos e valores para autofill. As chaves são nomes de campos do brand template. Os valores devem ser TextDataField (type=‘text’), ImageDataField (type=‘image’) ou ChartDataField (type=‘chart’).
title	string	Não	Título para o design preenchido automaticamente. Máx. 255 caracteres. Se não fornecido, usa o título do brand template.
brand_template_id	string	Sim	ID do brand template de entrada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar páginas do design com paginação

CANVA_LIST_DESIGN_PAGES_WITH_PAGINATION

API de pré-visualização do Canva: sujeita a alterações sem aviso. Lista metadados das páginas de um design com offset e limit opcionais. Não aplicável a todos os tipos de design.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número de páginas a retornar. Padrão: 50. Mínimo: 1, Máximo: 200.
offset	integer	Não	Índice da página inicial (base 1). Padrão: 1. Mínimo: 1, Máximo: 500.
designId	string	Sim	ID do design.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar itens de pasta por tipo com ordenação

CANVA_LIST_FOLDER_ITEMS_BY_TYPE_WITH_SORTING

Lista os itens de uma pasta, incluindo o type de cada item. As pastas podem conter outras pastas, designs (posts do Instagram, apresentações, documentos) e assets de imagem.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
sort_by	string	Não	Ordena a lista de itens da pasta. Opções: created_ascending, created_descending, modified_ascending, modified_descending (padrão), title_ascending, title_descending.
folderId	string	Sim	ID da pasta. Use root para listar itens na pasta raiz.
item_types	array	Não	Filtra itens pelos tipos especificados. Tipos disponíveis: design, folder, image. Forneça como lista separada por vírgulas.
continuation	string	Não	Token de paginação para recuperar mais itens da lista.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar designs do usuário

CANVA_LIST_USER_DESIGNS

Fornece um resumo dos designs Canva do usuário, incluindo filtragem por busca e exibição de designs próprios e compartilhados com opções de ordenação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Não	Permite pesquisar designs do usuário e designs compartilhados com ele usando um ou mais termos.
sort_by	string	Não	Ordena a lista de designs. Opções: relevance (padrão), modified_descending, modified_ascending, title_descending, title_ascending.
ownership	string	Não	Filtra com base na propriedade. Opções: owned, shared, any.
continuation	string	Não	Token de paginação retornado por resposta anterior. Strings vazias não são aceitas pela API.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Mover item para pasta especificada

CANVA_MOVE_ITEM_TO_SPECIFIED_FOLDER

Transfere um item para uma pasta diferente especificando o ID da pasta de destino e o ID do item. Se o item estiver em várias pastas, ocorre um erro e a realocação manual via UI do Canva é necessária.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
item_id	string	Sim	ID do item a mover. IDs de design têm formato como DAFVztcvd9z, IDs de pasta como FAF2lZtloor e IDs de asset como Msd59349ff. Assets de vídeo não são suportados para mover.
to_folder_id	string	Sim	ID da pasta de destino. Use root para mover ao nível superior dos projetos ou uploads para a pasta Uploads.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar novo design Canva

CANVA_POST_DESIGNS

Cria um novo design Canva com tipo predefinido ou dimensões personalizadas. Use para criar designs de documentos, apresentações, whiteboards ou com dimensões específicas em pixels. Opcionalmente insere um asset de imagem no design. Retorna ID do design, URLs de edição/visualização e metadados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
title	string	Não	Nome do design (1–255 caracteres). Aparece na UI do Canva e nas listas de designs.
asset_id	string	Não	ID de asset de imagem a inserir no design. Atualmente suporta apenas assets de imagem.
design_type	string	Sim	Configuração do tipo de design. Pode ser um nome predefinido (doc, whiteboard, presentation) ou objeto com dimensões personalizadas, ex.: {'type': 'custom', 'width': 1080, 'height': 1920}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar comentário em design

CANVA_POST_DESIGNS_DESIGNID_COMMENTS

Cria um thread de comentário em um design Canva. Use para adicionar comentários de feedback ou colaboração a um design específico. Limitado a 100 requisições por minuto por usuário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
designId	string	Sim	ID do design onde o comentário será criado.
assignee_id	string	Não	ID de usuário para atribuição. Se especificado, o usuário deve ser mencionado na mensagem usando o formato [user_id:team_id].
message_plaintext	string	Sim	Mensagem do comentário em texto simples. Deve ter entre 1 e 2048 caracteres.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar resposta a thread de comentário

CANVA_POST_DESIGNS_DESIGNID_COMMENTS_THREADID_REPLIES

Cria uma resposta a um thread de comentário ou sugestão em um design Canva. Máximo de 100 respostas por thread.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
design_id	string	Sim	Identificador do design.
thread_id	string	Sim	Identificador do thread ao qual responder.
message_plaintext	string	Sim	Texto da resposta. Deve ter entre 1 e 2048 caracteres. Usuários podem ser mencionados com o formato [user_id:team_id].

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Iniciar job de exportação de design

CANVA_POST_EXPORTS

Inicia um novo job assíncrono para exportar um arquivo de design Canva. Use para exportar designs em vários formatos (PDF, JPG, PNG, GIF, PPTX, MP4). Retorna um ID de job para verificar o status e obter as URLs de download. Antes de exportar, use CANVA_GET_DESIGNS_DESIGNID_EXPORT_FORMATS para verificar os formatos suportados pelo design específico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
format	string	Sim	Configuração do formato de exportação. Nem todos os formatos são suportados por todos os tipos de design. Os arquivos exportados ficam disponíveis para download por 24 horas.
design_id	string	Sim	Identificador do design a exportar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar pasta

CANVA_POST_FOLDERS

Cria uma pasta no Canva. Use para organizar designs, assets ou criar estruturas de pastas aninhadas nos projetos ou na pasta de uploads do usuário.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome de exibição da nova pasta. Deve ter entre 1 e 255 caracteres. Nomes duplicados são permitidos.
parent_folder_id	string	Sim	ID da localização de destino. Use root para projetos de nível superior, uploads para a pasta de uploads, ou um ID de pasta específico para aninhar dentro de outra pasta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar job de importação via URL

CANVA_POST_URL_IMPORTS

Inicia um job assíncrono para importar um arquivo externo a partir de uma URL como novo design no Canva. Esta é uma operação assíncrona — verifique o status com o ID do job até atingir success ou failed.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
url	string	Sim	URL do arquivo a importar. Deve ser acessível pela internet e estar disponível publicamente (1–2048 caracteres).
title	string	Sim	Nome atribuído ao design importado (1–255 caracteres).
mime_type	string	Não	Identificador do tipo de arquivo. Detectado automaticamente se omitido.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Remover pasta e mover conteúdo para a lixeira

CANVA_REMOVE_FOLDER_AND_MOVE_CONTENTS_TO_TRASH

Exclui uma pasta movendo o conteúdo do usuário para a lixeira e reatribuindo o conteúdo de outros usuários para seus projetos de nível superior.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
folderId	string	Sim	ID da pasta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar conjunto de chaves públicas do app

CANVA_RETRIEVE_APP_PUBLIC_KEY_SET

Retorna o conjunto de chaves web JSON (chaves públicas) de um app. Essas chaves são usadas para verificar JWTs enviados aos backends do app.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
appId	string	Sim	ID do app.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar metadados de asset por ID

CANVA_RETRIEVE_ASSET_METADATA_BY_ID

Recupera os metadados de um asset especificando seu assetId.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
assetId	string	Sim	ID do asset.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar definição de dataset do brand template

CANVA_RETRIEVE_BRAND_TEMPLATE_DATASET_DEFINITION

Os IDs de brand template do Canva serão alterados no futuro, exigindo migração de integrações em 6 meses. O acesso via API requer assinatura Enterprise, fornecendo autofill para imagens, texto e gráficos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
brandTemplateId	string	Sim	ID do brand template.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar metadados de brand template Enterprise Canva

CANVA_RETRIEVE_CANVA_ENTERPRISE_BRAND_TEMPLATE_METADATA

Atualização futura alterará os IDs de brand templates; integrações devem migrar em 6 meses. O uso da API requer assinatura Canva Enterprise.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
brandTemplateId	string	Sim	ID do brand template.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar status do job de autofill de design

CANVA_RETRIEVE_DESIGN_AUTOFILL_JOB_STATUS

Usuários da API com assinatura Canva Enterprise podem recuperar os resultados do job de autofill de design. Pode ser necessário fazer múltiplas requisições até receber o status success ou failed.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
jobId	string	Sim	ID do job de autofill de design.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar status do job de importação de design

CANVA_RETRIEVE_DESIGN_IMPORT_JOB_STATUS

Verifica o status de conclusão de um job de importação de design. Use após CANVA_CREATE_DESIGN_IMPORT_JOB para verificar o progresso. Chame repetidamente até receber success ou failed para obter o ID e os metadados do design importado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
jobId	string	Sim	ID do job de importação de design.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar status do job de redimensionamento de design

CANVA_RETRIEVE_DESIGN_RESIZE_JOB_STATUS

Recupera o status e os resultados de um job de redimensionamento de design. Use após CANVA_CREATE_DESIGN_RESIZE_JOB para verificar o progresso. Continue verificando até o status ser success ou failed. Jobs bem-sucedidos incluem o novo ID de design e URLs de acesso temporárias.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
job_id	string	Sim	ID do job de redimensionamento retornado pelo endpoint de criação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar detalhes de pasta por ID

CANVA_RETRIEVE_FOLDER_DETAILS_BY_ID

Obtém o nome e outros detalhes de uma pasta usando seu folderID.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
folderId	string	Sim	ID da pasta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar dados do perfil do usuário

CANVA_RETRIEVE_USER_PROFILE_DATA

Atualmente retorna o nome de exibição da conta associada ao token de acesso fornecido. Mais informações de usuário são esperadas no futuro.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Revogar tokens OAuth

CANVA_REVOKE_OAUTH_TOKENS

Revoga um token de atualização para encerrar seu uso e o consentimento do usuário, exigindo nova autenticação. Autentique usando acesso básico com credenciais codificadas em Base64 ou parâmetros de corpo com client ID e secret.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
token	string	Sim	O token a revogar.
client_id	string	Não	ID único da sua integração para autenticar a requisição. Recomenda-se usar autenticação básica em vez de parâmetros de corpo.
client_secret	string	Não	Segredo da sua integração para autenticar a requisição. Começa com cnvca. Recomenda-se usar autenticação básica.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar nome e tags de asset por ID

CANVA_UPDATE_ASSET_S_NAME_AND_TAGS_BY_ID

Atualiza o nome e as tags de um asset especificando seu assetId. A atualização das tags substitui todas as tags existentes do asset.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Não	Nome do asset, exibido na UI do Canva. Máx. 50 caracteres. Se não definido, nada é atualizado.
tags	array	Não	Tags de substituição para o asset. Máx. 50 tags, cada uma com máx. 50 caracteres. Se não definido, nada é atualizado.
assetId	string	Sim	ID do asset.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar detalhes de pasta por ID

CANVA_UPDATE_FOLDER_DETAILS_BY_ID

Atualiza os detalhes de uma pasta usando seu folderID. Atualmente, apenas o nome da pasta pode ser atualizado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da pasta, como exibido na UI do Canva.
folderId	string	Sim	ID da pasta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Validar propriedades do token OAuth

CANVA_VALIDATE_OAUTH_TOKEN_PROPERTIES

Verifica a validade e as propriedades de um token de acesso via introspecção. Use autenticação básica (Base64 de client_id:client_secret) ou parâmetros de corpo para autenticação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
token	string	Sim	O token a introspectar.
client_id	string	Não	ID único da sua integração para autenticar a requisição. Recomenda-se usar autenticação básica.
client_secret	string	Não	Segredo da sua integração para autenticar a requisição. Começa com cnvca. Recomenda-se usar autenticação básica.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.