Skip to main content
POST
AI-propose every mapping document a pipeline default needs from one pasted sample; with config_values, re-check those documents with the reader's pins instead (no model call).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
source_default_slug
string
required

Mapping-default pipeline to propose for, e.g. jsonl_mapping_default or jsonl_mapping_business_default.

row_schema
Row Schema · object
required

Client-dialect schema inferred from the pasted records.

sample
Sample · object
required

One pasted record; evaluated on the server for the preview.

share_sample_with_model
boolean
default:false

Send the sample's values to the model as well as its structure.

pins
Pins · object

step -> alias -> target pointer -> the reader's own binding, which wins over the model.

config_values
Config Values · object | null

step -> alias -> mapping/1 document from an earlier proposal; re-checked with pins, no model call.

Response

Successful Response

config_values
Config Values · object
required

step -> alias -> mapping/1 document, ready for furnish.viaSample.

rows
MappingProposeRow · object[]
required
blocking_missing
MappingProposeMissing · object[]
required

Required target fields nothing binds; the mapping cannot be saved until each is bound.

optional_missing
MappingProposeMissing · object[]
required

Fields the model noted it could not bind that the target does not require.

verified
boolean
required

Every step produced a document free of problems besides missing fields.

entries
MappingProposeEntry · object[]

Each mapping step's target, roots, pins and target models, so the proposal can be drawn on the graph.

message
string | null

What went wrong, when verified is false.