Commit a batch of operations atomically, and/or register durable premises

POST/v1/commits

Header parameters

Idempotency-Keystring

Replay-safe key; the server returns the cached receipt on retry.

Request body

requiredapplication/json

operationsobject[]

min items 1

Show properties

Array of object

idstring | any

Show properties

Any of:

string

string

any

any

transactionIdstring | any

Show properties

Any of:

string

string

any

any

readAtnumber | any

Show properties

Any of:

number

number

any

any

onStalestring | any

Show properties

Any of:

string

string

any

any

fenceTokennumber | any

Show properties

Any of:

number

number

any

any

actionstringrequired

modelstringrequired

dataobject | any

Show properties

Any of:

object

object

any

any

readsobject[] | any

Show properties

Any of:

object[]

Array of object

Any of:

object

modelstringrequired

idstringrequired

readAtnumberrequired

fieldsstring[]

onStalestring

Allowed:rejectoverwritenotify

object

groupstringrequired

readAtnumberrequired

onStalestring

Allowed:rejectoverwritenotify

any

any

trackobject[] | any

Show properties

Any of:

object[]

Array of object

Any of:

object

modelstringrequired

idstringrequired

readAtnumber

object

groupstringrequired

readAtnumber

any

any

Responses

200Commit receipt

One of:

object

objectstringrequired

idstring

min length 1

clientTxIdstringrequired

min length 1

serverTxIdstringrequired

min length 1

successbooleanrequired

lastSyncIdintegerrequired

min 0 · max 9007199254740991

opsintegerrequired

min 0 · max 9007199254740991

notificationsobject[]

Show properties

Array of object

objectstring

modelstringrequired

idstringrequired

readAtnumberrequired

observedSyncIdnumberrequired

conflictingFieldsstring[]required

currentValuesobjectrequired

writtenByobjectrequired

Show properties

kindstringrequired

Allowed:useragentsystem

idstringrequired

groupstring

missingIdsstring[]

statusstringrequired

correlationIdstringrequired

min length 1 · max length 255

object

objectstringrequired

idstring

min length 1

clientTxIdstringrequired

min length 1

serverTxIdstringrequired

min length 1

successbooleanrequired

lastSyncIdintegerrequired

min 0 · max 9007199254740991

opsintegerrequired

min 0 · max 9007199254740991

notificationsobject[]

Show properties

Array of object

objectstring

modelstringrequired

idstringrequired

readAtnumberrequired

observedSyncIdnumberrequired

conflictingFieldsstring[]required

currentValuesobjectrequired

writtenByobjectrequired

Show properties

kindstringrequired

Allowed:useragentsystem

idstringrequired

groupstring

missingIdsstring[]

statusstringrequired

correlationIdstring

min length 1 · max length 255

400The request did not satisfy the published contract.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_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

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

403The credential does not authorize this operation.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_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

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

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

429The caller exceeded an enforced rate limit.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_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

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

503A required service is temporarily unavailable.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_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

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

Request

curl -X POST "https://api.abloatai.com/api/v1/commits" \
  -H "Content-Type: application/json" \
  -d '{
  "operations": [
    {
      "id": "string",
      "transactionId": "string",
      "readAt": 0,
      "onStale": "reject",
      "fenceToken": 0,
      "action": "string",
      "model": "string",
      "data": {}
    }
  ],
  "reads": [
    {
      "model": "string",
      "id": "string",
      "readAt": 0,
      "fields": [
        "string"
      ],
      "onStale": "reject"
    }
  ],
  "track": [
    {
      "model": "string",
      "id": "string",
      "readAt": 0
    }
  ]
}'

const response = await fetch("https://api.abloatai.com/api/v1/commits", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "operations": [
    {
      "id": "string",
      "transactionId": "string",
      "readAt": 0,
      "onStale": "reject",
      "fenceToken": 0,
      "action": "string",
      "model": "string",
      "data": {}
    }
  ],
  "reads": [
    {
      "model": "string",
      "id": "string",
      "readAt": 0,
      "fields": [
        "string"
      ],
      "onStale": "reject"
    }
  ],
  "track": [
    {
      "model": "string",
      "id": "string",
      "readAt": 0
    }
  ]
})
});

import requests

response = requests.post(
    "https://api.abloatai.com/api/v1/commits",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "operations": [
    {
      "id": "string",
      "transactionId": "string",
      "readAt": 0,
      "onStale": "reject",
      "fenceToken": 0,
      "action": "string",
      "model": "string",
      "data": {}
    }
  ],
  "reads": [
    {
      "model": "string",
      "id": "string",
      "readAt": 0,
      "fields": [
        "string"
      ],
      "onStale": "reject"
    }
  ],
  "track": [
    {
      "model": "string",
      "id": "string",
      "readAt": 0
    }
  ]
},
)

Response

{
  "object": "commit_receipt",
  "id": "string",
  "clientTxId": "string",
  "serverTxId": "string",
  "success": true,
  "lastSyncId": 0,
  "ops": 0,
  "notifications": [
    {
      "object": "stale_notification",
      "model": "string",
      "id": "string",
      "readAt": 0,
      "observedSyncId": 0,
      "conflictingFields": [
        "string"
      ],
      "currentValues": {},
      "writtenBy": {
        "kind": "user",
        "id": "string"
      },
      "group": "string"
    }
  ],
  "missingIds": [
    "string"
  ],
  "status": "queued",
  "correlationId": "string"
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}