Get Frontend Action
curl --request GET \
--url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id} \
--header 'apikey: <api-key>'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}', 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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_id": "myapp_onUserClick",
"appId": "my-app-id",
"name": "User Click Action",
"description": "Triggered when a user clicks a button",
"triggerFunction": "onUserClick",
"icon": "https://example.com/icon.png",
"parameters": [
{
"key": "userId",
"type": "string",
"description": "The user identifier",
"required": true
}
],
"tool": {
"name": "onUserClick",
"description": "Triggered when a user clicks a button",
"parameters": {
"type": "object",
"properties": {},
"required": []
}
},
"createdAt": 1700000000000,
"updatedAt": 1700000000000
}Get Frontend Action
Retrieves a specific frontend action by its unique ID. Use this endpoint to inspect a frontend action’s configuration, parameters, and trigger function.
GET
/
ai-agents
/
agent-builder
/
frontend-actions
/
{id}
Get Frontend Action
curl --request GET \
--url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id} \
--header 'apikey: <api-key>'import requests
url = "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}', 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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/frontend-actions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_id": "myapp_onUserClick",
"appId": "my-app-id",
"name": "User Click Action",
"description": "Triggered when a user clicks a button",
"triggerFunction": "onUserClick",
"icon": "https://example.com/icon.png",
"parameters": [
{
"key": "userId",
"type": "string",
"description": "The user identifier",
"required": true
}
],
"tool": {
"name": "onUserClick",
"description": "Triggered when a user clicks a button",
"parameters": {
"type": "object",
"properties": {},
"required": []
}
},
"createdAt": 1700000000000,
"updatedAt": 1700000000000
}Authorizations
API Key (i.e. Rest API Key from the Dashboard).
Path Parameters
Response
200 - application/json
Frontend action details
Example:
"myapp_onUserClick"
Example:
"my-app-id"
Example:
"User Click Action"
Example:
"Triggered when a user clicks a button"
Example:
"onUserClick"
Example:
"https://example.com/icon.png"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
1700000000000
Example:
1700000000000
Was this page helpful?
⌘I