Skip to content
SlooseSloose

Save a source’s cleaning

PUT
/orgs/{org}/imports/{id}/sources/{sid}/cleaning
curl --request PUT \
  --url https://api.sloose.com/orgs/org_9f3c/imports/imp_4d1a/sources/src_7c2e/cleaning \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "version": 1, "cleaning": { "schemaVersion": 1 } }'

Save the cleaning as a new, immutable revision under a key the server mints, then point the source at it under version. Two saves racing write two revisions and exactly one lands; the other’s object is named by nothing and swept after a day. A revision is never overwritten, so a run’s snapshot keeps naming the cleaning it ran with.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required

The org id the session was issued for. A token for one org can never read another.

string
Example
org_9f3c

The org id the session was issued for. A token for one org can never read another.

id
required

The import id.

string
Example
imp_4d1a

The import id.

sid
required

The source id.

string
Example
src_7c2e

The source id.

Request Bodyrequired

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

The version this change was made against — from the last read or write.

integer
>= 1
cleaning
required

The source’s cleaning — rows excluded, cells corrected, its row filter — as the wizard writes it, with its schemaVersion. Stored as sent.

object
schemaVersion
required

The cleaning document’s own shape version, walked forward by whoever reads it.

integer
>= 1
key
additional properties
Examplegenerated
{
  "version": 1,
  "cleaning": {
    "schemaVersion": 1
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Saved: the source names the new revision.

Media typeapplication/json
object
import
required
object
id
required
string
orgId
required
string
connectorId
required

The connection Target names; null until one is chosen.

string | null
templateId
required

The template this import was started from or saved as.

string | null
templateVersion
required

The template version it copied: “the template has moved on” compares this.

integer | null
name
required
string
createdByUserId
required

Who started it — the person, or the person a token acts as. Null only for an import a schedule started, which is nobody’s own.

string | null
tokenId
required

The token held, when one was.

string | null
createdByScheduleId
required
string | null
status
required

Where it stands. An import being deleted is not returned at all: it reads as gone the moment its delete is accepted.

string
Allowed values: open running attention done
currentStep
required

Whichever step the wizard of the day left it on, as that wizard names it.

string | null
currentStage
required
string | null
completedSteps
required
Array<string>
enabledModules
required
Array<string>
version
required

The write precondition: every change names the version it was made against, and a stale one is refused 409 IMPORT_CHANGED.

integer
updatedByUserId
required
string | null
updatedByTokenId
required
string | null
updatedByScheduleId
required
string | null
runningRunId
required

The run that holds the import; every other write is refused while one does.

string | null
lastRunAt
required
string | null
createdAt
required
string
updatedAt
required
string
source
required
object
id
required
string
position
required
integer
label
required
string
defaultLabel
required
string | null
origin
required

Where the rows came from: file, paste, generated, connection.

string
reader
required

Which reader read the bytes: delimited or xlsx.

string | null
connectorId
required
string | null
madeFrom
required
string | null
byteSize
required
integer | null
digest
required

The SHA-256 of the file stored for the source, hex: the identity of its bytes, which changes with every new file and never with a new reading of the same one. With how they are read (reader, options, sheetName), what says an AI answer that proposed a change to the file (a reshape, a sample, a re-read) was not taken: the same bytes, read the same way, are still the file it was proposed for. Null for a file stored before it was kept; the sheets of one workbook share their workbook’s.

string | null
madeByAnswer
required

Which kept answer made this file — { turnId, index }, the turn and the reshape, sample or re-read in its targets — or null: what says such an answer was used, on the server and in the app alike, where the file’s shape cannot. Written with every file stored for the source and every new reading of it, from the upload’s madeByAnswer, and null for any other.

object
turnId
required
string
>= 1 characters <= 100 characters
index
required
integer
<= 499
reshape
required

How this file was reshaped from the file as read at its header row (#1363): the steps in order, each counted on the grid the ones before it left, every row a step named by its place marked so another file’s can be found by it. Written with every file stored for the source and every new reading of it, from the upload’s reshape, and null for any other.

object
steps
required
Array<object>
>= 1 items
object
op
required
string
>= 1 characters
marks
Array<object>
object
from
required
string
Allowed values: start end
at
required
integer
>= 1
shape
required

One letter a cell: b blank, n a number, t other text.

string
/^[bnt]*$/
text
required

Its text cells, digits taken out, case and spaces folded, joined by |.

string
key
additional properties
options
required

What the reader needs to read the file again: delimiter, sheet, header row — in the shape this build reads, whatever shape they were stored in. They are stored with the version of that shape and walked forward when read; that version is not shown.

object | null
sheetName
required

The worksheet’s name, for a source read from one; null for text. The reader finds the sheet by its place (options.sheet); a template names it by this, because a name survives next month’s workbook having its tabs reordered.

string | null
columns
required
Array<string>
rowCount
required
integer
cleaningBytes
required

The size of the current cleaning revision; null when the source has none.

integer | null
workBytes
required

The size of the current revision of its work — the guesses waiting on it, the ones turned down, how each used one was found; null when the source has none.

integer | null
flowId
required

The recipe flow this source feeds, paired by id and never by label or position.

string | null
createdAt
required
string
Example
{
  "import": {
    "status": "open"
  },
  "source": {
    "reshape": {
      "steps": [
        {
          "marks": [
            {
              "from": "start"
            }
          ]
        }
      ]
    }
  }
}

400

Section titled “400”

The request — its body or its query — did not match the schema. issues carries the Zod issue list.

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"
}

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"
}

403

Section titled “403”

The bearer’s role is too low, or it was issued for a different org; or somebody else started this import and an operator changes only their own (code: NOT_YOURS).

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"
}

404

Section titled “404”

No such import (IMPORT_NOT_FOUND) or source (SOURCE_NOT_FOUND).

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"
}

409

Section titled “409”

Somebody changed the import since this version was read (code: IMPORT_CHANGED, with the version it is at now and updatedBy); a run holds it (code: IMPORT_RUNNING, with the runId); this deployment has no storage for imports yet (code: NOT_CONFIGURED); or a source’s reader options were written by a newer build of Sloose than this one (code: FROM_FUTURE, which is refused before anything is written).

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"
}

413

Section titled “413”

The cleaning is larger than 16 MB (code: CLEANING_TOO_LARGE, with the limit in bytes).

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"
}

Report a problem with this page