Зачем Codia открывает API
Продукты Codia превращают визуальный контент в структурированные, редактируемые assets. API нужен командам, которым такая же возможность нужна внутри собственного продукта, скрипта миграции, agent workflow, QA-системы или pipeline автоматизации дизайна.
Developer platform строится вокруг простой идеи: визуальные inputs должны становиться структурированными данными, о которых software может рассуждать.
Visual Struct для изображений
Image endpoint Visual Struct преобразует UI screenshot или mockup в иерархическое JSON-дерево.
POST https://api.codia.ai/v1/open/image_to_designОтвет включает типизированные элементы вроде headers, buttons, cards, tables, charts, icons, text и panels. Узлы содержат bounding box, layout config, confidence metadata и дочерние элементы.
В документации описаны три формата вывода:
jsonдля custom downstream pipelinessvgдля нейтрального к инструментам дизайна векторного rerenderfigmaдля вставки в файл Figma через plugin или flow импорта
Это API используют, когда screenshot, UI mockup или visual reference должны стать machine-readable.
PDF to Visual Struct
Для PDF используется связанный endpoint:
POST https://api.codia.ai/v1/open/pdf_to_designendpoint преобразует страницу PDF в Visual Element Schema Codia: типизированную иерархию с bounding box, layout configs, style specs и дочерними элементами. Та же shape schema используется вместе с image Visual Struct, поэтому downstream-потребители могут поддерживать и image, и PDF inputs через одну модель обработки.
В документации перечислены типичные сценарии: импортеры Figma, генераторы кода, pipeline visual QA и rendering workflows.
Загрузки и task workflows
Для workflows, которым нужна приватная обработка файлов или long-running jobs, существующий Open API content описывает паттерн загрузки и задач:
- загрузить private file в
/v1/open/uploads - получить
upload_id - создать task через
/v1/open/tasks - получать webhook events или опрашивать статус task
- скачать сгенерированный output после завершения task
Статья о PDF-to-editable PPTX в стиле NotebookLM использует этот паттерн для server-side автоматизации PDF-to-PowerPoint. Главное правило реализации: Codia API key остается на вашем сервере, а не в браузере.
Что на этом строят разработчики
API полезен, когда команде нужно структурированное визуальное понимание внутри другой системы:
- архивирование и анализ UI конкурентов
- audit design system
- автоматический visual QA и regression checks
- flow импорта screenshot в Figma
- извлечение schema из PDF
- preprocessing для генерации кода
- agent workflows, которым нужна machine-readable структура UI
- batch migration tools для больших архивов дизайна
Выход — это не просто screenshot с подписями. Это дерево, которое можно фильтровать, преобразовывать, рендерить, импортировать или передавать другой модели.
Границы интеграции
Публичная документация прямо указывает на несколько практических границ:
- для API-вызовов требуется bearer-token authentication
- credit checks выполняются до чтения некоторых загрузок
- качество output зависит от четкости source и сложности layout
- очень высокие скриншоты иногда лучше chunk-ить по границам section
- узлы с низкой confidence следует фильтровать перед downstream-использованием
- enterprise-deployment может review retention, production usage, более высокие rate limits и потребности в private deployment
Эти границы — часть developer experience. Надежный API должен делать свои trade-offs видимыми.
С чего начать
Начните с Visual Struct для скриншотов и mockup. Используйте PDF to Visual Struct для PDF. Откройте API Reference для схем endpoint и полей request/response.