curl --request POST \
--url https://app.octavehq.com/api/v2/resource/link-entities \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"resourceOId": "rs_1234567890",
"entityOIds": [
"<string>"
]
}
'import requests
url = "https://app.octavehq.com/api/v2/resource/link-entities"
payload = {
"resourceOId": "rs_1234567890",
"entityOIds": ["<string>"]
}
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({resourceOId: 'rs_1234567890', entityOIds: ['<string>']})
};
fetch('https://app.octavehq.com/api/v2/resource/link-entities', 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/resource/link-entities",
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([
'resourceOId' => 'rs_1234567890',
'entityOIds' => [
'<string>'
]
]),
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/resource/link-entities"
payload := strings.NewReader("{\n \"resourceOId\": \"rs_1234567890\",\n \"entityOIds\": [\n \"<string>\"\n ]\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/resource/link-entities")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"resourceOId\": \"rs_1234567890\",\n \"entityOIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/resource/link-entities")
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 \"resourceOId\": \"rs_1234567890\",\n \"entityOIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"success": true,
"resourceOId": "<string>",
"linkType": "add",
"linked": 123,
"removed": 123,
"skipped": [
"<string>"
],
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Link Entities to Resource
Link or unlink library entities to a source doc (Google Doc, Notion page, Linear doc, website page). Links are the substrate of resource drift: a linked doc is checked against its entities’ state, and material divergence becomes a reviewable doc-update suggestion (see /resource/check-drift). Use this to curate which docs back which entities — e.g. after uploading a new case study, link it to the personas, use cases, and proof points it supports.
curl --request POST \
--url https://app.octavehq.com/api/v2/resource/link-entities \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"resourceOId": "rs_1234567890",
"entityOIds": [
"<string>"
]
}
'import requests
url = "https://app.octavehq.com/api/v2/resource/link-entities"
payload = {
"resourceOId": "rs_1234567890",
"entityOIds": ["<string>"]
}
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({resourceOId: 'rs_1234567890', entityOIds: ['<string>']})
};
fetch('https://app.octavehq.com/api/v2/resource/link-entities', 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/resource/link-entities",
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([
'resourceOId' => 'rs_1234567890',
'entityOIds' => [
'<string>'
]
]),
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/resource/link-entities"
payload := strings.NewReader("{\n \"resourceOId\": \"rs_1234567890\",\n \"entityOIds\": [\n \"<string>\"\n ]\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/resource/link-entities")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"resourceOId\": \"rs_1234567890\",\n \"entityOIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/resource/link-entities")
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 \"resourceOId\": \"rs_1234567890\",\n \"entityOIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"success": true,
"resourceOId": "<string>",
"linkType": "add",
"linked": 123,
"removed": 123,
"skipped": [
"<string>"
],
"message": "<string>"
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
Resource, link direction, and the entity oIds to apply
The resource (doc) oId to link entities to or unlink from
1"rs_1234567890"
Use add to link entities, remove to unlink entities
add, remove Library entity oIds to link/unlink — any mix of personas (pe_), use cases (uu_), references (re_), competitors (cp_), proof points (pp_), segments (sg_), objections (oj_), and other library types
1 - 100 elementsResponse
Counts of links created/removed plus any skipped oIds
Show child attributes
Show child attributes
add, remove Links created or restored (add) — already-active links are idempotent and do not increment this count
Links removed (remove)
Entity oIds that were malformed, unsupported, missing, deleted, or outside this workspace