How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coram Ai alerts API

The alerts API from Coram Ai — 5 operation(s) for alerts.

Coram Ai alerts API is one of 8 APIs that Coram Ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 7 operations across 5 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://developer.coram.ai.

7 operations 5 paths 23 schemas 1 DELETE3 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.coram.ai/developer-api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Coram Ai alerts API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (X-Auth-Token). By default, every request must be authenticated.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

alerts 7
GET
/v1/alerts/{alert_event_id}/clip
Get alert video clip
get_alert_clip 1 param → 200422
GET
/v1/alerts/{alert_event_id}/feedback
Get firearm alert feedback
get_firearm_alert_feedback 1 param → 200422
PUT
/v1/alerts/{alert_event_id}/feedback
Submit firearm alert feedback
submit_firearm_alert_feedback 1 param body → 200422
GET
/v1/alerts/{alert_event_id}/details
Get alert details (including AI description)
get_alert_details 1 param → 200422
POST
/v1/alerts/firearm
Create firearm alert
create_firearm_alert body → 201400403404409422
DELETE
/v1/alerts/firearm/{firearm_alert_id}
Delete firearm alert
delete_firearm_alert 1 param → 204403404422
PATCH
/v1/alerts/firearm/{firearm_alert_id}
Update firearm alert
update_firearm_alert 1 param body → 200400403404409422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are FirearmAlertResponse (9 properties), CreateFirearmAlertRequest (7 properties), UpdateFirearmAlertRequest (7 properties), AlertClipResponse (7 properties). Each schema is shown below with its type and property counts.

UpdateFirearmAlertRequest
object
7 properties
CreateFirearmAlertRequest
object
7 properties 2 required
FirearmAlertRecipient
object
A platform user (resolved by email) to notify, with per-channel toggles.
4 properties 1 required
FirearmAlertSchedule
object
When the alert is active, expressed in camera-local (naive) time.
3 properties
ErrorResponse
object
Error response model.
2 properties 1 required
ValidationError
object
3 properties 3 required
AIDescriptionStatus
string
Status of the AI-generated alert description. The description is produced asynchronously by a vision language model after the alert is emitted, so consumers po…
AlertAIDescriptionInfo
object
AI-generated description of an alert, grouped the way clip is. Shared by the alert details endpoint and the cameraalertdetails webhook so both carry the identi…
3 properties 1 required
AlertFeedbackReason
string
Structured feedback reasons for thumbs down.
AlertClipInfo
object
Video clip associated with an alert. Present only when a clip exists for the alert (today: firearm alerts with auto clip download enabled). The mp4url/expiresa…
3 properties 1 required
ClipStatus
string
Status of the video clip associated with an alert. Mirrors AIDescriptionStatus: the clip is produced asynchronously (the edge device uploads it after the alert…
AlertDetailsResponse
object
Response for the alert details endpoint. Returns metadata about an alert event, including the rich natural-language description generated by Coram's vision lan…
5 properties 4 required
DayOfWeek
An enumeration.
FirearmAlertFeedbackResponse
object
Current feedback for a firearm alert (organization-wide, last write wins).
6 properties 1 required
FirearmAlertFeedbackRequest
object
Request body for submitting feedback on a firearm alert.
3 properties 1 required
ErrorDetails
object
Error message
4 properties 2 required
HTTPValidationError
object
1 property
FirearmAlertResponse
object
9 properties 8 required
HandgunStanceType
An enumeration.
AlertClipResponse
object
Response for the alert clip download endpoint.
7 properties 7 required
AlertSensitivityLevel
string
An enumeration.
PushNotificationLevel
string
Defines the interruption level for mobile push notifications. This level determines the notification priority and how it will interrupt the user: - ACTIVE: Sta…
ErrorCode
string
Centralized error codes for Developer API endpoints.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coram-ai-alerts-api-openapi.yml Raw ↑

Other APIs Coram Ai publishes across the network.

Coram Ai camera-groups API
Coram Ai cameras API
Coram Ai doors API
Coram Ai events API
Coram Ai locations API
Coram Ai nvrs API
Coram Ai reunification API
Where this information came from

This is an independent, third-party profile of Coram Ai alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.