API Reference

The Streamforge REST API allows programmatic management of pipelines, schema models, DLQ operations, and alert rules. Base URL: https://api.streamforgehq.com/v1

Authentication

All API requests require a Bearer token in the Authorization header:

Authorization: Bearer sfhq_live_xxxxxxxxxxxxxxxx

Pipelines

List all pipelines in your workspace.

Create a new pipeline. Request body requires broker_type, connection object, and optional topics array.

Get details of a specific pipeline, including connection status and monitored topic list.

Delete a pipeline. Monitoring stops immediately. DLQ events are retained per your retention policy.

Schema Models

Retrieve the current schema fingerprint for a topic. Returns field names, inferred types, nullability percentiles, and baseline sampling stats.

{
  "topic": "orders-v2.checkout",
  "baseline_complete": true,
  "samples": 10000,
  "fields": [
    {
      "name": "event_id",
      "inferred_type": "string",
      "null_pct": 0.002
    }
  ]
}

DLQ Operations

List quarantined events. Supports query params: topic, violation_type, since (ISO timestamp), limit (max 1000).

Replay a batch of quarantined events back into the source topic. Body: event_ids array (max 500K on Scale tier).

Dismiss (delete) quarantined events. Body: event_ids array or "all": true to dismiss everything for the pipeline.

Alert Rules

List all alert channel configurations for the workspace.

Create an alert channel. Body: type (slack/pagerduty/opsgenie/email/webhook), channel-specific credentials, and optional dedup_window_minutes.

Delete an alert channel.

Rate limits

API rate limits apply per API key:

Solo: 60 requests/minute
Team: 300 requests/minute
Scale: 1,200 requests/minute

Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.