Submit feedback on the provided context
curl --request POST \
--url https://api.beamstudio.ai/agent-setup/agent-context/feedback \
--header 'Content-Type: application/json' \
--header 'current-workspace-id: <current-workspace-id>' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "I want to create an agent for invoice reconciliation",
"threadId": "1a2036c0-d533-4636-8f51-2a811763ef5c"
}
'import requests
url = "https://api.beamstudio.ai/agent-setup/agent-context/feedback"
payload = {
"query": "I want to create an agent for invoice reconciliation",
"threadId": "1a2036c0-d533-4636-8f51-2a811763ef5c"
}
headers = {
"current-workspace-id": "<current-workspace-id>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'current-workspace-id': '<current-workspace-id>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: 'I want to create an agent for invoice reconciliation',
threadId: '1a2036c0-d533-4636-8f51-2a811763ef5c'
})
};
fetch('https://api.beamstudio.ai/agent-setup/agent-context/feedback', 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.beamstudio.ai/agent-setup/agent-context/feedback",
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([
'query' => 'I want to create an agent for invoice reconciliation',
'threadId' => '1a2036c0-d533-4636-8f51-2a811763ef5c'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"current-workspace-id: <current-workspace-id>",
"x-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://api.beamstudio.ai/agent-setup/agent-context/feedback"
payload := strings.NewReader("{\n \"query\": \"I want to create an agent for invoice reconciliation\",\n \"threadId\": \"1a2036c0-d533-4636-8f51-2a811763ef5c\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("current-workspace-id", "<current-workspace-id>")
req.Header.Add("x-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://api.beamstudio.ai/agent-setup/agent-context/feedback")
.header("current-workspace-id", "<current-workspace-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"I want to create an agent for invoice reconciliation\",\n \"threadId\": \"1a2036c0-d533-4636-8f51-2a811763ef5c\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beamstudio.ai/agent-setup/agent-context/feedback")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["current-workspace-id"] = '<current-workspace-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"I want to create an agent for invoice reconciliation\",\n \"threadId\": \"1a2036c0-d533-4636-8f51-2a811763ef5c\"\n}"
response = http.request(request)
puts response.read_body{
"threadId": "1a2036c0-d533-4636-8f51-2a811763ef5c",
"response": {
"name": "Customer Support Agent",
"description": "An AI agent that handles customer inquiries and provides support.",
"agentWelcomeMessage": "Hello! I am your customer support assistant. How can I help you today?",
"agentSetupMessage": "This agent is configured to handle billing inquiries and technical support.",
"agentPersonality": "Friendly, professional, and helpful with a focus on resolving issues quickly.",
"agentCategory": {
"id": "<string>",
"title": "<string>"
},
"themeIconUrl": "https://example.com/icons/support-agent.png"
}
}Agent Setup
Submit feedback on the provided context
POST
/
agent-setup
/
agent-context
/
feedback
Submit feedback on the provided context
curl --request POST \
--url https://api.beamstudio.ai/agent-setup/agent-context/feedback \
--header 'Content-Type: application/json' \
--header 'current-workspace-id: <current-workspace-id>' \
--header 'x-api-key: <api-key>' \
--data '
{
"query": "I want to create an agent for invoice reconciliation",
"threadId": "1a2036c0-d533-4636-8f51-2a811763ef5c"
}
'import requests
url = "https://api.beamstudio.ai/agent-setup/agent-context/feedback"
payload = {
"query": "I want to create an agent for invoice reconciliation",
"threadId": "1a2036c0-d533-4636-8f51-2a811763ef5c"
}
headers = {
"current-workspace-id": "<current-workspace-id>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'current-workspace-id': '<current-workspace-id>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: 'I want to create an agent for invoice reconciliation',
threadId: '1a2036c0-d533-4636-8f51-2a811763ef5c'
})
};
fetch('https://api.beamstudio.ai/agent-setup/agent-context/feedback', 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.beamstudio.ai/agent-setup/agent-context/feedback",
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([
'query' => 'I want to create an agent for invoice reconciliation',
'threadId' => '1a2036c0-d533-4636-8f51-2a811763ef5c'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"current-workspace-id: <current-workspace-id>",
"x-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://api.beamstudio.ai/agent-setup/agent-context/feedback"
payload := strings.NewReader("{\n \"query\": \"I want to create an agent for invoice reconciliation\",\n \"threadId\": \"1a2036c0-d533-4636-8f51-2a811763ef5c\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("current-workspace-id", "<current-workspace-id>")
req.Header.Add("x-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://api.beamstudio.ai/agent-setup/agent-context/feedback")
.header("current-workspace-id", "<current-workspace-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"I want to create an agent for invoice reconciliation\",\n \"threadId\": \"1a2036c0-d533-4636-8f51-2a811763ef5c\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beamstudio.ai/agent-setup/agent-context/feedback")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["current-workspace-id"] = '<current-workspace-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"I want to create an agent for invoice reconciliation\",\n \"threadId\": \"1a2036c0-d533-4636-8f51-2a811763ef5c\"\n}"
response = http.request(request)
puts response.read_body{
"threadId": "1a2036c0-d533-4636-8f51-2a811763ef5c",
"response": {
"name": "Customer Support Agent",
"description": "An AI agent that handles customer inquiries and provides support.",
"agentWelcomeMessage": "Hello! I am your customer support assistant. How can I help you today?",
"agentSetupMessage": "This agent is configured to handle billing inquiries and technical support.",
"agentPersonality": "Friendly, professional, and helpful with a focus on resolving issues quickly.",
"agentCategory": {
"id": "<string>",
"title": "<string>"
},
"themeIconUrl": "https://example.com/icons/support-agent.png"
}
}Authorizations
Headers
Body
application/json
Feedback text or query about the agent setup. Use this to provide context, suggestions, or describe what kind of agent you want to create.
Example:
"I want to create an agent for invoice reconciliation"
UUID of the conversation thread to continue. This maintains context across multiple feedback requests.
Example:
"1a2036c0-d533-4636-8f51-2a811763ef5c"
Response
201 - application/json
UUID of the conversation thread. Use this threadId in subsequent requests to maintain context across the agent setup process.
Example:
"1a2036c0-d533-4636-8f51-2a811763ef5c"
Generated agent suggestions including name, description, welcome message, setup message, personality, and category based on the provided query.
Show child attributes
Show child attributes
⌘I