Créer un export de design avec l'API Canva
Lance l'export d'un design en PDF, JPG, PNG, PPTX ou GIF et renvoie le job avec son id. Appelez Get design export jusqu'à ce que status vale success : les urls des fichiers sont valables 24 heures. Chaque utilisateur peut exporter 75 fois toutes les 5 minutes et 500 fois par jour.
- Identifiant
- canva_create_design_export
L'appel
POST https://connect.reportei.com/api/tools/canva_create_design_export/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"design_id": "<design_id>",
"format": {}
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| design_id | string | Oui | Id of the design, from List designs, List folder items or Create design. |
| format | object | Oui | File format and its options. quality is required for jpg. size works only for pdf of a Canva doc; lossless, transparent_background and as_single_image only for png. |
Connexions possibles
Votre client connecte son compte Canva une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/canva, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/canva_create_design_export. Il devient la définition de tool de votre agent sans conversion.
Autres tools Canva
- Lister les designsGETListe les designs des projets de l'utilisateur et ceux partagés avec lui, avec id, title, thumbnail, page_count et les urls d'édition et de consultation. Quand la réponse contient continuation, passez-le en continuation pour lire la page suivante.
- Consulter un designGETRenvoie un design avec son titre, son propriétaire, sa miniature, page_count et les urls d'édition et de consultation. Ces urls sont temporaires et ne s'ouvrent que pour l'utilisateur connecté.
- Créer un designPOSTCrée un design et le renvoie avec son id et les urls d'édition et de consultation. Envoyez design_type, asset_id ou les deux. Un design vierge que personne ne modifie sous 7 jours est supprimé définitivement, sans passer par la corbeille.
- Lister les formats d'exportGETListe les formats vers lesquels un design peut être exporté, selon son type et ses pages. Un format avec page_numbers ne vaut que pour ces pages.
- Créer un export vidéo de designPOSTLance l'export d'un design en vidéo MP4 et renvoie le job avec son id. Appelez Get design export jusqu'à ce que status vale success : les urls des fichiers sont valables 24 heures. Chaque utilisateur peut exporter 75 fois toutes les 5 minutes et 500 fois par jour.
- Consulter un export de designGETRenvoie un job d'export : status in_progress, success ou failed et, avec success, les urls des fichiers, une par page selon le format, valables 24 heures. Rappelez-le, avec des attentes croissantes, tant que status vaut in_progress.
- Lister le contenu d'un dossierGETListe les dossiers, designs et images d'un dossier, chacun avec son type, l'objet dossier, design ou image et son id. Les vidéos ne sont pas listées. Quand la réponse contient continuation, passez-le en continuation pour lire la page suivante.
- Consulter un assetGETRenvoie un asset avec son nom, ses tags, sa miniature, son propriétaire et ses dates.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
