Update Tag Group
curl --request POST \
--url https://app.octavehq.com/api/v2/tag-group/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"oId": "tg_1234",
"name": "<string>",
"description": "<string>",
"isInferable": true,
"backfill": true
}
'import requests
url = "https://app.octavehq.com/api/v2/tag-group/update"
payload = {
"oId": "tg_1234",
"name": "<string>",
"description": "<string>",
"isInferable": True,
"backfill": True
}
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: 'tg_1234',
name: '<string>',
description: '<string>',
isInferable: true,
backfill: true
})
};
fetch('https://app.octavehq.com/api/v2/tag-group/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/tag-group/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' => 'tg_1234',
'name' => '<string>',
'description' => '<string>',
'isInferable' => true,
'backfill' => true
]),
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/tag-group/update"
payload := strings.NewReader("{\n \"oId\": \"tg_1234\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isInferable\": true,\n \"backfill\": true\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/tag-group/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"tg_1234\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isInferable\": true,\n \"backfill\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/tag-group/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\": \"tg_1234\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isInferable\": true,\n \"backfill\": true\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": "tg_1234",
"name": "<string>",
"entityType": "use_case",
"isInferable": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"tags": [
{
"oId": "tag_1234",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"position": 123
}
],
"backfill": {
"queuedCount": 123,
"remainingCount": 123
},
"description": "<string>"
}
}{
"_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>"
}Tag Group
Update Tag Group
Rename a tag group, change its description, or turn auto-infer on or off. Only the fields passed change; the entity type cannot be changed. Set backfill to also queue inference for existing entities not yet in the group.
POST
/
api
/
v2
/
tag-group
/
update
Update Tag Group
curl --request POST \
--url https://app.octavehq.com/api/v2/tag-group/update \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"oId": "tg_1234",
"name": "<string>",
"description": "<string>",
"isInferable": true,
"backfill": true
}
'import requests
url = "https://app.octavehq.com/api/v2/tag-group/update"
payload = {
"oId": "tg_1234",
"name": "<string>",
"description": "<string>",
"isInferable": True,
"backfill": True
}
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: 'tg_1234',
name: '<string>',
description: '<string>',
isInferable: true,
backfill: true
})
};
fetch('https://app.octavehq.com/api/v2/tag-group/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/tag-group/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' => 'tg_1234',
'name' => '<string>',
'description' => '<string>',
'isInferable' => true,
'backfill' => true
]),
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/tag-group/update"
payload := strings.NewReader("{\n \"oId\": \"tg_1234\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isInferable\": true,\n \"backfill\": true\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/tag-group/update")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"tg_1234\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isInferable\": true,\n \"backfill\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/tag-group/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\": \"tg_1234\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isInferable\": true,\n \"backfill\": true\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": "tg_1234",
"name": "<string>",
"entityType": "use_case",
"isInferable": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"tags": [
{
"oId": "tag_1234",
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"position": 123
}
],
"backfill": {
"queuedCount": 123,
"remainingCount": 123
},
"description": "<string>"
}
}{
"_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
application/json
Tag group OId
Minimum string length:
1Example:
"tg_1234"
New name
Minimum string length:
1New description; null clears it
Turn auto-infer on or off for new entities
When true, queue inference for existing entities not yet in the group right after saving. Requires the group to be auto-infer and to have at least one value. Costs one LLM call per queued entity. Defaults to false.