Skip to main content
POST
/
v1
/
models
/
{model}
/
{id}
/
claim
Claim a record
curl --request POST \
  --url https://api.abloatai.com/v1/models/{model}/{id}/claim \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "queue": true,
  "ttlSeconds": 123
}
'
{
  "object": "<string>",
  "id": "<string>",
  "target": {
    "model": "<string>",
    "id": "<string>",
    "field": "<string>"
  },
  "reason": "<string>",
  "heldBy": "<string>",
  "position": 123,
  "createdAt": 123,
  "expiresAt": 123
}

Authorizations

​
Authorization
string
header
required

API key (sk_live_…) or a scoped capability/ephemeral token. The same header carries both — the server discriminates by token shape.

Path Parameters

​
model
string
required

The model name from your pushed schema (e.g. tasks). The HTTP model API is generated from your own schema — these paths are generic over every model you define.

​
id
string
required

The record id.

Body

application/json
​
reason
string

Human-readable phase, e.g. editing, writing, reviewing.

​
queue
boolean

Join the FIFO queue instead of failing when the row is already claimed.

​
ttlSeconds
integer

Lease duration; auto-renewed while the holder stays connected.

Response

The claim (active or queued).

​
object
string
Allowed value: "claim"
​
id
string
​
status
enum<string>
Available options:
active,
queued,
committed,
expired,
canceled
​
target
object
​
reason
string
​
heldBy
string
​
participantKind
enum<string>
Available options:
user,
agent,
system
​
position
integer | null

0-based place in the FIFO queue when status: queued.

​
createdAt
integer
​
expiresAt
integer