API

The Streamdat product API is served from the application origin, not this marketing host. Use the interactive docs on your deployment to explore every route, schema, and auth requirement.

Interactive docs

Swagger UI: https://streamdat.neuralpromptventures.ai/api/docs
OpenAPI JSON: https://streamdat.neuralpromptventures.ai/api/openapi.json

These endpoints are not public: FastAPI's built-in docs are disabled and re-served behind authentication, so both URLs require a signed-in user whose workspace is on a plan that includes API access (the Studio tier). Anonymous requests get 401; lower tiers get 402/403.

Authentication

Register and login flows issue JWT access tokens (and refresh rotation where enabled). Send Authorization: Bearer … on API calls. Social sign-in is currently Google only; YouTube channel linking for publishing has its own OAuth flow; see auth and account routes in Swagger.

Workspaces

Multi-tenant data is partitioned by workspace. Middleware resolves the active workspace from the request context after authentication; most resource routes are workspace-scoped.

Errors and pagination

The backend follows a consistent error envelope and pagination conventions documented in the app repository (docs/API_CONVENTIONS.md). When building integrations, generate a typed client from openapi.json rather than hand-maintaining paths.

Operations

Health and metrics endpoints used by SREs are summarized on the Observability page.

GET/api/health

Lightweight health check for monitors and load balancers.

GET/metrics

Prometheus exposition endpoint when metrics are enabled for the deployment.

GET/api/plugins

Lists installed plugins with optional type filtering.

POST/api/plugins/install

Admin and plan-gated plugin install from a Git URL and optional ref.