Skip to content
SlooseSloose

Propose a mapping for a file

POST
/ai/auto-map
curl --request POST \
  --url https://api.sloose.com/ai/auto-map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "columns": [ "example" ], "sampleRows": [], "enabledModules": [ "example" ], "decided": { "additionalProperty": [ "example" ] } }'

Given the file’s columns and a few sample rows, proposes a destination field for each column, with a confidence and a reason, plus match rules for the modules involved.

Every proposal is validated against the org’s own fields before it is returned — the model cannot invent a field that does not exist, and a proposal that fails validation is downgraded or dropped rather than handed to you. This is a proposal, not a mutation: nothing is saved.

Fields the org has annotated as personal data are masked before any sample leaves the server, and an org whose AI sample policy is deny sends no rows at all.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
columns
required

The source file’s column headings, in order.

Array<string>
>= 1 items <= 500 items
sampleRows

Sample rows for context. At most 20 are used; the rest are ignored rather than refused. Fields annotated as personal data are masked before anything leaves the server, and an org whose AI sample policy is deny sends none at all.

Array<object>
default:

One source row: column name → cell value, always as a string.

object
key
additional properties
string
enabledModules

Restrict the proposal to these modules. Defaults to everything the org has enabled.

Array<string>
decided

Fields already settled, as module key → field apiNames — chosen by a person, or wired by your own defaults. They are named in the prompt so the model spends its effort on what is genuinely open. Never send a mapping your own name matcher guessed: a guess that happened to run first would silence the better answer, which is the thing being paid for.

object
key
additional properties
Array<string>

Responses

Section titled “Responses”

200

Section titled “200”

The proposal. libraryProblems reports any helper library that would not load.

Media typeapplication/json

A validated mapping proposal, with what it cost.

object
requestId
required

This call’s id. It is also the ledger’s idempotency key.

string
credits
required

Credits settled for this call.

number
usage
required

Token counts, including cache reads and writes.

object
key
additional properties
model
required

The model that answered.

string
key
additional properties
Examplegenerated
{
  "requestId": "example",
  "credits": 1,
  "usage": {
    "additionalProperty": "example"
  },
  "model": "example"
}

400

Section titled “400”

The body did not match the schema (BAD_INPUT, with issues), or a named module or field does not exist.

Media typeapplication/json
object
error
required
string
code
required
string
key
additional properties
Examplegenerated
{
  "error": "example",
  "code": "example"
}

401

Section titled “401”

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
  "error": "example",
  "code": "example"
}

402

Section titled “402”

Not enough AI credits, or the org is suspended. balance shows what is left.

Media typeapplication/json
object
error
required
string
code
required
string
balance
required

AI credits. Included credits reset each period; purchased ones do not.

object
included
required
number
purchased
required
number
reserved
required
number
available
required

Included + purchased − reserved

number
periodStart
required
string
periodEnd
required
string
key
additional properties
Examplegenerated
{
  "error": "example",
  "code": "example",
  "balance": {
    "included": 1,
    "purchased": 1,
    "reserved": 1,
    "available": 1,
    "periodStart": "example",
    "periodEnd": "example"
  }
}

404

Section titled “404”

No such org.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: ORG_NOT_FOUND
key
additional properties
Example
{
  "code": "ORG_NOT_FOUND"
}

409

Section titled “409”

The org has no module registry yet — run discovery and enable some modules first.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: ORG_NOT_CONFIGURED
key
additional properties
Example
{
  "code": "ORG_NOT_CONFIGURED"
}

422

Section titled “422”

The model declined. category says why.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: AI_REFUSED
category
required
string
key
additional properties
Example
{
  "code": "AI_REFUSED"
}

502

Section titled “502”

The model’s answer could not be used.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: AI_BAD_OUTPUT
key
additional properties
Example
{
  "code": "AI_BAD_OUTPUT"
}

503

Section titled “503”

AI is not configured on this deployment. Unconfigured paths say so rather than failing.

Media typeapplication/json
object
error
required
string
code
required
string
Allowed values: AI_NOT_CONFIGURED
key
additional properties
Example
{
  "code": "AI_NOT_CONFIGURED"
}