Get a topic proposal
curl --request GET \
--url http://localhost:3500/v1/alert-topic-proposals/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/alert-topic-proposals/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/alert-topic-proposals/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"operation": "merge",
"topic_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"instructions": "<string>",
"topics": [
{
"ref": "<string>",
"title": "<string>",
"description": "<string>",
"key_questions": [
"<string>"
],
"citations": [
{
"source_ref": 123,
"citation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"quote": "<string>",
"text": "<string>",
"verification": "verified",
"verification_score": 123,
"available": true,
"source_type": "document",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_name": "<string>",
"page": "<string>",
"section_title": "<string>",
"context_before": "<string>",
"context_after": "<string>",
"original_quote": "<string>"
}
]
}
],
"groups": [
{
"ref": "<string>",
"kind": "single_alert",
"topic_ref": "<string>",
"alert_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"source_topic_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"title": "<string>",
"message": "<string>",
"line_item": "<string>",
"pricing": "<string>"
}
],
"warnings": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"applied_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Alerts
Get a topic proposal
The proposed topics, their citations and where each alert group goes. applied_at is set once the proposal has been applied.
Get a topic proposal
curl --request GET \
--url http://localhost:3500/v1/alert-topic-proposals/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/alert-topic-proposals/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/alert-topic-proposals/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"operation": "merge",
"topic_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"instructions": "<string>",
"topics": [
{
"ref": "<string>",
"title": "<string>",
"description": "<string>",
"key_questions": [
"<string>"
],
"citations": [
{
"source_ref": 123,
"citation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"quote": "<string>",
"text": "<string>",
"verification": "verified",
"verification_score": 123,
"available": true,
"source_type": "document",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_name": "<string>",
"page": "<string>",
"section_title": "<string>",
"context_before": "<string>",
"context_after": "<string>",
"original_quote": "<string>"
}
]
}
],
"groups": [
{
"ref": "<string>",
"kind": "single_alert",
"topic_ref": "<string>",
"alert_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"source_topic_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"title": "<string>",
"message": "<string>",
"line_item": "<string>",
"pricing": "<string>"
}
],
"warnings": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"applied_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
ApiKeyBearerClerkSessionBearer
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.
Path Parameters
Response
The topic proposal.
Available options:
merge, split The topics the proposal replaces.
The topics applying creates.
Show child attributes
Show child attributes
Alerts that move together. Every alert of the selected topics is in one group.
Show child attributes
Show child attributes