Get Tool Output Schema
curl --request GET \
--url https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId} \
--header 'current-workspace-id: <current-workspace-id>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}"
headers = {
"current-workspace-id": "<current-workspace-id>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'current-workspace-id': '<current-workspace-id>', 'x-api-key': '<api-key>'}
};
fetch('https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}', 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-tasks/tool-output-schema/{graphNodeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("current-workspace-id", "<current-workspace-id>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}")
.header("current-workspace-id", "<current-workspace-id>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["current-workspace-id"] = '<current-workspace-id>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
]Agent Task
Get Tool Output Schema
Retrieve the expected output schema for a specific tool in the agent graph.
GET
/
agent-tasks
/
tool-output-schema
/
{graphNodeId}
Get Tool Output Schema
curl --request GET \
--url https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId} \
--header 'current-workspace-id: <current-workspace-id>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}"
headers = {
"current-workspace-id": "<current-workspace-id>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'current-workspace-id': '<current-workspace-id>', 'x-api-key': '<api-key>'}
};
fetch('https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}', 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-tasks/tool-output-schema/{graphNodeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("current-workspace-id", "<current-workspace-id>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}")
.header("current-workspace-id", "<current-workspace-id>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beamstudio.ai/agent-tasks/tool-output-schema/{graphNodeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["current-workspace-id"] = '<current-workspace-id>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
]Response
200 - application/json
Tool output schema retrieved successfully