enrich_worksheet
curl --request POST \
--url https://api.rippit.com/v1/enrich_worksheet \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"worksheetId": "<string>",
"enrichments": [
{
"name": "<string>",
"instructions": "<string>",
"outputType": {},
"overrideCaseColumnId": "<string>",
"overrides": [
{
"case": "<string>",
"instructions": "<string>",
"outputType": {}
}
]
}
],
"contextColumnIds": [
"<string>"
],
"where": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"sampleRows": 5000,
"model": "<string>",
"createScaffoldIfMissing": true
}
'import requests
url = "https://api.rippit.com/v1/enrich_worksheet"
payload = {
"worksheetId": "<string>",
"enrichments": [
{
"name": "<string>",
"instructions": "<string>",
"outputType": {},
"overrideCaseColumnId": "<string>",
"overrides": [
{
"case": "<string>",
"instructions": "<string>",
"outputType": {}
}
]
}
],
"contextColumnIds": ["<string>"],
"where": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"sampleRows": 5000,
"model": "<string>",
"createScaffoldIfMissing": 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({
worksheetId: '<string>',
enrichments: [
{
name: '<string>',
instructions: '<string>',
outputType: {},
overrideCaseColumnId: '<string>',
overrides: [{case: '<string>', instructions: '<string>', outputType: {}}]
}
],
contextColumnIds: ['<string>'],
where: [{columnId: '<string>', value: '<string>'}],
sampleRows: 5000,
model: '<string>',
createScaffoldIfMissing: true
})
};
fetch('https://api.rippit.com/v1/enrich_worksheet', 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.rippit.com/v1/enrich_worksheet",
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([
'worksheetId' => '<string>',
'enrichments' => [
[
'name' => '<string>',
'instructions' => '<string>',
'outputType' => [
],
'overrideCaseColumnId' => '<string>',
'overrides' => [
[
'case' => '<string>',
'instructions' => '<string>',
'outputType' => [
]
]
]
]
],
'contextColumnIds' => [
'<string>'
],
'where' => [
[
'columnId' => '<string>',
'value' => '<string>'
]
],
'sampleRows' => 5000,
'model' => '<string>',
'createScaffoldIfMissing' => 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.rippit.com/v1/enrich_worksheet"
payload := strings.NewReader("{\n \"worksheetId\": \"<string>\",\n \"enrichments\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {},\n \"overrideCaseColumnId\": \"<string>\",\n \"overrides\": [\n {\n \"case\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {}\n }\n ]\n }\n ],\n \"contextColumnIds\": [\n \"<string>\"\n ],\n \"where\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sampleRows\": 5000,\n \"model\": \"<string>\",\n \"createScaffoldIfMissing\": 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.rippit.com/v1/enrich_worksheet")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"worksheetId\": \"<string>\",\n \"enrichments\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {},\n \"overrideCaseColumnId\": \"<string>\",\n \"overrides\": [\n {\n \"case\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {}\n }\n ]\n }\n ],\n \"contextColumnIds\": [\n \"<string>\"\n ],\n \"where\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sampleRows\": 5000,\n \"model\": \"<string>\",\n \"createScaffoldIfMissing\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rippit.com/v1/enrich_worksheet")
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 \"worksheetId\": \"<string>\",\n \"enrichments\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {},\n \"overrideCaseColumnId\": \"<string>\",\n \"overrides\": [\n {\n \"case\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {}\n }\n ]\n }\n ],\n \"contextColumnIds\": [\n \"<string>\"\n ],\n \"where\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sampleRows\": 5000,\n \"model\": \"<string>\",\n \"createScaffoldIfMissing\": true\n}"
response = http.request(request)
puts response.read_bodyWorksheets
enrich_worksheet
Analyze with AI
Add AI columns to a worksheet that classify themes and root causes, score records or extract evidence. Each row’s answer uses its full conversation transcript, found through the worksheet’s ticket_sid column or the column whose kind is external_gradable_reference, plus any contextColumnIds values; a worksheet with neither reference is judged on its own columns instead. Results persist as columns that can be filtered and aggregated.
Only rows already on the worksheet are processed; rows that load after the job starts are not enriched. All columns requested together are filled in a single LLM call per row.
The job runs in the background and this returns its jobId at once; get_enrich_status with the worksheetId and jobId reports progress and completion. columns pairs each new column’s display name with its id, and queries take the id.
enrich_worksheet
curl --request POST \
--url https://api.rippit.com/v1/enrich_worksheet \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"worksheetId": "<string>",
"enrichments": [
{
"name": "<string>",
"instructions": "<string>",
"outputType": {},
"overrideCaseColumnId": "<string>",
"overrides": [
{
"case": "<string>",
"instructions": "<string>",
"outputType": {}
}
]
}
],
"contextColumnIds": [
"<string>"
],
"where": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"sampleRows": 5000,
"model": "<string>",
"createScaffoldIfMissing": true
}
'import requests
url = "https://api.rippit.com/v1/enrich_worksheet"
payload = {
"worksheetId": "<string>",
"enrichments": [
{
"name": "<string>",
"instructions": "<string>",
"outputType": {},
"overrideCaseColumnId": "<string>",
"overrides": [
{
"case": "<string>",
"instructions": "<string>",
"outputType": {}
}
]
}
],
"contextColumnIds": ["<string>"],
"where": [
{
"columnId": "<string>",
"value": "<string>"
}
],
"sampleRows": 5000,
"model": "<string>",
"createScaffoldIfMissing": 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({
worksheetId: '<string>',
enrichments: [
{
name: '<string>',
instructions: '<string>',
outputType: {},
overrideCaseColumnId: '<string>',
overrides: [{case: '<string>', instructions: '<string>', outputType: {}}]
}
],
contextColumnIds: ['<string>'],
where: [{columnId: '<string>', value: '<string>'}],
sampleRows: 5000,
model: '<string>',
createScaffoldIfMissing: true
})
};
fetch('https://api.rippit.com/v1/enrich_worksheet', 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.rippit.com/v1/enrich_worksheet",
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([
'worksheetId' => '<string>',
'enrichments' => [
[
'name' => '<string>',
'instructions' => '<string>',
'outputType' => [
],
'overrideCaseColumnId' => '<string>',
'overrides' => [
[
'case' => '<string>',
'instructions' => '<string>',
'outputType' => [
]
]
]
]
],
'contextColumnIds' => [
'<string>'
],
'where' => [
[
'columnId' => '<string>',
'value' => '<string>'
]
],
'sampleRows' => 5000,
'model' => '<string>',
'createScaffoldIfMissing' => 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.rippit.com/v1/enrich_worksheet"
payload := strings.NewReader("{\n \"worksheetId\": \"<string>\",\n \"enrichments\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {},\n \"overrideCaseColumnId\": \"<string>\",\n \"overrides\": [\n {\n \"case\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {}\n }\n ]\n }\n ],\n \"contextColumnIds\": [\n \"<string>\"\n ],\n \"where\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sampleRows\": 5000,\n \"model\": \"<string>\",\n \"createScaffoldIfMissing\": 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.rippit.com/v1/enrich_worksheet")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"worksheetId\": \"<string>\",\n \"enrichments\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {},\n \"overrideCaseColumnId\": \"<string>\",\n \"overrides\": [\n {\n \"case\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {}\n }\n ]\n }\n ],\n \"contextColumnIds\": [\n \"<string>\"\n ],\n \"where\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sampleRows\": 5000,\n \"model\": \"<string>\",\n \"createScaffoldIfMissing\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rippit.com/v1/enrich_worksheet")
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 \"worksheetId\": \"<string>\",\n \"enrichments\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {},\n \"overrideCaseColumnId\": \"<string>\",\n \"overrides\": [\n {\n \"case\": \"<string>\",\n \"instructions\": \"<string>\",\n \"outputType\": {}\n }\n ]\n }\n ],\n \"contextColumnIds\": [\n \"<string>\"\n ],\n \"where\": [\n {\n \"columnId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sampleRows\": 5000,\n \"model\": \"<string>\",\n \"createScaffoldIfMissing\": true\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Worksheet to add the columns to.
Minimum string length:
1Pattern:
^[A-Za-z0-9_-]+$Columns to create and fill.
Required array length:
1 - 25 elementsShow child attributes
Show child attributes
Existing column ids whose per-row values the model reads alongside the conversation.
Enrich only rows matching these filters.
Maximum array length:
20- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Enrich only a uniform random sample of this many rows, drawn after where and fresh on each run.
Required range:
1 <= x <= 10000Model id; omitted uses the server default. Choose another supported model when the task calls for it. Ids are tenant-specific, and unknown ones are rejected.
Minimum string length:
1True turns a worksheet with no pipeline columns into a reusable pipeline on this enrichment; unset runs a plain one-off job.
Response
200
Tool result.
Was this page helpful?