Update Agent
curl --request PUT \
--url https://api.beamstudio.ai/agent/{agentId} \
--header 'Content-Type: application/json' \
--header 'current-workspace-id: <current-workspace-id>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"agentConfig": {
"restrictions": "<string>",
"taskTemplates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": true,
"gptTool": true,
"consentRequired": true,
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": true,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"tools": [
"<string>"
],
"llmTools": [
{}
],
"sop": {},
"defaultTaskId": "<string>",
"workspaceId": "<string>"
},
"vectorDbId": "<string>",
"workspaceId": "<string>",
"agentCategoryId": "<string>",
"themeIconUrl": "<string>",
"personality": "<string>",
"userAccessTokenId": "<string>",
"agentIntroMessage": "<string>",
"agentSetupMessage": "<string>",
"agentSetupSessionId": "<string>",
"skipAgentSetupSop": true,
"isAttachmentDataPulledIn": true,
"tools": [
"<string>"
],
"templates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": true,
"gptTool": true,
"consentRequired": true,
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": true,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"preferredModel": "<string>",
"instructions": "<string>"
}
'import requests
url = "https://api.beamstudio.ai/agent/{agentId}"
payload = {
"name": "<string>",
"description": "<string>",
"agentConfig": {
"restrictions": "<string>",
"taskTemplates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": True,
"gptTool": True,
"consentRequired": True,
"integrationId": "<string>",
"isIntegrationRequired": True,
"isIntegrationConnected": True,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": True,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"tools": ["<string>"],
"llmTools": [{}],
"sop": {},
"defaultTaskId": "<string>",
"workspaceId": "<string>"
},
"vectorDbId": "<string>",
"workspaceId": "<string>",
"agentCategoryId": "<string>",
"themeIconUrl": "<string>",
"personality": "<string>",
"userAccessTokenId": "<string>",
"agentIntroMessage": "<string>",
"agentSetupMessage": "<string>",
"agentSetupSessionId": "<string>",
"skipAgentSetupSop": True,
"isAttachmentDataPulledIn": True,
"tools": ["<string>"],
"templates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": True,
"gptTool": True,
"consentRequired": True,
"integrationId": "<string>",
"isIntegrationRequired": True,
"isIntegrationConnected": True,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": True,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"preferredModel": "<string>",
"instructions": "<string>"
}
headers = {
"current-workspace-id": "<current-workspace-id>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'current-workspace-id': '<current-workspace-id>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
agentConfig: {
restrictions: '<string>',
taskTemplates: [
{
id: '<string>',
objective: '<string>',
description: '<string>',
steps: [
{
step: '<string>',
toolId: '<string>',
iconSrc: '<string>',
iconUrl: '<string>',
beamTool: true,
gptTool: true,
consentRequired: true,
integrationId: '<string>',
isIntegrationRequired: true,
isIntegrationConnected: true,
integrationProvider: '<string>',
integrationIdentifier: '<string>',
toolDetail: {},
integrationCustomAuthParameters: {}
}
],
default: true,
category: {id: '<string>', title: '<string>'},
lastUpdatedAt: '2023-11-07T05:31:56Z'
}
],
tools: ['<string>'],
llmTools: [{}],
sop: {},
defaultTaskId: '<string>',
workspaceId: '<string>'
},
vectorDbId: '<string>',
workspaceId: '<string>',
agentCategoryId: '<string>',
themeIconUrl: '<string>',
personality: '<string>',
userAccessTokenId: '<string>',
agentIntroMessage: '<string>',
agentSetupMessage: '<string>',
agentSetupSessionId: '<string>',
skipAgentSetupSop: true,
isAttachmentDataPulledIn: true,
tools: ['<string>'],
templates: [
{
id: '<string>',
objective: '<string>',
description: '<string>',
steps: [
{
step: '<string>',
toolId: '<string>',
iconSrc: '<string>',
iconUrl: '<string>',
beamTool: true,
gptTool: true,
consentRequired: true,
integrationId: '<string>',
isIntegrationRequired: true,
isIntegrationConnected: true,
integrationProvider: '<string>',
integrationIdentifier: '<string>',
toolDetail: {},
integrationCustomAuthParameters: {}
}
],
default: true,
category: {id: '<string>', title: '<string>'},
lastUpdatedAt: '2023-11-07T05:31:56Z'
}
],
preferredModel: '<string>',
instructions: '<string>'
})
};
fetch('https://api.beamstudio.ai/agent/{agentId}', 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/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'agentConfig' => [
'restrictions' => '<string>',
'taskTemplates' => [
[
'id' => '<string>',
'objective' => '<string>',
'description' => '<string>',
'steps' => [
[
'step' => '<string>',
'toolId' => '<string>',
'iconSrc' => '<string>',
'iconUrl' => '<string>',
'beamTool' => true,
'gptTool' => true,
'consentRequired' => true,
'integrationId' => '<string>',
'isIntegrationRequired' => true,
'isIntegrationConnected' => true,
'integrationProvider' => '<string>',
'integrationIdentifier' => '<string>',
'toolDetail' => [
],
'integrationCustomAuthParameters' => [
]
]
],
'default' => true,
'category' => [
'id' => '<string>',
'title' => '<string>'
],
'lastUpdatedAt' => '2023-11-07T05:31:56Z'
]
],
'tools' => [
'<string>'
],
'llmTools' => [
[
]
],
'sop' => [
],
'defaultTaskId' => '<string>',
'workspaceId' => '<string>'
],
'vectorDbId' => '<string>',
'workspaceId' => '<string>',
'agentCategoryId' => '<string>',
'themeIconUrl' => '<string>',
'personality' => '<string>',
'userAccessTokenId' => '<string>',
'agentIntroMessage' => '<string>',
'agentSetupMessage' => '<string>',
'agentSetupSessionId' => '<string>',
'skipAgentSetupSop' => true,
'isAttachmentDataPulledIn' => true,
'tools' => [
'<string>'
],
'templates' => [
[
'id' => '<string>',
'objective' => '<string>',
'description' => '<string>',
'steps' => [
[
'step' => '<string>',
'toolId' => '<string>',
'iconSrc' => '<string>',
'iconUrl' => '<string>',
'beamTool' => true,
'gptTool' => true,
'consentRequired' => true,
'integrationId' => '<string>',
'isIntegrationRequired' => true,
'isIntegrationConnected' => true,
'integrationProvider' => '<string>',
'integrationIdentifier' => '<string>',
'toolDetail' => [
],
'integrationCustomAuthParameters' => [
]
]
],
'default' => true,
'category' => [
'id' => '<string>',
'title' => '<string>'
],
'lastUpdatedAt' => '2023-11-07T05:31:56Z'
]
],
'preferredModel' => '<string>',
'instructions' => '<string>'
]),
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/{agentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agentConfig\": {\n \"restrictions\": \"<string>\",\n \"taskTemplates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"llmTools\": [\n {}\n ],\n \"sop\": {},\n \"defaultTaskId\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"vectorDbId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"themeIconUrl\": \"<string>\",\n \"personality\": \"<string>\",\n \"userAccessTokenId\": \"<string>\",\n \"agentIntroMessage\": \"<string>\",\n \"agentSetupMessage\": \"<string>\",\n \"agentSetupSessionId\": \"<string>\",\n \"skipAgentSetupSop\": true,\n \"isAttachmentDataPulledIn\": true,\n \"tools\": [\n \"<string>\"\n ],\n \"templates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"preferredModel\": \"<string>\",\n \"instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.beamstudio.ai/agent/{agentId}")
.header("current-workspace-id", "<current-workspace-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agentConfig\": {\n \"restrictions\": \"<string>\",\n \"taskTemplates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"llmTools\": [\n {}\n ],\n \"sop\": {},\n \"defaultTaskId\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"vectorDbId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"themeIconUrl\": \"<string>\",\n \"personality\": \"<string>\",\n \"userAccessTokenId\": \"<string>\",\n \"agentIntroMessage\": \"<string>\",\n \"agentSetupMessage\": \"<string>\",\n \"agentSetupSessionId\": \"<string>\",\n \"skipAgentSetupSop\": true,\n \"isAttachmentDataPulledIn\": true,\n \"tools\": [\n \"<string>\"\n ],\n \"templates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"preferredModel\": \"<string>\",\n \"instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beamstudio.ai/agent/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["current-workspace-id"] = '<current-workspace-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agentConfig\": {\n \"restrictions\": \"<string>\",\n \"taskTemplates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"llmTools\": [\n {}\n ],\n \"sop\": {},\n \"defaultTaskId\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"vectorDbId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"themeIconUrl\": \"<string>\",\n \"personality\": \"<string>\",\n \"userAccessTokenId\": \"<string>\",\n \"agentIntroMessage\": \"<string>\",\n \"agentSetupMessage\": \"<string>\",\n \"agentSetupSessionId\": \"<string>\",\n \"skipAgentSetupSop\": true,\n \"isAttachmentDataPulledIn\": true,\n \"tools\": [\n \"<string>\"\n ],\n \"templates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"preferredModel\": \"<string>\",\n \"instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAgents
Update Agent
Update an agent by id within the current workspace.
PUT
/
agent
/
{agentId}
Update Agent
curl --request PUT \
--url https://api.beamstudio.ai/agent/{agentId} \
--header 'Content-Type: application/json' \
--header 'current-workspace-id: <current-workspace-id>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"agentConfig": {
"restrictions": "<string>",
"taskTemplates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": true,
"gptTool": true,
"consentRequired": true,
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": true,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"tools": [
"<string>"
],
"llmTools": [
{}
],
"sop": {},
"defaultTaskId": "<string>",
"workspaceId": "<string>"
},
"vectorDbId": "<string>",
"workspaceId": "<string>",
"agentCategoryId": "<string>",
"themeIconUrl": "<string>",
"personality": "<string>",
"userAccessTokenId": "<string>",
"agentIntroMessage": "<string>",
"agentSetupMessage": "<string>",
"agentSetupSessionId": "<string>",
"skipAgentSetupSop": true,
"isAttachmentDataPulledIn": true,
"tools": [
"<string>"
],
"templates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": true,
"gptTool": true,
"consentRequired": true,
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": true,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"preferredModel": "<string>",
"instructions": "<string>"
}
'import requests
url = "https://api.beamstudio.ai/agent/{agentId}"
payload = {
"name": "<string>",
"description": "<string>",
"agentConfig": {
"restrictions": "<string>",
"taskTemplates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": True,
"gptTool": True,
"consentRequired": True,
"integrationId": "<string>",
"isIntegrationRequired": True,
"isIntegrationConnected": True,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": True,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"tools": ["<string>"],
"llmTools": [{}],
"sop": {},
"defaultTaskId": "<string>",
"workspaceId": "<string>"
},
"vectorDbId": "<string>",
"workspaceId": "<string>",
"agentCategoryId": "<string>",
"themeIconUrl": "<string>",
"personality": "<string>",
"userAccessTokenId": "<string>",
"agentIntroMessage": "<string>",
"agentSetupMessage": "<string>",
"agentSetupSessionId": "<string>",
"skipAgentSetupSop": True,
"isAttachmentDataPulledIn": True,
"tools": ["<string>"],
"templates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": True,
"gptTool": True,
"consentRequired": True,
"integrationId": "<string>",
"isIntegrationRequired": True,
"isIntegrationConnected": True,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": True,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"preferredModel": "<string>",
"instructions": "<string>"
}
headers = {
"current-workspace-id": "<current-workspace-id>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'current-workspace-id': '<current-workspace-id>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
agentConfig: {
restrictions: '<string>',
taskTemplates: [
{
id: '<string>',
objective: '<string>',
description: '<string>',
steps: [
{
step: '<string>',
toolId: '<string>',
iconSrc: '<string>',
iconUrl: '<string>',
beamTool: true,
gptTool: true,
consentRequired: true,
integrationId: '<string>',
isIntegrationRequired: true,
isIntegrationConnected: true,
integrationProvider: '<string>',
integrationIdentifier: '<string>',
toolDetail: {},
integrationCustomAuthParameters: {}
}
],
default: true,
category: {id: '<string>', title: '<string>'},
lastUpdatedAt: '2023-11-07T05:31:56Z'
}
],
tools: ['<string>'],
llmTools: [{}],
sop: {},
defaultTaskId: '<string>',
workspaceId: '<string>'
},
vectorDbId: '<string>',
workspaceId: '<string>',
agentCategoryId: '<string>',
themeIconUrl: '<string>',
personality: '<string>',
userAccessTokenId: '<string>',
agentIntroMessage: '<string>',
agentSetupMessage: '<string>',
agentSetupSessionId: '<string>',
skipAgentSetupSop: true,
isAttachmentDataPulledIn: true,
tools: ['<string>'],
templates: [
{
id: '<string>',
objective: '<string>',
description: '<string>',
steps: [
{
step: '<string>',
toolId: '<string>',
iconSrc: '<string>',
iconUrl: '<string>',
beamTool: true,
gptTool: true,
consentRequired: true,
integrationId: '<string>',
isIntegrationRequired: true,
isIntegrationConnected: true,
integrationProvider: '<string>',
integrationIdentifier: '<string>',
toolDetail: {},
integrationCustomAuthParameters: {}
}
],
default: true,
category: {id: '<string>', title: '<string>'},
lastUpdatedAt: '2023-11-07T05:31:56Z'
}
],
preferredModel: '<string>',
instructions: '<string>'
})
};
fetch('https://api.beamstudio.ai/agent/{agentId}', 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/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'agentConfig' => [
'restrictions' => '<string>',
'taskTemplates' => [
[
'id' => '<string>',
'objective' => '<string>',
'description' => '<string>',
'steps' => [
[
'step' => '<string>',
'toolId' => '<string>',
'iconSrc' => '<string>',
'iconUrl' => '<string>',
'beamTool' => true,
'gptTool' => true,
'consentRequired' => true,
'integrationId' => '<string>',
'isIntegrationRequired' => true,
'isIntegrationConnected' => true,
'integrationProvider' => '<string>',
'integrationIdentifier' => '<string>',
'toolDetail' => [
],
'integrationCustomAuthParameters' => [
]
]
],
'default' => true,
'category' => [
'id' => '<string>',
'title' => '<string>'
],
'lastUpdatedAt' => '2023-11-07T05:31:56Z'
]
],
'tools' => [
'<string>'
],
'llmTools' => [
[
]
],
'sop' => [
],
'defaultTaskId' => '<string>',
'workspaceId' => '<string>'
],
'vectorDbId' => '<string>',
'workspaceId' => '<string>',
'agentCategoryId' => '<string>',
'themeIconUrl' => '<string>',
'personality' => '<string>',
'userAccessTokenId' => '<string>',
'agentIntroMessage' => '<string>',
'agentSetupMessage' => '<string>',
'agentSetupSessionId' => '<string>',
'skipAgentSetupSop' => true,
'isAttachmentDataPulledIn' => true,
'tools' => [
'<string>'
],
'templates' => [
[
'id' => '<string>',
'objective' => '<string>',
'description' => '<string>',
'steps' => [
[
'step' => '<string>',
'toolId' => '<string>',
'iconSrc' => '<string>',
'iconUrl' => '<string>',
'beamTool' => true,
'gptTool' => true,
'consentRequired' => true,
'integrationId' => '<string>',
'isIntegrationRequired' => true,
'isIntegrationConnected' => true,
'integrationProvider' => '<string>',
'integrationIdentifier' => '<string>',
'toolDetail' => [
],
'integrationCustomAuthParameters' => [
]
]
],
'default' => true,
'category' => [
'id' => '<string>',
'title' => '<string>'
],
'lastUpdatedAt' => '2023-11-07T05:31:56Z'
]
],
'preferredModel' => '<string>',
'instructions' => '<string>'
]),
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/{agentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agentConfig\": {\n \"restrictions\": \"<string>\",\n \"taskTemplates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"llmTools\": [\n {}\n ],\n \"sop\": {},\n \"defaultTaskId\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"vectorDbId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"themeIconUrl\": \"<string>\",\n \"personality\": \"<string>\",\n \"userAccessTokenId\": \"<string>\",\n \"agentIntroMessage\": \"<string>\",\n \"agentSetupMessage\": \"<string>\",\n \"agentSetupSessionId\": \"<string>\",\n \"skipAgentSetupSop\": true,\n \"isAttachmentDataPulledIn\": true,\n \"tools\": [\n \"<string>\"\n ],\n \"templates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"preferredModel\": \"<string>\",\n \"instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.beamstudio.ai/agent/{agentId}")
.header("current-workspace-id", "<current-workspace-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agentConfig\": {\n \"restrictions\": \"<string>\",\n \"taskTemplates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"llmTools\": [\n {}\n ],\n \"sop\": {},\n \"defaultTaskId\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"vectorDbId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"themeIconUrl\": \"<string>\",\n \"personality\": \"<string>\",\n \"userAccessTokenId\": \"<string>\",\n \"agentIntroMessage\": \"<string>\",\n \"agentSetupMessage\": \"<string>\",\n \"agentSetupSessionId\": \"<string>\",\n \"skipAgentSetupSop\": true,\n \"isAttachmentDataPulledIn\": true,\n \"tools\": [\n \"<string>\"\n ],\n \"templates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"preferredModel\": \"<string>\",\n \"instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beamstudio.ai/agent/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["current-workspace-id"] = '<current-workspace-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agentConfig\": {\n \"restrictions\": \"<string>\",\n \"taskTemplates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"llmTools\": [\n {}\n ],\n \"sop\": {},\n \"defaultTaskId\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"vectorDbId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"themeIconUrl\": \"<string>\",\n \"personality\": \"<string>\",\n \"userAccessTokenId\": \"<string>\",\n \"agentIntroMessage\": \"<string>\",\n \"agentSetupMessage\": \"<string>\",\n \"agentSetupSessionId\": \"<string>\",\n \"skipAgentSetupSop\": true,\n \"isAttachmentDataPulledIn\": true,\n \"tools\": [\n \"<string>\"\n ],\n \"templates\": [\n {\n \"id\": \"<string>\",\n \"objective\": \"<string>\",\n \"description\": \"<string>\",\n \"steps\": [\n {\n \"step\": \"<string>\",\n \"toolId\": \"<string>\",\n \"iconSrc\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"beamTool\": true,\n \"gptTool\": true,\n \"consentRequired\": true,\n \"integrationId\": \"<string>\",\n \"isIntegrationRequired\": true,\n \"isIntegrationConnected\": true,\n \"integrationProvider\": \"<string>\",\n \"integrationIdentifier\": \"<string>\",\n \"toolDetail\": {},\n \"integrationCustomAuthParameters\": {}\n }\n ],\n \"default\": true,\n \"category\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"lastUpdatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"preferredModel\": \"<string>\",\n \"instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Headers
Path Parameters
The unique identifier of the agent to update
Body
application/json
Maximum string length:
100Maximum string length:
500Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
beam-os, user-agent, pre-configured-agent Show child attributes
Show child attributes
Response
200
Agent updated successfully
⌘I