Forms
Generate a form definition
x-api-key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/forms/generate" \ -H "Content-Type: application/json" \ -d '{ "prompt": "string" }'{ "data": { "fields": { "sections": [ { "id": "string", "title": "string", "description": "string", "fields": [ { "id": "string", "slug": "string", "type": "string", "label": "string", "required": true, "placeholder": "string", "helperText": "string", "options": [ { "value": "string", "label": "string", "reveals": {} } ], "defaultValue": "string", "description": "string" } ] } ] }, "form": { "id": "string", "workspaceId": "string", "name": "string", "slug": "string", "publicSlug": "string", "status": "DRAFT", "description": "string", "fields": { "sections": [ { "id": "string", "title": "string", "description": "string", "fields": [ { "id": "string", "slug": "string", "type": "string", "label": "string", "required": true, "placeholder": "string", "helperText": "string", "options": [ { "value": "string", "label": "string", "reveals": {} } ], "defaultValue": "string", "description": "string" } ] } ] }, "settings": {}, "showInCommunity": true, "submissionCount": 0 } }}
Planeward Docs