Skip to main content
POST
/
v1
/
models
/
documentchunk
/
{id}
/
claim
Claim documentchunk
curl --request POST \
  --url https://api.abloatai.com/api/v1/models/documentchunk/{id}/claim \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "description": "<string>",
  "meta": {},
  "ttl": "<string>",
  "queue": true
}
'
import requests

url = "https://api.abloatai.com/api/v1/models/documentchunk/{id}/claim"

payload = {
    "reason": "<string>",
    "description": "<string>",
    "meta": {},
    "ttl": "<string>",
    "queue": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reason: '<string>',
    description: '<string>',
    meta: {},
    ttl: '<string>',
    queue: true
  })
};

fetch('https://api.abloatai.com/api/v1/models/documentchunk/{id}/claim', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.abloatai.com/api/v1/models/documentchunk/{id}/claim",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'description' => '<string>',
    'meta' => [
        
    ],
    'ttl' => '<string>',
    'queue' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.abloatai.com/api/v1/models/documentchunk/{id}/claim"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"meta\": {},\n  \"ttl\": \"<string>\",\n  \"queue\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.abloatai.com/api/v1/models/documentchunk/{id}/claim")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"meta\": {},\n  \"ttl\": \"<string>\",\n  \"queue\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.abloatai.com/api/v1/models/documentchunk/{id}/claim")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"meta\": {},\n  \"ttl\": \"<string>\",\n  \"queue\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "object": "<string>",
  "claim": {
    "id": "<string>",
    "actor": "<string>",
    "reason": "<string>",
    "expiresAt": 123,
    "target": {
      "model": "<string>",
      "id": "<string>",
      "path": "<string>",
      "field": "<string>",
      "meta": {}
    },
    "description": "<string>",
    "field": "<string>",
    "position": 123
  }
}
{
  "status": "<string>",
  "claimId": "<string>",
  "position": 123,
  "heldBy": "<string>",
  "expiresAt": 123
}
{
  "type": "<string>",
  "message": "<string>",
  "code": "<string>",
  "param": "<string>",
  "doc_url": "<string>",
  "request_id": "<string>"
}

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

id
string
required

Record id.

Body

application/json
reason
string

Human-readable phase. Defaults to editing.

description
string

Peer-visible explanation of the work.

meta
object
ttl

Duration such as 5m.

queue
boolean

Join the FIFO queue when another participant holds the row.

Response

Claim acquired.

id
string
required
object
string
required
Allowed value: "claim"
claim
object
required