Read an accessible agent and its settings
curl --request GET \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"systemPrompt": "<string>",
"status": "active",
"inTransfer": true,
"model": "<string>",
"temperature": 123,
"rateLimitPerMinute": 0,
"allowedDomains": [
"<string>"
],
"widgetConfig": {
"accentColor": "<string>",
"displayName": "<string>",
"greeting": "<string>",
"suggestedPrompts": [
"<string>"
],
"promptGroups": [
{
"title": "<string>",
"prompts": [
"<string>"
]
}
],
"labels": {
"locale": "en",
"composerPlaceholder": "<string>",
"sendButton": "<string>",
"openButton": "<string>",
"poweredBy": "<string>"
},
"messagePlaceholder": "<string>",
"privacyPolicyUrl": "<string>",
"dictationEnabled": true,
"showPoweredBy": true,
"bubblePosition": "right",
"socialLinks": [
{
"label": "<string>",
"url": "<string>"
}
],
"showSupportEmail": true,
"chatPageTheme": "light",
"widgetEnabled": true
},
"notifyConfig": {
"email": "jsmith@example.com",
"onNewConversation": true
},
"voiceConfig": {
"enabled": true,
"language": "<string>",
"consentCopy": "<string>",
"maxDurationSeconds": 1815,
"voiceId": "<string>"
},
"learningConfig": {
"captureEnabled": true
},
"escalationTeamId": "<string>",
"supportEmail": "<string>",
"website": "<string>",
"logoUrl": "<string>",
"chatPageEnabled": true,
"chatPageBlockedAt": "2023-11-07T05:31:56Z",
"indexable": true,
"emailFromName": "<string>",
"deletionScheduledAt": "2023-11-07T05:31:56Z",
"deletionRequestedBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Agents
Read an accessible agent and its settings
Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.
GET
/
workspaces
/
{workspaceId}
/
agents
/
{agentId}
Read an accessible agent and its settings
curl --request GET \
--url https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"systemPrompt": "<string>",
"status": "active",
"inTransfer": true,
"model": "<string>",
"temperature": 123,
"rateLimitPerMinute": 0,
"allowedDomains": [
"<string>"
],
"widgetConfig": {
"accentColor": "<string>",
"displayName": "<string>",
"greeting": "<string>",
"suggestedPrompts": [
"<string>"
],
"promptGroups": [
{
"title": "<string>",
"prompts": [
"<string>"
]
}
],
"labels": {
"locale": "en",
"composerPlaceholder": "<string>",
"sendButton": "<string>",
"openButton": "<string>",
"poweredBy": "<string>"
},
"messagePlaceholder": "<string>",
"privacyPolicyUrl": "<string>",
"dictationEnabled": true,
"showPoweredBy": true,
"bubblePosition": "right",
"socialLinks": [
{
"label": "<string>",
"url": "<string>"
}
],
"showSupportEmail": true,
"chatPageTheme": "light",
"widgetEnabled": true
},
"notifyConfig": {
"email": "jsmith@example.com",
"onNewConversation": true
},
"voiceConfig": {
"enabled": true,
"language": "<string>",
"consentCopy": "<string>",
"maxDurationSeconds": 1815,
"voiceId": "<string>"
},
"learningConfig": {
"captureEnabled": true
},
"escalationTeamId": "<string>",
"supportEmail": "<string>",
"website": "<string>",
"logoUrl": "<string>",
"chatPageEnabled": true,
"chatPageBlockedAt": "2023-11-07T05:31:56Z",
"indexable": true,
"emailFromName": "<string>",
"deletionScheduledAt": "2023-11-07T05:31:56Z",
"deletionRequestedBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Authorizations
accountBeareraccountSessionlocalAccountSession
Opaque user-bound ca_ account credential. Each request checks live account scopes, verified email, expiry, revocation and the issuer session. Not a workspace ck_ key or OAuth access token.
Path Parameters
Minimum string length:
1Minimum string length:
1Response
Read an accessible agent and its settings
Minimum string length:
1Minimum string length:
1Available options:
active, inactive, draft Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Minimum string length:
1Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Minimum string length:
1Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$