Parse a table and propose a column mapping

Dry run before /batch-tasks: shows how the columns map to template variables. Creates nothing and costs nothing. variables are the columns the table is expected to carry — what a caller supplies; for a template that computes some of its values, inputs (InputDescriptor) names what it computes from them. A computed value is never an expected column and is never reported unmatched, but a column named after one maps onto it as an explicit override.

post/batch-tasks/preview

Request

  • Base URL: https://rendry.io/api/v1
  • URL: https://rendry.io/api/v1/batch-tasks/preview
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Headers

X-Rendry-Accountstring

Browser/OAuth current member account selector. API keys/embed credentials are bound to their persisted account and reject another account. Omitting this header selects the browser actor personal account.

Request body

preset_idstring required
tablestring required
formatstring

Output format override, the same field /batch-tasks takes. Pass the one you will create the batch with, or max_cost_credits quotes a different price than the batch charges (a pdf page is priced per page, an image by canvas area).

qualityinteger

As on /batch-tasks: resolved with format and max_width exactly as the batch resolves them, so a value the batch refuses is refused here too (batch_output_invalid).

max_widthinteger

As on /batch-tasks; see quality.

mappingobject

When sent, checked and every row judged under it exactly as /batch-tasks judges them, so a body the batch would refuse is refused here with the batch's answer (batch_mapping_mismatch, batch_row_invalid). Without it the preview proposes one and judges no rows. The reply proposes its own either way (suggested_mapping).

rowsobject

Fed to that row judgement as /batch-tasks feeds it; the quote itself is priced by the template's page, as the batch's balance check is.

Response

Proposed mapping and the price of the run

columnsstring[]

Header row of the table

rows_totalinteger
max_cost_creditsnumber

What the batch charges up front if every row renders: rows × the page price of this template in the format passed

variablesstring[]

Every {variable} the template accepts

suggested_mappingobject

column -> variable, by name

unmatched_variablesstring[]

Variables no column feeds; they render with the template's sample value

variables_without_samplestring[]

Variables that have neither a column nor a sample: a row that leaves them unfed FAILS

Changes

No recorded changes to this operation across all 1 revision of this API.