Move an agent's inline keys into a set
Promotes an agent’s inline extraction keys into a reusable set, attaches the set to that agent, and clears the moved keys from the agent’s inline config — so each key still reaches the agent exactly once.
Send exactly one of name (create a new set) or set_id (merge into an existing set). When merging, an inline key whose name already exists in the target set is a conflict and the request is rejected with 409 EXTRACTION_KEY_CLASH. Pass on_conflict: "keep_set_definition" to opt in to dropping those inline keys in favour of the set’s definition; they are then reported in dropped_inline_keys. Omitting on_conflict is not the same as passing it.
curl --request POST \
--url https://api.vocobase.com/api/v2/extraction-sets/from-agent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Renewal outcomes"
}
'import requests
url = "https://api.vocobase.com/api/v2/extraction-sets/from-agent"
payload = {
"agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Renewal outcomes"
}
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({agent_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890', name: 'Renewal outcomes'})
};
fetch('https://api.vocobase.com/api/v2/extraction-sets/from-agent', 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.vocobase.com/api/v2/extraction-sets/from-agent",
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([
'agent_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
'name' => 'Renewal outcomes'
]),
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.vocobase.com/api/v2/extraction-sets/from-agent"
payload := strings.NewReader("{\n \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Renewal outcomes\"\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.vocobase.com/api/v2/extraction-sets/from-agent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Renewal outcomes\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/extraction-sets/from-agent")
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 \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Renewal outcomes\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "es_8c7b6a59-4837-2615-0493-8271605948af",
"name": "Renewal outcomes",
"description": "Fields every renewal call should return",
"keys": [
{
"name": "will_renew",
"type": "boolean",
"description": "Did the customer commit to renewing?"
},
{
"name": "objection",
"type": "string",
"description": "Main reason given for not renewing."
},
{
"name": "callback_date",
"type": "date",
"description": "Date the customer asked to be called back."
}
],
"created_at": "2026-08-01T12:00:00.000Z",
"updated_at": "2026-08-14T15:30:00.000Z",
"attached_agents": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Renewals Agent"
}
],
"attached_campaigns": [],
"dropped_inline_keys": []
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Provide exactly one of name (new set) or set_id (existing set)"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}{
"success": false,
"error": {
"code": "EXTRACTION_KEY_CLASH",
"message": "'renewal_date' already defined by set 'Renewal outcomes' with a possibly different type or description. Rename the agent's key, or pass on_conflict: 'keep_set_definition'."
}
}{
"success": false,
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 60 seconds."
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}{
"success": false,
"error": {
"code": "WRITE_CONFLICT",
"message": "Busy — another change to these keys is in flight. Retry."
}
}Authorizations
API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.
Body
Create a new set with this name. Mutually exclusive with set_id.
Only used when creating a new set.
Merge into this existing set. Mutually exclusive with name.
Optional; keep_set_definition is the only accepted value. Opt in to dropping clashing inline keys. Omit it and any clash returns 409 EXTRACTION_KEY_CLASH instead.
keep_set_definition curl --request POST \
--url https://api.vocobase.com/api/v2/extraction-sets/from-agent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Renewal outcomes"
}
'import requests
url = "https://api.vocobase.com/api/v2/extraction-sets/from-agent"
payload = {
"agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Renewal outcomes"
}
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({agent_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890', name: 'Renewal outcomes'})
};
fetch('https://api.vocobase.com/api/v2/extraction-sets/from-agent', 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.vocobase.com/api/v2/extraction-sets/from-agent",
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([
'agent_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
'name' => 'Renewal outcomes'
]),
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.vocobase.com/api/v2/extraction-sets/from-agent"
payload := strings.NewReader("{\n \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Renewal outcomes\"\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.vocobase.com/api/v2/extraction-sets/from-agent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Renewal outcomes\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/extraction-sets/from-agent")
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 \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Renewal outcomes\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "es_8c7b6a59-4837-2615-0493-8271605948af",
"name": "Renewal outcomes",
"description": "Fields every renewal call should return",
"keys": [
{
"name": "will_renew",
"type": "boolean",
"description": "Did the customer commit to renewing?"
},
{
"name": "objection",
"type": "string",
"description": "Main reason given for not renewing."
},
{
"name": "callback_date",
"type": "date",
"description": "Date the customer asked to be called back."
}
],
"created_at": "2026-08-01T12:00:00.000Z",
"updated_at": "2026-08-14T15:30:00.000Z",
"attached_agents": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Renewals Agent"
}
],
"attached_campaigns": [],
"dropped_inline_keys": []
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Provide exactly one of name (new set) or set_id (existing set)"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}{
"success": false,
"error": {
"code": "EXTRACTION_KEY_CLASH",
"message": "'renewal_date' already defined by set 'Renewal outcomes' with a possibly different type or description. Rename the agent's key, or pass on_conflict: 'keep_set_definition'."
}
}{
"success": false,
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 60 seconds."
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}{
"success": false,
"error": {
"code": "WRITE_CONFLICT",
"message": "Busy — another change to these keys is in flight. Retry."
}
}