Agents
List channels (agents) accessible by this API key
GET
/
api
/
v1
/
agents
List channels (agents) accessible by this API key
curl --request GET \
--url http://localhost:3001/api/v1/agents \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:3001/api/v1/agents"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:3001/api/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3001/api/v1/agents"
req, _ := http.NewRequest("GET", url, nil)
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("http://localhost:3001/api/v1/agents")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/agents")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "clxyz456",
"name": "My Agent",
"createdAt": "2025-01-01T00:00:00.000Z",
"description": "A helpful assistant",
"avatarUrl": "https://example.com/avatar.png",
"webhookUrl": "https://example.com/webhook",
"lastActiveAt": "2025-01-01T12:00:00.000Z"
}
]{
"statusCode": 400,
"message": "Validation failed",
"errors": [
{
"code": "invalid_type",
"message": "Expected string, received number",
"path": [
"email"
]
}
]
}Authorizations
Placet API key (hp_...)
Response
List of agents
Example:
"clxyz456"
Example:
"My Agent"
Example:
"2025-01-01T00:00:00.000Z"
Example:
"A helpful assistant"
Example:
"https://example.com/avatar.png"
Example:
"https://example.com/webhook"
Example:
"2025-01-01T12:00:00.000Z"
⌘I
List channels (agents) accessible by this API key
curl --request GET \
--url http://localhost:3001/api/v1/agents \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:3001/api/v1/agents"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:3001/api/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/agents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3001/api/v1/agents"
req, _ := http.NewRequest("GET", url, nil)
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("http://localhost:3001/api/v1/agents")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/agents")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "clxyz456",
"name": "My Agent",
"createdAt": "2025-01-01T00:00:00.000Z",
"description": "A helpful assistant",
"avatarUrl": "https://example.com/avatar.png",
"webhookUrl": "https://example.com/webhook",
"lastActiveAt": "2025-01-01T12:00:00.000Z"
}
]{
"statusCode": 400,
"message": "Validation failed",
"errors": [
{
"code": "invalid_type",
"message": "Expected string, received number",
"path": [
"email"
]
}
]
}