Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Read models in one request

Up to 50 independent point reads or list pages. Each slot retains its own result or typed error; reads are not an atomic snapshot.

POST/v1/reads
Request body
requiredapplication/json
readsobject[]required
min items 1 · max items 50
Show properties
Array of object
One of:
object
kindstringrequired
modelstringrequired
min length 1
idstringrequired
min length 1
object
kindstringrequired
modelstringrequired
min length 1
queryobjectrequired
Responses
200Ordered model envelopes and per-read errors.
resultsobject[]required
min items 1 · max items 50
Show properties
Array of object
Any of:
object
resultobjectrequired
Show properties
Any of:
object
objectstringrequired
modelstringrequired
idstringrequired
dataanyrequired
stampnumberrequired
claimsobject[]required
Show properties
Array of object
idstringrequired
actorstringrequired
participantKindstringrequired
Allowed:useragentsystem
onBehalfOfIdstring | any
Show properties
Any of:
string
string
any
any
onBehalfOfKindstring | any
Show properties
Any of:
string
string
any
any
capabilityIdstring | any
Show properties
Any of:
string
string
any
any
descriptionstring
statusstring
Allowed:activequeued
positioninteger
min 0 · max 9007199254740991
expiresAtintegerrequired
min -9007199254740991 · max 9007199254740991
fenceTokeninteger
min -9007199254740991 · max 9007199254740991
targetobjectrequired
Show properties
modelstringrequired
idstringrequired
fieldstring
fieldsstring[]
metaobject
metaobject
fieldstring
object
objectstringrequired
dataany[]required
has_morebooleanrequired
next_cursorstring | anyrequired
Show properties
Any of:
string
string
any
any
modelstringrequired
stampnumberrequired
evidenceobject[]
Show properties
Array of object
idstringrequired
min length 1
stampintegerrequired
min 0 · max 9007199254740991
object
statusintegerrequired
min 400 · max 599
errorobjectrequired
Show properties
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
400The request did not satisfy the published contract.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
401The Bearer credential is missing, malformed, or expired.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
403The credential does not authorize this operation.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
404The addressed resource does not exist in the credential scope.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
409The request conflicts with current claim, version, or idempotency state.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
429The caller exceeded an enforced rate limit.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
500The server could not complete the request.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
503A required service is temporarily unavailable.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
defaultAn HTTP error not otherwise listed; decoded through the canonical envelope.
typestringrequired
codestring
paramstring
messagestringrequired
doc_urlstring
request_idstring
event_idstring
errorsobject[]
Show properties
Array of object
codestring
messagestringrequired
paramstring
Request
curl -X POST "https://api.abloatai.com/api/v1/reads" \
  -H "Content-Type: application/json" \
  -d '{
  "reads": [
    {
      "kind": "read",
      "model": "string",
      "id": "string"
    }
  ]
}'
Response
{
  "results": [
    {
      "result": {
        "object": "model",
        "model": "string",
        "id": "string",
        "data": "string",
        "stamp": 0,
        "claims": [
          {
            "id": "string",
            "actor": "string",
            "participantKind": "user",
            "onBehalfOfId": "string",
            "onBehalfOfKind": "user",
            "capabilityId": "string",
            "description": "string",
            "status": "active",
            "position": 0,
            "expiresAt": 0,
            "fenceToken": 0,
            "target": {
              "model": "string",
              "id": "string",
              "field": "string",
              "fields": [
                "string"
              ],
              "meta": {}
            },
            "meta": {},
            "field": "string"
          }
        ]
      }
    }
  ]
}