# Streamnode Documentation

## Docs

Core entry points for language models and agents:

- [Docs Home](https://docs.streamnode.io): Documentation root.
- [Get started](https://docs.streamnode.io/get-started.md): Streamnode fundamentals and first implementation steps.
- [Concepts](https://docs.streamnode.io/get-started/concepts.md): Runtime model, request lifecycle, and reliability foundations.
- [URLs](https://docs.streamnode.io/urls.md): Request handling, actions, responses, and URL operations.
- [Connections](https://docs.streamnode.io/connections.md): Datastores, filestores, integrations, and security.
- [Platform](https://docs.streamnode.io/platform.md): Domains, guards, signing profiles, and project variables setup.
- [Guides](https://docs.streamnode.io/guides.md): Task-focused implementation walkthroughs.
- [Workspace](https://docs.streamnode.io/workspace.md): Workspace administration and developer tools.
- [API Reference](https://docs.streamnode.io/api): Interactive API docs.
- [OpenAPI Schema](https://docs.streamnode.io/api.openapi): Machine-readable API contract.
- [Postman Collection](https://docs.streamnode.io/api.postman): Importable request collection.
- [Insomnia Export](https://docs.streamnode.io/api.insomnia): Workspace export (format v4).
- [cURL Commands](https://docs.streamnode.io/api.curl): Endpoint commands as single-command or newline-separated output.
- [Yaak Export](https://docs.streamnode.io/api.yaak): JSON workspace export.

## Get started

Start here for onboarding and first delivery.

- [Overview](https://docs.streamnode.io/get-started.md): Introduction to Streamnode.
- [What is Streamnode](https://docs.streamnode.io/get-started/what-is-streamnode.md): Product overview and use cases.
- [Setup wizard](https://docs.streamnode.io/get-started/setup-wizard.md): First-run setup and recovery.
- [Quickstart: Build your first URL](https://docs.streamnode.io/get-started/quickstart-build-your-first-url.md): First end-to-end implementation.
- [Project setup](https://docs.streamnode.io/get-started/project-setup.md): Initial project configuration.

## Concepts

Canonical mental model for runtime behavior.

- [Overview](https://docs.streamnode.io/get-started/concepts.md): Concepts landing page.
- [Glossary](https://docs.streamnode.io/get-started/glossary.md): Shared terminology.
- [Request lifecycle](https://docs.streamnode.io/get-started/concepts/request-lifecycle.md): End-to-end execution order.
- [Request data](https://docs.streamnode.io/get-started/concepts/request-data.md): Request model and metadata.
- [Input data and files](https://docs.streamnode.io/get-started/concepts/input-data-and-files.md): Input handling patterns.
- [Actions](https://docs.streamnode.io/get-started/concepts/actions.md): Action execution model.
- [Responses](https://docs.streamnode.io/get-started/concepts/responses.md): Response construction.
- [Beacons](https://docs.streamnode.io/get-started/concepts/beacons.md): Asynchronous observability primitives.
- [Conditional logic](https://docs.streamnode.io/get-started/concepts/conditional-logic.md): Branching and flow control.
- [Error handling](https://docs.streamnode.io/get-started/error-handling.md): Failure strategy and patterns.

## URLs

Define URL request contracts, execute actions, and shape output.

- [Overview](https://docs.streamnode.io/urls.md): URL architecture overview.
- [Request](https://docs.streamnode.io/urls/request.md): Request-side configuration.
- [Request: Path](https://docs.streamnode.io/urls/request/path.md): Path variable handling.
- [Request: Access conditions](https://docs.streamnode.io/urls/request/access-conditions.md): Access gating.
- [Request: Authentication](https://docs.streamnode.io/urls/request/authentication.md): Caller auth configuration.
- [Guards](https://docs.streamnode.io/urls/request/authentication/guards.md): Guard-backed session authentication and protected URL access.
- [Signing profiles](https://docs.streamnode.io/urls/request/signing-profiles.md): Inbound signature verification and outbound response signing.
- [Request: Rate limiting](https://docs.streamnode.io/urls/request/rate-limiting.md): Throughput controls.
- [Request: Parameters](https://docs.streamnode.io/urls/request/parameters.md): Parameter model.
- [Request: Parameters / Query](https://docs.streamnode.io/urls/request/parameters/query.md): Query validation.
- [Request: Parameters / Body](https://docs.streamnode.io/urls/request/parameters/body.md): Body validation.
- [Request: Parameters / Headers](https://docs.streamnode.io/urls/request/parameters/headers.md): Header validation.
- [Request: Parameters / Validation Rules](https://docs.streamnode.io/urls/request/parameters/validation-rules.md): Rule reference.
- [Request: Files](https://docs.streamnode.io/urls/request/files.md): File upload input handling.
- [Actions](https://docs.streamnode.io/urls/actions.md): Action orchestration.
- [Actions: Datastore queries](https://docs.streamnode.io/urls/actions/datastore-queries.md): Datastore operations in actions.
- [Actions: Filestore operations](https://docs.streamnode.io/urls/actions/filestore-operations.md): File operations in actions.
- [Actions: Integration actions](https://docs.streamnode.io/urls/actions/integration-actions.md): External integrations.
- [Actions: HTTP Request](https://docs.streamnode.io/urls/actions/http-request.md): Direct outbound HTTP.
- [Actions: Secrets](https://docs.streamnode.io/urls/actions/secrets.md): Secret access in execution.
- [Responses](https://docs.streamnode.io/urls/responses.md): Response overview.
- [Responses: Status and headers](https://docs.streamnode.io/urls/responses/status-and-headers.md): Status and header control.
- [Responses: Types](https://docs.streamnode.io/urls/responses/types.md): Response type selection.
- [Responses: Types / Content](https://docs.streamnode.io/urls/responses/types/content.md): Structured content responses.
- [Responses: Types / Files and streams](https://docs.streamnode.io/urls/responses/types/files-and-streams.md): File/stream output.
- [Responses: Types / Proxy](https://docs.streamnode.io/urls/responses/types/proxy.md): Upstream proxying.
- [Responses: Types / Redirect](https://docs.streamnode.io/urls/responses/types/redirect.md): Redirect responses.
- [Responses: Types / Script](https://docs.streamnode.io/urls/responses/types/script.md): Scripted output.
- [Responses: Standardized errors](https://docs.streamnode.io/urls/responses/standardized-errors.md): Consistent error envelopes.
- [Schema Template](https://docs.streamnode.io/urls/schema-template.md): URL schema template validation and references.
- [Environment variables (runtime usage)](https://docs.streamnode.io/urls/variables/environment-variables.md): Use configured variables in URL execution.
- [Domain (runtime matching)](https://docs.streamnode.io/urls/request/domain.md): Apply domain constraints in request matching.
- [Folders](https://docs.streamnode.io/urls/organization/folders.md): URL organization patterns.
- [Beacons](https://docs.streamnode.io/urls/beacons.md): Execution telemetry.
- [Logs and traces](https://docs.streamnode.io/urls/observability/logs-and-traces.md): Incident diagnostics.
- [Conditional logic](https://docs.streamnode.io/urls/flow-control/conditional-logic.md): Branching inside URL flows.
- [Reusing variables](https://docs.streamnode.io/urls/flow-control/reusing-variables.md): Variable reuse and composition.

## Platform

Configure setup surfaces consumed by URL runtime.

- [Overview](https://docs.streamnode.io/platform.md): Platform setup overview.
- [Domains](https://docs.streamnode.io/platform/domains.md): Domain setup and ownership models.
- [Domains: Custom domains](https://docs.streamnode.io/platform/domains/custom-domains.md): Customer-owned domain verification and rollout.
- [Domains: Managed domains](https://docs.streamnode.io/platform/domains/managed-domains.md): Streamnode-managed domain usage.
- [Environment variables](https://docs.streamnode.io/platform/environment-variables.md): Project-scoped variables and secrets.
- [Guards](https://docs.streamnode.io/platform/guards.md): Shared request protection profile setup.
- [Signing profiles](https://docs.streamnode.io/platform/signing-profiles.md): Signature configuration and rotation.

## Connections

Configure external systems and data backends used by URLs.

- [Overview](https://docs.streamnode.io/connections.md): Connections overview.
- [Datastores](https://docs.streamnode.io/connections/datastores.md): Datastore connection model.
- [Datastores: Relational databases](https://docs.streamnode.io/connections/datastores/relational-databases.md): SQL backends.
- [Datastores: Document databases](https://docs.streamnode.io/connections/datastores/document-databases.md): Document backends.
- [Datastores: Queries and mutations](https://docs.streamnode.io/connections/datastores/queries-and-mutations.md): Data access patterns.
- [Filestores](https://docs.streamnode.io/connections/filestores.md): Filestore overview.
- [Filestores: Object storage](https://docs.streamnode.io/connections/filestores/object-storage.md): Object store providers.
- [Filestores: File system providers](https://docs.streamnode.io/connections/filestores/file-system-providers.md): Filesystem-style providers.
- [Filestores: Upload and download patterns](https://docs.streamnode.io/connections/filestores/upload-and-download-patterns.md): Transfer patterns.
- [Integrations](https://docs.streamnode.io/connections/integrations.md): Third-party service integrations.
- [Connection security](https://docs.streamnode.io/connections/connection-security.md): Credentials and transport security.

## Guides

Practical implementation examples.

- [Overview](https://docs.streamnode.io/guides.md): Guides landing page.
- [Build](https://docs.streamnode.io/guides/build.md): Build-focused workflow guides.
- [Build: Proxying requests](https://docs.streamnode.io/guides/build/proxying-requests.md): API proxy patterns for upstream providers.
- [Build: CRUD API](https://docs.streamnode.io/guides/build/crud-api.md): CRUD endpoint patterns.
- [Build: Webhook processor](https://docs.streamnode.io/guides/build/webhook-processor.md): Webhook ingestion flow.
- [Build: File upload endpoint](https://docs.streamnode.io/guides/build/file-upload-endpoint.md): File upload implementation.
- [Build: Slack notification workflow](https://docs.streamnode.io/guides/build/slack-notification-workflow.md): Notification automation pattern.
- [Webhooks guide](https://docs.streamnode.io/guides/webhooks.md): Webhook guidance.
- [Beacons guide](https://docs.streamnode.io/guides/beacons.md): Beacon usage patterns.

## Workspace

Operate workspace-level settings and developer integrations.

- [Overview](https://docs.streamnode.io/workspace.md): Workspace landing page.
- [Account](https://docs.streamnode.io/workspace/account.md): Profile, membership, billing ownership, and security history.
- [Billing](https://docs.streamnode.io/workspace/billing.md): Payment methods, subscription, and spend controls.
- [Projects](https://docs.streamnode.io/workspace/projects.md): Project lifecycle and settings navigation.
- [Developer tools](https://docs.streamnode.io/workspace/developer.md): API keys, OAuth apps, and developer webhooks.
- [Usage](https://docs.streamnode.io/workspace/usage.md): Account and project usage analysis.

## Agent Guidance

- Prefer `.md` routes for content extraction.
- Any documentation content URL can be requested with a `.md` suffix for markdown output (for example `/urls.md` or `/urls/actions.md`).
- Use OpenAPI for endpoint correctness and request/response schemas.
- When both docs prose and OpenAPI are available, treat OpenAPI as authoritative for field-level API details.