API Reference

The /v1/stream operation and the StreamEvent schema, generated from the OpenAPI spec.

This reference is generated directly from our OpenAPI specification, so it always matches the published StreamEvent contract.

Query Parameters

source?array<string>|

Restrict to these source ids (repeatable; a trailing .* is a prefix match).

source_type?array<string>|

Restrict to these source tiers (repeatable).

tag?array<string>|

Restrict to events overlapping these tags (repeatable).

keyword?array<string>|

Restrict to events whose title/content match these keywords (repeatable).

since?string

Backfill floor: replay events after this UUIDv7 id before tailing live.

Header Parameters

Last-Event-ID?string

Resume cursor: the id of the last event the client saw.

Response Body

`application/json`

`application/problem+json`

curl -X GET "https://example.com/v1/stream"

{  "$schema": "https://example.com/schemas/StreamEvent.json",  "author": "string",  "content": "string",  "content_hash": "string",  "emitted_at": "2019-08-24T14:15:22Z",  "fetched_at": "2019-08-24T14:15:22Z",  "id": "string",  "published_at": "2019-08-24T14:15:22Z",  "schema_version": 0,  "simhash": 0,  "source_id": "string",  "source_type": "string",  "tags": [    "string"  ],  "title": "string",  "url": "string"}

{  "$schema": "https://example.com/schemas/ErrorModel.json",  "detail": "Property foo is required but is missing.",  "errors": [    {      "location": "string",      "message": "string",      "value": null    }  ],  "instance": "https://example.com/error-log/abc123",  "status": 400,  "title": "Bad Request",  "type": "https://example.com/errors/example"}