# S2

## Docs

- [Issue a new access token.](https://s2.dev/docs/api/access-tokens/issue.md)
- [List access tokens.](https://s2.dev/docs/api/access-tokens/list.md)
- [Revoke an access token.](https://s2.dev/docs/api/access-tokens/revoke.md)
- [Create a basin.](https://s2.dev/docs/api/basins/create.md): Create a new basin in an account.
- [Create or reconfigure a basin.](https://s2.dev/docs/api/basins/create-or-reconfigure.md): Create a new basin, or reconfigure an existing basin.
- [Delete a basin.](https://s2.dev/docs/api/basins/delete.md)
- [Get basin configuration.](https://s2.dev/docs/api/basins/get-config.md): Get the config of a basin.
- [List basins.](https://s2.dev/docs/api/basins/list.md): List basins in an account.
- [Reconfigure a basin.](https://s2.dev/docs/api/basins/reconfigure.md)
- [Endpoints](https://s2.dev/docs/api/endpoints.md)
- [Error Codes](https://s2.dev/docs/api/error-codes.md): A reference of error codes returned by S2
- [Account-level metrics.](https://s2.dev/docs/api/metrics/account.md): Get metrics at the account level.
- [Basin-level metrics.](https://s2.dev/docs/api/metrics/basin.md): Get metrics at the basin level.
- [Usage Metrics](https://s2.dev/docs/api/metrics/overview.md): Visibility into S2 usage
- [Stream-level metrics.](https://s2.dev/docs/api/metrics/stream.md): Get metrics at the stream level.
- [Protocol](https://s2.dev/docs/api/protocol.md): S2 `v1` protocol for clients
- [Append records.](https://s2.dev/docs/api/records/append.md): Append a batch of records to a stream.
- [Check the tail.](https://s2.dev/docs/api/records/check-tail.md): Check the tail of a stream.
- [Data Plane](https://s2.dev/docs/api/records/overview.md): Records API for S2
- [Read records.](https://s2.dev/docs/api/records/read.md): Retrieve a batch of records, or continuously stream.
- [Create a stream.](https://s2.dev/docs/api/streams/create.md): Create a new stream in a basin.
- [Create or reconfigure a stream.](https://s2.dev/docs/api/streams/create-or-reconfigure.md): Create a new stream, or reconfigure an existing stream.
- [Delete a stream.](https://s2.dev/docs/api/streams/delete.md)
- [Get stream configuration.](https://s2.dev/docs/api/streams/get-config.md): Get the config of a stream.
- [List streams.](https://s2.dev/docs/api/streams/list.md): List streams in a basin.
- [Reconfigure a stream.](https://s2.dev/docs/api/streams/reconfigure.md)
- [Access Tokens](https://s2.dev/docs/cli/access-tokens.md): Manage access tokens
- [Append](https://s2.dev/docs/cli/append.md): Append records to a stream
- [Apply](https://s2.dev/docs/cli/apply.md): Declaratively create or reconfigure basins and streams from a spec file
- [Basins](https://s2.dev/docs/cli/basins.md): Manage basins
- [Bench](https://s2.dev/docs/cli/bench.md): Benchmark stream throughput and latency
- [Check Tail](https://s2.dev/docs/cli/check-tail.md): Get the tail position of a stream
- [Configuration](https://s2.dev/docs/cli/configuration.md): Configure the S2 CLI
- [Fence](https://s2.dev/docs/cli/fence.md): Set a fencing token for a stream
- [Installation](https://s2.dev/docs/cli/installation.md): Install the S2 CLI
- [Metrics](https://s2.dev/docs/cli/metrics.md): Query usage metrics
- [CLI](https://s2.dev/docs/cli/overview.md): The S2 command-line interface
- [Read](https://s2.dev/docs/cli/read.md): Read records from a stream
- [Streams](https://s2.dev/docs/cli/streams.md): Manage streams
- [Trim](https://s2.dev/docs/cli/trim.md): Set a trim point for a stream
- [TUI](https://s2.dev/docs/cli/tui.md): Interactive terminal UI mode
- [Access Tokens](https://s2.dev/docs/concepts/access-tokens.md): Authentication and granular access control
- [Appends](https://s2.dev/docs/concepts/appends.md): Writing records to streams
- [Basins](https://s2.dev/docs/concepts/basins.md): Containers for streams
- [Concurrency Controls](https://s2.dev/docs/concepts/concurrency-controls.md): Managing concurrent access to streams
- [Configs](https://s2.dev/docs/concepts/configs.md): Stream and basin configuration
- [Durability + Consistency](https://s2.dev/docs/concepts/durability-consistency.md): Guarantees and trade-offs
- [Metrics](https://s2.dev/docs/concepts/metrics.md): Visibility into S2 usage
- [Reads](https://s2.dev/docs/concepts/reads.md): Reading records from streams
- [Records](https://s2.dev/docs/concepts/records.md): The fundamental unit of a stream
- [Retention + Trimming](https://s2.dev/docs/concepts/retention.md): Managing stream data lifecycle
- [Streams](https://s2.dev/docs/concepts/streams.md): Unbounded sequence of records
- [Tuning](https://s2.dev/docs/concepts/tuning.md): Performance tuning and optimization
- [Demos](https://s2.dev/docs/demos.md): Live demos and examples
- [Declarative Spec](https://s2.dev/docs/infra/declarative-spec.md): Define basins and streams as a JSON spec and apply them declaratively
- [Bento](https://s2.dev/docs/integrations/bento.md)
- [Goldsky](https://s2.dev/docs/integrations/goldsky.md)
- [LiveStore](https://s2.dev/docs/integrations/livestore.md)
- [OpenTelemetry](https://s2.dev/docs/integrations/otlp.md)
- [Overview](https://s2.dev/docs/integrations/overview.md)
- [Sequin](https://s2.dev/docs/integrations/sequin.md)
- [Terraform Provider](https://s2.dev/docs/integrations/terraform-provider.md): Manage S2 basins, streams, and access tokens with Terraform
- [Vercel AI SDK](https://s2.dev/docs/integrations/vercel-ai-sdk.md)
- [Y-S2](https://s2.dev/docs/integrations/y-s2.md)
- [Introduction](https://s2.dev/docs/intro.md): Welcome to S2
- [Architecture](https://s2.dev/docs/platform/architecture.md)
- [Cells](https://s2.dev/docs/platform/cells.md): Cell-based infrastructure
- [Limits](https://s2.dev/docs/platform/limits.md)
- [Pricing](https://s2.dev/docs/platform/pricing.md): S2 pricing details
- [Private Networking](https://s2.dev/docs/platform/private-networking.md)
- [Security](https://s2.dev/docs/platform/security.md)
- [Status](https://s2.dev/docs/platform/status.md): Service status and availability
- [Quickstart](https://s2.dev/docs/quickstart.md)
- [s2-lite](https://s2.dev/docs/s2-lite.md): Open source, self-hosted S2
- [Access Tokens](https://s2.dev/docs/sdk/access-tokens.md): Managing access tokens via SDK
- [Appending](https://s2.dev/docs/sdk/appending.md): Writing records to streams
- [Basin Resources](https://s2.dev/docs/sdk/basin-resources.md): Managing basins via SDK
- [Endpoints](https://s2.dev/docs/sdk/endpoints.md): Endpoint configuration and environment variables
- [Overview](https://s2.dev/docs/sdk/languages.md): S2 SDKs for building with streams
- [Metrics](https://s2.dev/docs/sdk/metrics.md): Querying metrics via SDK
- [Paginators](https://s2.dev/docs/sdk/paginators.md): Automatic pagination for list operations
- [Reading](https://s2.dev/docs/sdk/reading.md): Reading records from streams
- [Retries + Timeouts](https://s2.dev/docs/sdk/retries-timeouts.md): Timeout settings and retry behavior
- [Stream Resources](https://s2.dev/docs/sdk/stream-resources.md): Managing streams via SDK
- [Studio](https://s2.dev/docs/studio.md)
- [Updates](https://s2.dev/docs/updates.md)
- [Agents](https://s2.dev/docs/use-cases/agents.md): Building AI agents with S2
- [Data Feeds](https://s2.dev/docs/use-cases/data-feeds.md): Streaming data feeds
- [Live View](https://s2.dev/docs/use-cases/live-view.md): Real-time data views
- [Sync](https://s2.dev/docs/use-cases/sync.md): Data synchronization patterns

## OpenAPI Specs

- [openapi](https://s2.dev/docs/api-reference/openapi.json)

## Optional

- [Community](https://discord.gg/vTCs7kMkAf)
- [Blog](https://s2.dev/blog)


Built with [Mintlify](https://mintlify.com).