curl --request POST \
--url https://app.octavehq.com/api/v2/suggestion/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"oId": "esug_abc123",
"instructions": "<string>",
"edits": {},
"mode": "replace"
}
'import requests
url = "https://app.octavehq.com/api/v2/suggestion/update"
payload = {
"oId": "esug_abc123",
"instructions": "<string>",
"edits": {},
"mode": "replace"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({oId: 'esug_abc123', instructions: '<string>', edits: {}, mode: 'replace'})
};
fetch('https://app.octavehq.com/api/v2/suggestion/update', 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://app.octavehq.com/api/v2/suggestion/update",
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([
'oId' => 'esug_abc123',
'instructions' => '<string>',
'edits' => [
],
'mode' => 'replace'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/suggestion/update"
payload := strings.NewReader("{\n \"oId\": \"esug_abc123\",\n \"instructions\": \"<string>\",\n \"edits\": {},\n \"mode\": \"replace\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
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://app.octavehq.com/api/v2/suggestion/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"esug_abc123\",\n \"instructions\": \"<string>\",\n \"edits\": {},\n \"mode\": \"replace\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/suggestion/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"oId\": \"esug_abc123\",\n \"instructions\": \"<string>\",\n \"edits\": {},\n \"mode\": \"replace\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"changeType": "add",
"targetEntityOId": "<string>",
"name": "<string>",
"message": "<string>",
"summaryMessage": "<string>",
"attributes": [
"<string>"
],
"reasoning": "<string>",
"confidence": 123,
"createdAt": "2023-11-07T05:31:56Z",
"docUpdate": {
"insight": "<string>",
"recommendedAction": "<string>",
"proposedUpstreamEdit": "<string>",
"resourceName": "<string>",
"sourceUrl": "<string>",
"primaryEntityOId": "<string>",
"provenance": [
{
"entityOId": "<string>",
"entityType": "<string>",
"changes": [
{
"at": "<string>",
"summary": "<string>",
"findings": [
{
"findingOId": "<string>",
"extractionType": "<string>",
"snippetText": "<string>",
"text": "<string>",
"occurredAt": "<string>",
"actor": "<string>",
"actorTitle": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"providerName": "<string>"
}
],
"suggestionOId": "<string>",
"findingCount": 123
}
],
"entityName": "<string>",
"rationale": "<string>"
}
],
"editHunks": [
{
"anchor": "<string>",
"replacement": "<string>"
}
]
},
"evidence": [
{
"eventOId": "<string>",
"findingOId": "<string>",
"text": "<string>",
"snippetText": "<string>",
"providerName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"actor": "<string>",
"actorTitle": "<string>",
"companyName": "<string>",
"companyDomain": "<string>"
}
],
"evidenceTotal": 123,
"diffChunks": [
{
"label": "<string>",
"before": "<string>",
"after": "<string>",
"diff": "<string>"
}
],
"writeback": {
"status": "<string>",
"skipReason": "<string>",
"target": "<string>",
"at": "2023-11-07T05:31:56Z"
},
"preview": "<unknown>",
"currentEntity": "<unknown>"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Update Suggestion
Edit a PENDING entity suggestion before accepting it. Two combinable modes: instructions regenerates the proposed content via AI; edits applies a precise partial field override with no regeneration. Works for both ‘add’ and ‘refine’ suggestions. Returns the updated preview. The suggestion stays pending — nothing is applied until you call suggestion/accept.
curl --request POST \
--url https://app.octavehq.com/api/v2/suggestion/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"oId": "esug_abc123",
"instructions": "<string>",
"edits": {},
"mode": "replace"
}
'import requests
url = "https://app.octavehq.com/api/v2/suggestion/update"
payload = {
"oId": "esug_abc123",
"instructions": "<string>",
"edits": {},
"mode": "replace"
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({oId: 'esug_abc123', instructions: '<string>', edits: {}, mode: 'replace'})
};
fetch('https://app.octavehq.com/api/v2/suggestion/update', 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://app.octavehq.com/api/v2/suggestion/update",
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([
'oId' => 'esug_abc123',
'instructions' => '<string>',
'edits' => [
],
'mode' => 'replace'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/suggestion/update"
payload := strings.NewReader("{\n \"oId\": \"esug_abc123\",\n \"instructions\": \"<string>\",\n \"edits\": {},\n \"mode\": \"replace\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
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://app.octavehq.com/api/v2/suggestion/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"esug_abc123\",\n \"instructions\": \"<string>\",\n \"edits\": {},\n \"mode\": \"replace\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/suggestion/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"oId\": \"esug_abc123\",\n \"instructions\": \"<string>\",\n \"edits\": {},\n \"mode\": \"replace\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"changeType": "add",
"targetEntityOId": "<string>",
"name": "<string>",
"message": "<string>",
"summaryMessage": "<string>",
"attributes": [
"<string>"
],
"reasoning": "<string>",
"confidence": 123,
"createdAt": "2023-11-07T05:31:56Z",
"docUpdate": {
"insight": "<string>",
"recommendedAction": "<string>",
"proposedUpstreamEdit": "<string>",
"resourceName": "<string>",
"sourceUrl": "<string>",
"primaryEntityOId": "<string>",
"provenance": [
{
"entityOId": "<string>",
"entityType": "<string>",
"changes": [
{
"at": "<string>",
"summary": "<string>",
"findings": [
{
"findingOId": "<string>",
"extractionType": "<string>",
"snippetText": "<string>",
"text": "<string>",
"occurredAt": "<string>",
"actor": "<string>",
"actorTitle": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"providerName": "<string>"
}
],
"suggestionOId": "<string>",
"findingCount": 123
}
],
"entityName": "<string>",
"rationale": "<string>"
}
],
"editHunks": [
{
"anchor": "<string>",
"replacement": "<string>"
}
]
},
"evidence": [
{
"eventOId": "<string>",
"findingOId": "<string>",
"text": "<string>",
"snippetText": "<string>",
"providerName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"actor": "<string>",
"actorTitle": "<string>",
"companyName": "<string>",
"companyDomain": "<string>"
}
],
"evidenceTotal": 123,
"diffChunks": [
{
"label": "<string>",
"before": "<string>",
"after": "<string>",
"diff": "<string>"
}
],
"writeback": {
"status": "<string>",
"skipReason": "<string>",
"target": "<string>",
"at": "2023-11-07T05:31:56Z"
},
"preview": "<unknown>",
"currentEntity": "<unknown>"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
The suggestion oId to revise (from suggestion/list). Only pending suggestions can be revised.
"esug_abc123"
REGENERATE mode. Natural-language instructions for how to change the proposal — e.g. 'make the description more concise'. The proposed content is regenerated by AI. Combine with edits to regenerate first, then apply precise overrides on top.
OVERRIDE mode. A partial patch of fields on the proposed entity — only the keys you provide change; arrays replace wholesale, objects deep-merge. No AI regeneration runs. Use this to surgically fix one detail of an otherwise-good proposal. Inspect the current proposal with suggestion/get first to see the field shape.
Show child attributes
Show child attributes
Applies to instructions only: 'replace' (default) swaps the prior instruction for this one; 'append' layers it on top.
replace, append