Skip to content
Docs
Select language:English

/api/v1/inbox/{id}/room/seen

POST
/api/v1/inbox/{id}/room/seen
curl --request POST \
  --url https://example.com/api/v1/inbox/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/room/seen \
  --header 'Content-Type: application/json' \
  --data '{ "thingIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
thingIds
required
Array<string>
>= 1 items <= 200 items
Examplegenerated
{
  "thingIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
item
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: draft reading label_claim currency duplicate receipt sync_drop room
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
createdAt
required
string
createdBy
required
object
displayName
required
string
rowVersion
required
number
batch
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
capturedAt
required
string
placePath
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
kind
required
string
Allowed values: place container
isUnplaced
required
boolean
count
required
number
thing
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
shortCode
required
string | null
labelPrinted
required
boolean
name
required
string | null
type
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
icon
required
string
name
required
string | null
builtinKey
required
string | null
quantity
required
number
lifecycle
required
string
derivedState
required
Array<string>
Allowed values: uncertain draft ended lent borrowed in_repair
path
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
kind
required
string
Allowed values: place container
isUnplaced
required
boolean
shortCode
string | null
containerThumbUrl
required
string | null
thumbUrl
required
string | null
lastSeenAt
required
string | null
isContainer
required
boolean
tags
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
colour
required
string | null
brand
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
model
required
string | null
colour
required
string | null
serial
required
string | null
photos
required
Array<object>
object
fileId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thumbUrl
required
string | null
fieldStatus
required
object
key
additional properties
object
state
required
string
Allowed values: manual extracted confirmed
confidence
number
suggestions
Array<object>
object
field
required
string
value
required
confidence
required
number
source
required
object
extractionId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
attachmentId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
extraction
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
string
Allowed values: queued running succeeded failed paused_budget waiting_provider no_provider superseded
statusReason
string
pausedUntil
string
call
Any of:
object
id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
model
required
string
providerKind
required
string
Allowed values: openai anthropic google openai_compatible openrouter groq
tokens
required
number
images
required
number
cost
object
amount
required
string
currency
required
string
costSource
required
string
Allowed values: provider price_table price_table_later unknown not_sent
paidBy
required
object
scope
required
string
Allowed values: instance account user
label
required
string
mine
required
boolean
outcome
required
string
Allowed values: ok refused rate_limited over_budget provider_error timeout schema_invalid truncated
errorCode
required
string | null
receipt
object
purchaseId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
pages
required
Array<object>
object
fileId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thumbUrl
required
string | null
vendorSeen
string
purchasedOn
string
currency
string
total
string
tax
string
lines
required
Array<object>
object
index
required
number
description
required
string
quantity
required
string
unitPrice
string
flagged
required
boolean
moneyHidden
boolean
reading
object
meter
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
label
required
string | null
unit
required
string
value
required
string
takenAt
required
string
reason
required
string
neighbours
required
object
before
object
value
required
string
takenAt
required
string
after
object
value
required
string
takenAt
required
string
proofThumbUrl
required
string | null
duplicate
object
other
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
shortCode
required
string | null
labelPrinted
required
boolean
name
required
string | null
type
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
icon
required
string
name
required
string | null
builtinKey
required
string | null
quantity
required
number
lifecycle
required
string
derivedState
required
Array<string>
Allowed values: uncertain draft ended lent borrowed in_repair
path
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
kind
required
string
Allowed values: place container
isUnplaced
required
boolean
shortCode
string | null
containerThumbUrl
required
string | null
thumbUrl
required
string | null
lastSeenAt
required
string | null
isContainer
required
boolean
tags
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
colour
required
string | null
reason
required
string
Allowed values: serial brand_model_place
claim
object
code
required
string
claimedFor
required
object
kind
required
string
Allowed values: thing place
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
currency
object
seen
required
string
options
required
Array<string>
room
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
string
Allowed values: reading merging ready failed off
target
required
object
kind
required
string
Allowed values: place container
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
progress
required
object
done
required
number
total
required
number
pausedUntil
string
pausedReason
string
photos
required
Array<object>
object
attachmentId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thumbUrl
required
string | null
status
required
string
Allowed values: waiting read failed off missing
objects
required
number
more
required
boolean
merged
string
Allowed values: model names none
drafts
required
object
made
required
number
waiting
required
number
failed
required
number
places
required
Array<object>
object
index
required
number
name
required
string
photo
required
number
placeId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
already
required
Array<object>
object
thingId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
matchedBy
required
string
Allowed values: code brand_model name_type
seen
required
boolean
thumbUrl
required
string | null
keepPhotos
required
boolean
syncDrop
object
op
required
reason
required
string
entity
object
type
required
string
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
by
object
displayName
required
string
undo
object
eventId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
until
required
string
Example
{
  "item": {
    "kind": "draft",
    "batch": {
      "placePath": [
        {
          "kind": "place"
        }
      ]
    },
    "thing": {
      "derivedState": [
        "uncertain"
      ],
      "path": [
        {
          "kind": "place"
        }
      ],
      "fieldStatus": {
        "additionalProperty": {
          "state": "manual"
        }
      }
    },
    "extraction": {
      "status": "queued",
      "call": {
        "providerKind": "openai",
        "costSource": "provider",
        "paidBy": {
          "scope": "instance"
        },
        "outcome": "ok"
      }
    },
    "receipt": {
      "moneyHidden": true
    },
    "duplicate": {
      "other": {
        "derivedState": [
          "uncertain"
        ],
        "path": [
          {
            "kind": "place"
          }
        ]
      },
      "reason": "serial"
    },
    "claim": {
      "claimedFor": {
        "kind": "thing"
      }
    },
    "room": {
      "status": "reading",
      "target": {
        "kind": "place"
      },
      "photos": [
        {
          "status": "waiting"
        }
      ],
      "merged": "model",
      "already": [
        {
          "matchedBy": "code"
        }
      ]
    }
  }
}