# FYInbox

> A personal, structured inbox for notifications from scripts, services, no-code automations, and agents.

## Start here
- [Quickstart](https://fyinbox.com/docs/quickstart)
- [API reference](https://fyinbox.com/docs/api-reference)
- [OpenAPI 3.1](https://fyinbox.com/openapi.json)
- [Create request JSON Schema](https://fyinbox.com/json-schema/create-notification.request.schema.json)

## Human documentation
- [Quickstart](https://fyinbox.com/docs/quickstart): Send one structured notification to your personal inbox with a source API key and a single HTTP request.
- [Concepts](https://fyinbox.com/docs/concepts): Understand the small set of account, source, notification, tag, metadata, action, and push concepts used by the product.
- [API authentication](https://fyinbox.com/docs/authentication): Authenticate producer and agent requests with a source-scoped bearer key while keeping the secret out of clients, payloads, logs, and source control.
- [Notification payload](https://fyinbox.com/docs/notification-payload): Start with a title, then add severity, body, tags, metadata, event identity, timestamp, and safe link actions only when useful.
- [Deduplication and retries](https://fyinbox.com/docs/deduplication): Give each logical event a stable source-scoped key so a network retry cannot create a second inbox item while the original is retained.
- [TypeScript SDK](https://fyinbox.com/docs/typescript-sdk): Use the server-only TypeScript client for runtime validation, bounded responses, safe errors, deadlines, and conservative retry behavior.
- [Errors and retries](https://fyinbox.com/docs/errors-and-retries): Branch on HTTP status and stable error code, preserve unknown codes, honor Retry-After, and avoid replaying ambiguous non-idempotent mutations.
- [Limits](https://fyinbox.com/docs/limits): Design producers below the public protocol ceilings and expect the running deployment or account policy to enforce lower operational values.
- [API reference](https://fyinbox.com/docs/api-reference): Use the versioned API for notification creation, agent-readable notification context, and scoped metadata mutation; dashboard and account endpoints are not public APIs.
- [Security and privacy](https://fyinbox.com/docs/security-and-privacy): Minimize notification data, keep producer credentials server-side, and understand what the managed service must decrypt to provide inbox and filtering features.
- [Compatibility policy](https://fyinbox.com/docs/compatibility): Integrate against the versioned contract, accept additive response evolution, and use stable error codes and schemas instead of dashboard internals.
- [Changelog](https://fyinbox.com/docs/changelog): Track public producer API, machine-contract, SDK, and documentation changes without mixing in private dashboard implementation details.

## Machine-readable artifacts
- [openapi.json](https://fyinbox.com/openapi.json)
- [add-notification-metadata.path-parameters.schema.json](https://fyinbox.com/json-schema/add-notification-metadata.path-parameters.schema.json)
- [add-notification-metadata.request.schema.json](https://fyinbox.com/json-schema/add-notification-metadata.request.schema.json)
- [add-notification-metadata.response-200.schema.json](https://fyinbox.com/json-schema/add-notification-metadata.response-200.schema.json)
- [create-notification.request.schema.json](https://fyinbox.com/json-schema/create-notification.request.schema.json)
- [create-notification.response-200.schema.json](https://fyinbox.com/json-schema/create-notification.response-200.schema.json)
- [create-notification.response-201.schema.json](https://fyinbox.com/json-schema/create-notification.response-201.schema.json)
- [get-notification.path-parameters.schema.json](https://fyinbox.com/json-schema/get-notification.path-parameters.schema.json)
- [get-notification.response-200.schema.json](https://fyinbox.com/json-schema/get-notification.response-200.schema.json)
- [modify-notification-metadata.path-parameters.schema.json](https://fyinbox.com/json-schema/modify-notification-metadata.path-parameters.schema.json)
- [modify-notification-metadata.request.schema.json](https://fyinbox.com/json-schema/modify-notification-metadata.request.schema.json)
- [modify-notification-metadata.response-200.schema.json](https://fyinbox.com/json-schema/modify-notification-metadata.response-200.schema.json)
- [public-error.response.schema.json](https://fyinbox.com/json-schema/public-error.response.schema.json)
- [Full agent documentation](https://fyinbox.com/llms-full.txt)