# Lightstream / API.stream

> Lightstream (Infiniscene, Inc.) is a Techstars-backed live video company. Its consumer product,
> Lightstream Studio, is a browser-based streaming studio. Its developer platform, API.stream,
> exposes the same cloud video pipeline to partners as three API-first services — a Live API for
> collections, projects, sources, destinations and broadcasts; a Layout API for layered scene
> compositions; and an Event API for real-time pub/sub. All three are defined as gRPC Protobuf
> contracts fronted by gRPC-Web and REST gateways, secured with JWT access tokens and role-based
> permissions.

Generated by the API Evangelist enrichment pipeline on 2026-07-19 from apis.yml and the artifacts
in this repository. Lightstream does not publish an llms.txt of its own (probed:
https://api.stream/llms.txt 404, https://golightstream.com/llms.txt is a catch-all redirect).

Key facts an agent should know before calling anything:
- Base URLs: https://live.api.stream/live/v2 (Live), https://live.api.stream/layout/v2 (Layout),
  https://live.api.stream/event/v2 (Event).
- Auth is two-step. The secret API key (`X-API-Key`) may ONLY be used from a backend, and only on
  `BackendAuthenticationService_CreateAccessToken`. Every other call uses
  `Authorization: Bearer <access token>`.
- Updates are PATCH with a protobuf field mask (`updateMask`). REST clients may omit it and the
  gateway computes it from the fields present.
- Errors use the google.rpc.Status envelope (`code`, `message`, `details[]`), not RFC 9457.
- There is NO idempotency key and NO pagination. A 429 means "service busy" — back off exponentially.
- New customer onboarding is currently a waitlist (https://api.stream/).

## APIs
- [API.stream Live API](https://www.api.stream/docs/api/live/rest/): collections, projects, live
  sources (RTMP/SRT/WebRTC), destinations, broadcast start/stop/status/snapshot, WebRTC start/stop,
  access and guest tokens, JWKS.
- [API.stream Layout API](https://www.api.stream/docs/api/layout/rest/): layouts and layers, batch
  layer operations, animation and transitions.
- [API.stream Event API](https://www.api.stream/docs/api/event/rest/): publish and stream events
  scoped to a collection, project or layout.

## Specs
- [Live API (Swagger 2.0)](openapi/lightstream-live-openapi-original.yml)
- [Layout API (Swagger 2.0)](openapi/lightstream-layout-openapi-original.yml)
- [Event API (Swagger 2.0)](openapi/lightstream-event-openapi-original.yml)
- [Event API AsyncAPI 3.0 (generated)](asyncapi/lightstream-event-asyncapi.yml)

## Docs
- [Getting started](https://www.api.stream/docs/)
- [Creating your account](https://www.api.stream/docs/account/)
- [Building blocks](https://www.api.stream/docs/interface/)
- [API design](https://www.api.stream/docs/api/)
- [Authentication and authorization](https://www.api.stream/docs/api/auth/)
- [Selecting a protocol](https://www.api.stream/docs/api/protocol/)
- [Update model (field masks)](https://www.api.stream/docs/api/live/usage)
- [Compositors](https://www.api.stream/docs/compositor/)
- [SDKs](https://www.api.stream/docs/sdk/)
- [Regions](https://www.api.stream/docs/service/region)
- [Status](https://status.api.stream/)

## SDKs and packages
- [@api.stream/sdk](https://www.npmjs.com/package/@api.stream/sdk)
- [@api.stream/studio-kit](https://www.npmjs.com/package/@api.stream/studio-kit)
- [GitHub organization](https://github.com/golightstream)
- [Full package catalog](packages/lightstream-packages.yml)

## Artifacts in this repository
- [Authentication profile](authentication/lightstream-authentication.yml)
- [API conventions](conventions/lightstream-conventions.yml)
- [Error catalog](errors/lightstream-problem-types.yml)
- [Data model](data-model/lightstream-data-model.yml)
- [Lifecycle and versioning](lifecycle/lightstream-lifecycle.yml)
- [Sandbox / development account](sandbox/lightstream-sandbox.yml)
- [Conformance](conformance/lightstream-conformance.yml)
- [Domain security](security/lightstream-domain-security.yml)
- [Embedded components](components/lightstream-components.yml)
- [Examples](examples/lightstream-examples.yml)
- [Changelog](changelog/lightstream-changelog.yml)
- [Candidate MCP tools](mcp/lightstream-mcp.yml)
- [Agent skills](skills/_index.yml)