Intake Forms

Post Public Prefill

Changed on

Suggests answers for empty questions from an uploaded vendor document (PDF or Word .docx). The file is not stored. Unauthenticated; rate-limited per visitor and per form.

post/intake/public/by-id/{publicId}/prefill

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/intake/public/by-id/{publicId}/prefill
  • Auth
    none declared

Path parameters

publicIdstring required

Public form id (hex)

Request body multipart/form-data

filestring binary required
datastring

Current answers as a JSON object string

languagestring

Language for suggestions (en, de, fr, es)

Response

data is { fileName, suggestions }

Changes

    • breaking

      added the pattern ^[0-9a-f]+$ to the path request parameter publicId

    • info

      added the new optional request property

    • breaking

      added the new path request parameter publicId

    • breaking

      added required request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status