Codia
Kembali ke semua artikel

Open API dan Ekosistem Developer Codia

Developer Platform2026-04-22

Mengapa Codia membuka API

Produk Codia mengubah konten visual menjadi aset terstruktur yang bisa diedit. API ini ada untuk tim yang ingin kemampuan yang sama di dalam produk mereka sendiri, skrip migrasi, alur kerja agen, sistem QA, atau pipeline otomasi desain.

Platform developer ini berpusat pada satu ide sederhana: input visual harus menjadi data terstruktur yang bisa dipahami software.

Visual Struct untuk gambar

endpoint gambar Visual Struct mengubah screenshot UI atau mockup menjadi tree JSON hierarkis.

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

Respons mencakup elemen bertipe seperti header, button, kartu, tabel, chart, ikon, teks, dan panel. Node menyertakan bounding box, konfigurasi layout, metadata confidence, dan elemen anak.

Dokumentasi menjelaskan tiga format output:

  • json untuk pipeline downstream kustom
  • svg untuk render ulang vektor yang agnostik terhadap alat desain
  • figma untuk dimasukkan ke file Figma melalui plugin atau alur impor

Ini adalah API yang digunakan ketika screenshot, mockup UI, atau referensi visual perlu menjadi machine-readable.

PDF to Visual Struct

PDF menggunakan endpoint terkait:

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

endpoint ini mengonversi halaman PDF menjadi Visual Element Schema Codia: hierarki bertipe dengan bounding box, konfigurasi layout, spesifikasi style, dan elemen anak. Bentuk schema yang sama dipakai bersama Visual Struct untuk gambar, sehingga konsumen hilir bisa mendukung input gambar dan PDF dengan satu model pemrosesan.

Dokumentasi mencantumkan penggunaan umum seperti importer Figma, generator code, pipeline QA visual, dan alur kerja rendering.

Upload dan alur kerja task

Untuk alur kerja yang membutuhkan penanganan file privat atau job yang berjalan lama, konten Open API yang ada menjelaskan pola upload dan task:

  • unggah file privat ke /v1/open/uploads
  • terima upload_id yang opaque
  • buat task melalui /v1/open/tasks
  • terima event webhook atau polling status task
  • unduh output yang dihasilkan saat task selesai

Artikel PDF ke PPTX yang bisa diedit bergaya NotebookLM memakai pola ini untuk otomasi PDF-to-PowerPoint di sisi server. Aturan implementasi pentingnya adalah API key Codia tetap berada di server Anda, bukan di browser.

Apa yang dibangun developer dengan ini

API ini berguna saat tim membutuhkan pemahaman visual terstruktur di dalam sistem lain:

  • pengarsipan dan analisis UI kompetitor
  • audit design system
  • QA visual otomatis dan regression check
  • alur impor screenshot ke Figma
  • ekstraksi schema dari PDF
  • preprocessing untuk pembuatan code
  • alur kerja agen yang membutuhkan struktur UI machine-readable
  • alat migrasi batch untuk arsip desain besar

Outputnya bukan hanya screenshot dengan label. Outputnya adalah tree yang bisa difilter, ditransformasi, dirender, diimpor, atau diteruskan ke model lain.

Batas integrasi

Dokumen publik jelas tentang beberapa batas praktis:

  • panggilan API memerlukan autentikasi bearer token
  • credit check dilakukan sebelum beberapa upload dibaca
  • kualitas output bergantung pada kejelasan source dan kompleksitas layout
  • screenshot yang sangat tinggi mungkin lebih baik jika di-chunk per section
  • node dengan confidence rendah harus difilter sebelum dipakai downstream
  • deployment enterprise bisa meninjau retensi, penggunaan production, rate limit yang lebih tinggi, dan kebutuhan deployment privat

Batas-batas ini adalah bagian dari pengalaman developer. API yang andal harus membuat tradeoff-nya terlihat.

Mulai dari mana

Mulai dari Visual Struct untuk screenshot dan mockup. Gunakan PDF to Visual Struct untuk PDF. Buka API Reference untuk schema endpoint dan field request/response.

Sumber terkait

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