Codia
Zurück zur Übersicht

Open API und Codias Entwickler-Ökosystem

Developer Platform2026-04-22

Warum Codia APIs bereitstellt

Codias Produkte konvertieren visuelle Inhalte in bearbeitbare, strukturierte Assets. Die API ist für Teams gedacht, die dieselbe Fähigkeit in ihrem eigenen Produkt, Migrationsskript, Agenten-Workflow, QA-System oder ihrer Design-Automatisierungspipeline brauchen.

Die Entwicklerplattform beruht auf einer einfachen Idee: Visuelle Eingaben sollten zu strukturierten Daten werden, über die Software nachdenken kann.

Visual Struct für Bilder

Der Visual-Struct-Bild-Endpunkt konvertiert einen UI-Screenshot oder ein Mockup in einen hierarchischen JSON-Baum.

http
POST https://api.codia.ai/v1/open/image_to_design

Die Antwort enthält typisierte Elemente wie Überschriften, Buttons, Cards, Tabellen, Diagramme, Icons, Text und Panels. Knoten enthalten Bounding Boxes, Layout-Konfiguration, Confidence-Metadaten und Kind-Elemente.

Die Dokumentation beschreibt drei Ausgabeformate:

  • json für benutzerdefinierte nachgelagerte Pipelines
  • svg für ein design-tool-agnostisches Vektor-Re-Rendering
  • figma für das Einfügen in eine Figma-Datei über ein Plugin oder einen Import-Flow

Das ist die API, die man nutzt, wenn ein Screenshot, UI-Mockup oder visuelle Referenz maschinenlesbar werden muss.

PDF zu Visual Struct

PDFs verwenden einen verwandten Endpunkt:

http
POST https://api.codia.ai/v1/open/pdf_to_design

Der Endpunkt konvertiert eine PDF-Seite in Codias Visual Element Schema: eine typisierte Hierarchie mit Bounding Boxes, Layout-Konfigurationen, Stil-Spezifikationen und Kind-Elementen. Dieselbe Schemaform wird auch mit Visual Struct für Bilder geteilt, sodass nachgelagerte Verbraucher Bilder und PDFs mit einem einzigen Verarbeitungsmodell unterstützen können.

Die Dokumentation nennt typische Anwendungsfälle wie Figma-Importer, Code-Generatoren, visuelle QA-Pipelines und Rendering-Workflows.

Uploads und Task-Workflows

Für Workflows, die private Dateiverarbeitung oder lang laufende Jobs benötigen, beschreibt vorhandener Open-API-Content ein Upload-und-Task-Muster:

  • eine private Datei nach /v1/open/uploads hochladen
  • eine undurchsichtige upload_id erhalten
  • einen Task über /v1/open/tasks erstellen
  • Webhook-Ereignisse empfangen oder den Task-Status abfragen
  • die generierte Ausgabe herunterladen, wenn der Task abgeschlossen ist

Der Artikel über NotebookLM-ähnliche PDFs zu bearbeitbarem PPTX nutzt dieses Muster für serverseitige PDF-zu-PowerPoint-Automatisierung. Die wichtigste Implementierungsregel ist, dass der Codia-API-Schlüssel auf Ihrem Server bleibt, nicht im Browser.

Was Entwickler damit bauen

Die API ist nützlich, wenn ein Team strukturierte visuelle Erkennung in einem anderen System braucht:

  • Wettbewerbsarchivierung und -analyse von UIs
  • Designsystem-Audits
  • automatisierte visuelle QA und Regression-Checks
  • Screenshot-zu-Figma-Import-Flows
  • PDF-zu-Schema-Extraktion
  • Vorverarbeitung für Codegenerierung
  • Agenten-Workflows, die maschinenlesbare UI-Struktur brauchen
  • Batch-Migrationstools für große Designarchive

Die Ausgabe ist nicht nur ein Screenshot mit Labels. Es ist ein Baum, der gefiltert, transformiert, gerendert, importiert oder an ein anderes Modell weitergegeben werden kann.

Integrationsgrenzen

Die öffentliche Dokumentation ist bei einigen praktischen Grenzen klar:

  • API-Aufrufe erfordern Bearer-Token-Authentifizierung.
  • Kreditprüfungen erfolgen, bevor einige Uploads gelesen werden.
  • Die Ausgabequalität hängt von der Klarheit der Quelle und der Komplexität des Layouts ab.
  • Sehr hohe Screenshots lassen sich oft besser verarbeiten, wenn sie an Abschnittsgrenzen geteilt werden.
  • Knoten mit niedriger Confidence sollten vor der Weiterverwendung gefiltert werden.
  • Enterprise-Bereitstellungen können Aufbewahrung, Produktionseinsatz, höhere Rate Limits und private Bereitstellungsanforderungen prüfen.

Diese Grenzen gehören zur Entwicklererfahrung. Eine zuverlässige API sollte ihre Kompromisse sichtbar machen.

Wo Sie anfangen

Starten Sie mit Visual Struct für Screenshots und Mockups. Verwenden Sie PDF to Visual Struct für PDFs. Öffnen Sie die API Reference für Endpunktschemas und Request- und Response-Felder.

Verwandte Ressourcen

#open-api#visual-struct#developer-api#json#automation