Generate form

POST https://api.weavely.ai/v1/forms/generate

Request

No authentication header is required for this endpoint.

Body

name
string

A friendly name for the form (optional).

prompt
string
required

A natural-language description of the form to generate
  e.g. "A simple contact form in Flemish".

files
array[base64]

Optional list of base-64-encoded PDF files that provide extra context for the generator.

Response

url
string

The URL that opens the generated form in the Weavely editor.

Get form fields

GET https://api.weavely.ai/v1/forms/{{formId}}/fields

Request

Headers

Authorization
string
required

Bearer <token>
Your personal token.

Path Parameters

formId
string
required

The unique identifier of the form.

Response

formId
string

The form’s unique identifier.

version
string|null

The timestamp of the published version, or null if the form has no published version.

fields
array

The list of fields in the form.

Each field object includes:

id
string

The field’s unique identifier.

label
string

The field’s display label.

type
string

The type of the field (e.g., text, datetime, etc.).