Dokumentasi Developer

Referensi Endpoint

Permukaan /v1 saat ini. Setiap penulisan butuh scope yang sesuai dan header Idempotency-Key.

Endpoint

Semua path relatif terhadap prefiks /v1. Autentikasi dengan Bearer API key; tidak ada header workspace — kunci sudah menyiratkan workspace-nya.

Metode	Endpoint	Scope	Idempotensi	Keterangan
GET	/v1/forms	`forms:read`		Daftar semua form di workspace kunci.
GET	/v1/forms/:id	`forms:read`		Ambil satu form berdasarkan id; di luar workspace → 404.
GET	/v1/submissions?formId=	`submissions:read`		Daftar submission satu form (butuh formId).
POST	/v1/forms	`forms:write`	Wajib	Buat form draf yang di-stamp ke workspace kunci.
PATCH	/v1/forms/:id	`forms:write`	Wajib	Perbarui atau publikasikan sebuah form.
POST	/v1/forms/:id/submissions	`submissions:write`	Wajib	Catat submission non-pembayaran ke sebuah form.

Respons dan error

docs.endpoints.envelopeBody

const form = await lyra.forms.create({
  title: "Pendaftaran Workshop",
  description: "Form pendaftaran peserta workshop.",
});
// form.id → "frm_…"  (a draft, stamped to your workspace)

try {
  await lyra.forms.get("frm_does_not_exist");
} catch (err) {
  if (err instanceof LyraApiError) {
    // err.status → 404, err.messageKey → localize this, err.fieldErrors
    console.error(err.status, err.messageKey);
  }
}