Notifications
A Notifications API dá a você acesso programático ao seu próprio feed de notificações. Liste notificações com cursor pagination, marque-as como lidas ou não lidas, e exclua as que você não precisa mais.
Quick Start
- REST API
- CLI
# List your notification feed (cursor pagination)
curl -X GET https://api.copera.ai/public/v1/notifications \
-H "Authorization: Bearer cp_pat_YOUR_TOKEN"
# Mark a notification as read
curl -X PATCH https://api.copera.ai/public/v1/notifications/NOTIFICATION_ID \
-H "Authorization: Bearer cp_pat_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "status": "read" }'
# Delete a notification
curl -X DELETE https://api.copera.ai/public/v1/notifications/NOTIFICATION_ID \
-H "Authorization: Bearer cp_pat_YOUR_TOKEN"
curl -fsSL https://cli.copera.ai/install.sh | bash
# Notifications commands require a Personal Access Token
copera notifications list
# Mark read / unread
copera notifications read <notification-id>
copera notifications unread <notification-id>
# Delete
copera notifications delete <notification-id> --force
Disponível em
| Public API | CLI | MCP | Copera AI |
|---|---|---|---|
| ✅ Completo | ✅ Completo | ✅ Completo | — |
A CLI e o servidor MCP hospedado cobrem listagem, mudanças de status e exclusão. As notificações não são expostas ao assistente Copera AI dentro do app.
O modelo de notificação
Uma notificação pertence a um único usuário em um único workspace. Cada uma carrega:
type— que tipo de evento ela representa.status—READouUNREAD.data— um payload específico do tipo descrevendo o evento.sender— quem a disparou (quando aplicável), além dereadAte timestamps.- Campos de agrupamento —
groupCount,groupStartedAtegroupSenderIdspara notificações que agrupam vários eventos relacionados.
Listando notificações
Faça um GET no endpoint de notifications para recuperar seu feed. Ele usa cursor pagination baseado em ids de notificação:
after— retorna notificações mais recentes que este id.before— retorna notificações mais antigas que este id.
A resposta inclui o array notifications, o count total e o unreadCount atual:
{
"notifications": [ /* … */ ],
"count": 40,
"unreadCount": 3
}
Veja Paginação para as convenções de cursor.
Marcando como lida ou não lida
Faça um PATCH em uma única notificação com um status de read ou unread:
curl -X PATCH "https://api.copera.ai/public/v1/notifications/{notificationId}" \
-H "Authorization: Bearer cp_pat_YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "status": "read" }'
A resposta é o objeto da notificação atualizado.
Excluindo uma notificação
Faça um DELETE em uma notificação para removê-la do seu feed. A resposta retorna o _id da notificação excluída.
Autenticação e escopo
Os endpoints de Notifications requerem um Personal Access Token (cp_pat_) com o escopo access_notifications — eles sempre operam no próprio feed do detentor do token. Um token sem o escopo recebe um 403. Veja Autenticação.
Referência
- Notifications na API Reference — endpoints de listar, atualizar status e excluir com schemas completos.
- Paginação — o modelo de cursor
after/before. - Copera CLI e servidor MCP.