Skip to content

Record parts you opened

POST
/orgs/{org}/imports/{id}/mine/looked
curl --request POST \
--url https://api.sloose.com/orgs/org_9f3c/imports/imp_4d1a/mine/looked \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "looked": { "additionalProperty": [ "example" ] }, "version": 1 }'

Add parts to those the person has opened — never taking any away, so two tabs of one person each add what they saw. A file the import does not hold records nothing, and is named in the answer (notHeld); a file’s marks go when it is removed, replaced or read again. Moves no version, and no run refuses it.

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.

Media typeapplication/json
object
looked
required

Which parts a person has opened, by file: each file’s id, or "" for the parts about no one file (Translate values, which is a module’s across files), to the keys of the parts opened there.

object
key
additional properties
Array<string>
<= 500 items
version
required

The import’s version the marks were made at. A file read since — replaced, read under new options, or added again under the id — records none of them, and is named in notHeld.

integer
Examplegenerated
{
"looked": {
"additionalProperty": [
"example"
]
},
"version": 1
}

Recorded, but for the files named.

Media typeapplication/json
object
ok
required
boolean
notHeld
required

The files nothing was recorded for: the import does not hold them — often not yet, since a page marks a part of a file its own changes have still to upload — or holds them only as read since version. Send them again once it holds them as the marks were made.

Array<string>
Example
{
"ok": true
}

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

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

The bearer is an API token (SESSION_REQUIRED), a read-only staff view (IMPERSONATION_READ_ONLY) or a staff view that may write (STAFF_VIEW: what a person keeps is theirs), or was issued for a different org.

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

No such import, or not one this bearer may open (IMPORT_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"
}

Report a problem with this page