Run a record's AI auto-fills
curl --request POST \
--url https://api.custral.com/v1/records/{object}/{id}/enrich \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.custral.com/v1/records/{object}/{id}/enrich"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.custral.com/v1/records/{object}/{id}/enrich', 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.custral.com/v1/records/{object}/{id}/enrich",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.custral.com/v1/records/{object}/{id}/enrich"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.custral.com/v1/records/{object}/{id}/enrich")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/records/{object}/{id}/enrich")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"recordId": "rec_123",
"objectId": "obj_123",
"total": 123,
"steps": [
{
"propertyId": "prop_123",
"propertyAgentId": "pagent_123",
"status": "success",
"errorMessage": "<string>",
"durationMs": 123
}
],
"succeeded": 123,
"failed": 123,
"skipped": 123
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "invalid_api_key"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "insufficient_scope"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "not_found"
},
"reqId": "req_2a1f9c8e7b6d5"
}Records
Run a record's AI auto-fills
Run a record’s configured AI auto-fills — loads every enabled Property Agent on the record’s object and runs them in dependency order, writing the AI-filled properties. Requires scope: records:write.
POST
/
v1
/
records
/
{object}
/
{id}
/
enrich
Run a record's AI auto-fills
curl --request POST \
--url https://api.custral.com/v1/records/{object}/{id}/enrich \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.custral.com/v1/records/{object}/{id}/enrich"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.custral.com/v1/records/{object}/{id}/enrich', 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.custral.com/v1/records/{object}/{id}/enrich",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.custral.com/v1/records/{object}/{id}/enrich"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.custral.com/v1/records/{object}/{id}/enrich")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/records/{object}/{id}/enrich")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"recordId": "rec_123",
"objectId": "obj_123",
"total": 123,
"steps": [
{
"propertyId": "prop_123",
"propertyAgentId": "pagent_123",
"status": "success",
"errorMessage": "<string>",
"durationMs": 123
}
],
"succeeded": 123,
"failed": 123,
"skipped": 123
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "invalid_api_key"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "insufficient_scope"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "not_found"
},
"reqId": "req_2a1f9c8e7b6d5"
}Authorizations
A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.
Path Parameters
The object — its id, key, or name.
The record id (rec_…).
Was this page helpful?