{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coram alerts API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "alerts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get alert video clip",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://developer.coram.ai/v1/alerts/:alert_event_id/clip",
            "params": [
              {
                "name": "alert_event_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Returns a public download URL for the MP4 video clip associated with an alert event. The URL does not require authentication and expires after 24 hours. Use the alert_event_id from webhook payloads to retrieve the corresponding video clip."
        },
        {
          "info": {
            "name": "Get firearm alert feedback",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://developer.coram.ai/v1/alerts/:alert_event_id/feedback",
            "params": [
              {
                "name": "alert_event_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Returns the current feedback (0.0-1.0 rating, reason, comment) for a firearm alert event. Feedback is organization-wide (last write wins); the feedback fields are null when no feedback has been submitted yet. Returns 404 if the alert event does not exist and 400 if it is not a firearm alert."
        },
        {
          "info": {
            "name": "Submit firearm alert feedback",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://developer.coram.ai/v1/alerts/:alert_event_id/feedback",
            "params": [
              {
                "name": "alert_event_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Submits feedback for a firearm alert event. rating is a 0.0-1.0 score (today 0.0 = incorrect / unhelpful, 1.0 = correct). Feedback is organization-wide and idempotent (last write wins): submitting again replaces the previous feedback. feedback_reason and feedback_comment are optional. Returns 404 if the alert event does not exist and 400 if it is not a firearm alert."
        },
        {
          "info": {
            "name": "Get alert details (including AI description)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://developer.coram.ai/v1/alerts/:alert_event_id/details",
            "params": [
              {
                "name": "alert_event_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Returns metadata about an alert event, including the rich natural-language description generated by Coram's vision language model. The description is produced asynchronously after the alert webhook fires, so consumers polling immediately may see `ai.status: pending` for a few seconds. Once `ai.status` is `ready`, the `ai.short_description` and `ai.long_description` fields are populated. If it is `failed`, no description will arrive.\n\nWhen a video clip is being produced for the alert, a `clip` ob"
        },
        {
          "info": {
            "name": "Create firearm alert",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://developer.coram.ai/v1/alerts/firearm",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Creates a firearm-detection alert configuration. Recipients are specified by email (matched case-insensitively) and resolved to platform users in your organization; each recipient's notify_by_sms/notify_by_push only deliver when the user has a phone number / registered device. The schedule is interpreted in each camera's local time. The alert is attributed to the API key (creator_name = the key's identity). Note: a null name is omitted from the response rather than serialized as null."
        },
        {
          "info": {
            "name": "Update firearm alert",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://developer.coram.ai/v1/alerts/firearm/:firearm_alert_id",
            "params": [
              {
                "name": "firearm_alert_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Partially updates a firearm-detection alert configuration; only the provided fields are changed. Providing recipients replaces the full recipient list. The schedule is interpreted in each camera's local time. Note: a null name is omitted from the response rather than serialized as null."
        },
        {
          "info": {
            "name": "Delete firearm alert",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://developer.coram.ai/v1/alerts/firearm/:firearm_alert_id",
            "params": [
              {
                "name": "firearm_alert_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "Deletes a firearm-detection alert configuration and any alerts it has produced. Returns 204 on success and 404 if the firearm alert does not exist in your organization."
        }
      ]
    }
  ],
  "bundled": true
}