Create multiple monitoring prompts
curl --request POST \
--url https://app.chatobserver.com/api/v2/prompts/bulk \
--header 'Content-Type: application/json' \
--header 'x-chatobserver-key: <api-key>' \
--data '
{
"prompts": [
{
"promptText": "<string>",
"schedule": {
"frequency": "daily",
"timezone": "UTC",
"hour": 11,
"minute": 29,
"daysOfWeek": [
3
]
},
"description": "<string>",
"personaIds": [
"<string>"
],
"targetPlatforms": [],
"targetRegions": [],
"tagIds": [
"<string>"
]
}
]
}
'const options = {
method: 'POST',
headers: {'x-chatobserver-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompts: [
{
promptText: '<string>',
schedule: {frequency: 'daily', timezone: 'UTC', hour: 11, minute: 29, daysOfWeek: [3]},
description: '<string>',
personaIds: ['<string>'],
targetPlatforms: [],
targetRegions: [],
tagIds: ['<string>']
}
]
})
};
fetch('https://app.chatobserver.com/api/v2/prompts/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.chatobserver.com/api/v2/prompts/bulk"
payload = { "prompts": [
{
"promptText": "<string>",
"schedule": {
"frequency": "daily",
"timezone": "UTC",
"hour": 11,
"minute": 29,
"daysOfWeek": [3]
},
"description": "<string>",
"personaIds": ["<string>"],
"targetPlatforms": [],
"targetRegions": [],
"tagIds": ["<string>"]
}
] }
headers = {
"x-chatobserver-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"success": false,
"affectedCount": 123,
"message": null
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"requestId": "<string>"
}Prompts
Create multiple monitoring prompts
Create, schedule, organise, activate and retrieve tracked prompts.
POST
/
api
/
v2
/
prompts
/
bulk
Create multiple monitoring prompts
curl --request POST \
--url https://app.chatobserver.com/api/v2/prompts/bulk \
--header 'Content-Type: application/json' \
--header 'x-chatobserver-key: <api-key>' \
--data '
{
"prompts": [
{
"promptText": "<string>",
"schedule": {
"frequency": "daily",
"timezone": "UTC",
"hour": 11,
"minute": 29,
"daysOfWeek": [
3
]
},
"description": "<string>",
"personaIds": [
"<string>"
],
"targetPlatforms": [],
"targetRegions": [],
"tagIds": [
"<string>"
]
}
]
}
'const options = {
method: 'POST',
headers: {'x-chatobserver-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompts: [
{
promptText: '<string>',
schedule: {frequency: 'daily', timezone: 'UTC', hour: 11, minute: 29, daysOfWeek: [3]},
description: '<string>',
personaIds: ['<string>'],
targetPlatforms: [],
targetRegions: [],
tagIds: ['<string>']
}
]
})
};
fetch('https://app.chatobserver.com/api/v2/prompts/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.chatobserver.com/api/v2/prompts/bulk"
payload = { "prompts": [
{
"promptText": "<string>",
"schedule": {
"frequency": "daily",
"timezone": "UTC",
"hour": 11,
"minute": 29,
"daysOfWeek": [3]
},
"description": "<string>",
"personaIds": ["<string>"],
"targetPlatforms": [],
"targetRegions": [],
"tagIds": ["<string>"]
}
] }
headers = {
"x-chatobserver-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"success": false,
"affectedCount": 123,
"message": null
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
},
"requestId": "<string>"
}Required scopes:
read, write.Authorizations
WorkspaceKeyBearerKey
A workspace API key. Data endpoints require a service-account key with the specified scopes.
Headers
Unique key for one logical command. Reuse it only when retrying the same request and payload.
Maximum string length:
255Body
application/json
Required array length:
1 - 50 elementsShow child attributes
Show child attributes
Response
Created successfully.
Show child attributes
Show child attributes