Pourquoi Codia expose des API
Les produits Codia transforment le contenu visuel en assets structurés et éditables. L'API existe pour les équipes qui veulent la même capacité dans leur propre produit, script de migration, workflow d'agent, système de QA ou pipeline d'automatisation du design.
La plateforme développeur repose sur une idée simple: les entrées visuelles doivent devenir des données structurées que le logiciel peut comprendre.
Visual Struct pour les images
L'endpoint image de Visual Struct convertit une capture d'écran UI ou un mockup en arbre JSON hiérarchique.
POST https://api.codia.ai/v1/open/image_to_designLa réponse inclut des éléments typés comme des en-têtes, boutons, cartes, tableaux, graphiques, icônes, texte et panneaux. Les nœuds incluent des bounding boxes, la configuration de layout, des métadonnées de confiance et des éléments enfants.
La documentation décrit trois formats de sortie:
jsonpour des pipelines aval personnaliséssvgpour un re-rendu vectoriel agnostique de l'outil de designfigmapour l'insertion dans un fichier Figma via un plugin ou un flux d'import
C'est l'API à utiliser lorsqu'une capture d'écran, un mockup UI ou une référence visuelle doit devenir lisible par machine.
PDF vers Visual Struct
Les PDF utilisent un endpoint lié:
POST https://api.codia.ai/v1/open/pdf_to_designL'endpoint convertit une page PDF en Visual Element Schema de Codia: une hiérarchie typée avec bounding boxes, configurations de layout, spécifications de style et éléments enfants. La même forme de schéma est partagée avec Visual Struct pour les images, afin que les consommateurs aval puissent prendre en charge images et PDF avec un seul modèle de traitement.
La documentation liste des usages courants comme les importateurs Figma, les générateurs de code, les pipelines de QA visuelle et les workflows de rendu.
Uploads et workflows de tâches
Pour les workflows qui ont besoin de traitement privé de fichiers ou de jobs longs, le contenu Open API existant décrit un schéma d'upload et de tâche:
- téléverser un fichier privé vers
/v1/open/uploads - recevoir un
upload_idopaque - créer une tâche via
/v1/open/tasks - recevoir des événements webhook ou interroger l'état de la tâche
- télécharger la sortie générée quand la tâche se termine
L'article sur les PDF de type NotebookLM vers PPTX éditable utilise ce schéma pour l'automatisation PDF vers PowerPoint côté serveur. La règle d'implémentation clé est que la clé API Codia reste sur votre serveur, pas dans le navigateur.
Ce que les développeurs construisent avec cela
L'API est utile lorsqu'une équipe a besoin d'une compréhension visuelle structurée dans un autre système:
- archivage et analyse concurrentielle des UI
- audits de design system
- QA visuelle automatisée et vérifications de régression
- flux d'import de screenshot vers Figma
- extraction PDF vers schéma
- prétraitement pour la génération de code
- workflows d'agents qui ont besoin d'une structure UI lisible par machine
- outils de migration par lot pour de grandes archives de design
La sortie n'est pas juste une capture avec des labels. C'est un arbre qui peut être filtré, transformé, rendu, importé ou transmis à un autre modèle.
Limites d'intégration
La documentation publique est claire sur quelques limites pratiques:
- les appels API nécessitent une authentification par bearer token.
- les vérifications de crédits ont lieu avant la lecture de certains uploads.
- la qualité de la sortie dépend de la clarté de la source et de la complexité du layout.
- les captures très hautes peuvent mieux fonctionner si elles sont découpées aux frontières de section.
- les nœuds à faible confiance devraient être filtrés avant l'utilisation en aval.
- les déploiements enterprise peuvent examiner la rétention, l'usage en production, des limites de débit plus élevées et les besoins de déploiement privé.
Ces limites font partie de l'expérience développeur. Une API fiable doit rendre ses compromis visibles.
Par où commencer
Commencez avec Visual Struct pour les captures et les mockups. Utilisez PDF to Visual Struct pour les PDF. Ouvrez la API Reference pour les schémas d'endpoint et les champs de requête et de réponse.