List agents in the API key workspace
curl --request GET \
--url https://app.communicate.so/api/v1/agents \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.communicate.so/api/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/agents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"id": "<string>",
"name": "<string>",
"status": "active"
}
]{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}Agents
List agents in the API key workspace
Returns the agents visible to the authenticated workspace API key. This route is non-streaming and shares the public API group rate limit of 600 requests per minute per key.
GET
/
agents
List agents in the API key workspace
curl --request GET \
--url https://app.communicate.so/api/v1/agents \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.communicate.so/api/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/agents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"id": "<string>",
"name": "<string>",
"status": "active"
}
]{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>",
"reason": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}Authorizations
oauth2bearerAuth
OAuth 2.0 client-credentials tokens bounded by the source API key scope ceiling.
FlowClient Credentials
- Token URL
- https://app.communicate.so/api/v1/oauth/token
Scopes1
agents:read
List agents in the authenticated workspace.