Skip to main content
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>'
[
  {
    "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"
  }
]

Authorizations

​
x-api-key
string
header
required

Placet API key (hp_...)

Response

List of agents

​
id
string
required
Example:

"clxyz456"

​
name
string
required
Example:

"My Agent"

​
createdAt
string
required
Example:

"2025-01-01T00:00:00.000Z"

​
description
string
Example:

"A helpful assistant"

​
avatarUrl
string
Example:

"https://example.com/avatar.png"

​
webhookUrl
string
Example:

"https://example.com/webhook"

​
lastActiveAt
string
Example:

"2025-01-01T12:00:00.000Z"