---
title: "Sse Canary"
method: GET
path: "/health/sse-canary"
tags: ["health"]
---

# Sse Canary

`GET /health/sse-canary`

## Request

- Base URL: `https://api.usecreed.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.usecreed.com/health/sse-canary`
- Auth: none declared. Required headers: `x-api-key`
- TypeScript: <https://skmtc.dev/usecreed/apis/creed-api/docs/health/sse-canary/get.ts> (a function with typed inputs; its response is checked against the schema)

Diagnostic SSE stream to verify the ingress path (DO App Platform edge)
delivers Server-Sent Events incrementally instead of buffering or killing
long-lived responses. Each event carries the server-side elapsed time so a
client can compare emission time vs arrival time and spot buffering.

Test with: curl -N -H "x-api-key: <admin key>" "https://api.usecreed.com/health/sse-canary"

## Query parameters

- `duration_s` integer: How long to keep the stream open
- `interval_s` number: Seconds between events

## Headers

- `x-api-key` string, required

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

## Changes

- **2026-08-24** `ec6a7aef1f3e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usecreed/apis/creed-api/changes/health/sse-canary/get.md)

---

[API](https://skmtc.dev/usecreed/apis/creed-api.md) - [All operations](https://skmtc.dev/usecreed/apis/creed-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usecreed/apis/creed-api/revisions/9a6e25b21a53?raw)