Skip to main content
POST
Preview a catalog mapping

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.

Headers

Kallabot-Version
enum<string>

The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.

Available options:
2026-11-07
Example:

"2026-11-07"

Body

application/json
csv
string | null

An uploaded CSV, as text.

Maximum string length: 200000
sheet_url
string | null

A Google Sheet anyone with the link can view.

Maximum string length: 2000
tab
string | null
Maximum string length: 200

Response

Successful Response

The proposed column mapping, value meanings and location aliases (fields as catalog_import.propose).

mapping
Mapping · object
required

columns (listing field → column index) and value_maps.

header
any[]
required

The sheet's header row.

width
integer
required

How many columns.

values
Values · object
required

Each mapped categorical column's distinct values.

allowed
Allowed · object
required

The meanings each categorical field accepts.

locations
any[]
required

Locations found, each with proposed aliases.

sample
any[]
required

The first rows, as read.

rows
integer
required

Data rows in the sheet.

available
any

How many rows read as available.