# NRAI

## Docs

- [Breaking Changes](https://docs.nrai.io/about/breaking-changes.md): This list shows all versions that include breaking changes and how to upgrade.
- [Changelog](https://docs.nrai.io/about/changelog.md): A log of all notable changes to NRAI
- [Editions](https://docs.nrai.io/about/editions.md)
- [i18n Translations](https://docs.nrai.io/about/i18n.md)
- [License](https://docs.nrai.io/about/license.md)
- [Telemetry](https://docs.nrai.io/about/telemetry.md)
- [Appearance](https://docs.nrai.io/admin-console/appearance.md)
- [Custom Domains](https://docs.nrai.io/admin-console/custom-domain.md)
- [Customize Emails](https://docs.nrai.io/admin-console/customize-emails.md)
- [Manage AI Providers](https://docs.nrai.io/admin-console/manage-ai-providers.md)
- [Replace OAuth2 Apps](https://docs.nrai.io/admin-console/manage-oauth2.md)
- [Manage Addons](https://docs.nrai.io/admin-console/manage-pieces.md)
- [Managed Projects](https://docs.nrai.io/admin-console/manage-projects.md)
- [Manage Templates](https://docs.nrai.io/admin-console/manage-templates.md)
- [Overview](https://docs.nrai.io/admin-console/overview.md)
- [MCP](https://docs.nrai.io/ai/mcp.md): Give AI access to your tools through NRAI
- [Create Action](https://docs.nrai.io/developers/building-pieces/create-action.md)
- [Create Trigger](https://docs.nrai.io/developers/building-pieces/create-trigger.md)
- [Overview](https://docs.nrai.io/developers/building-pieces/overview.md): This section helps developers build and contribute addons.
- [Add Addon Authentication](https://docs.nrai.io/developers/building-pieces/piece-authentication.md)
- [Create Addon Definition](https://docs.nrai.io/developers/building-pieces/piece-definition.md)
- [Fork Repository](https://docs.nrai.io/developers/building-pieces/setup-fork.md)
- [Start Building](https://docs.nrai.io/developers/building-pieces/start-building.md)
- [GitHub Codespaces](https://docs.nrai.io/developers/development-setup/codespaces.md)
- [Dev Containers](https://docs.nrai.io/developers/development-setup/dev-container.md)
- [Getting Started](https://docs.nrai.io/developers/development-setup/getting-started.md)
- [Local Dev Environment](https://docs.nrai.io/developers/development-setup/local.md)
- [Build Custom Addons](https://docs.nrai.io/developers/misc/build-piece.md)
- [Create New AI Provider](https://docs.nrai.io/developers/misc/create-new-ai-provider.md)
- [Custom Addons CI/CD](https://docs.nrai.io/developers/misc/pieces-ci-cd.md)
- [Setup Private Fork](https://docs.nrai.io/developers/misc/private-fork.md)
- [Publish Custom Addons](https://docs.nrai.io/developers/misc/publish-piece.md)
- [AI SDK & Providers](https://docs.nrai.io/developers/piece-reference/ai-providers.md): The AI Toolkit to build AI addons tailored for specific use cases that work with many AI providers using the AI SDK
- [Addon Auth](https://docs.nrai.io/developers/piece-reference/authentication.md): Learn about addon authentication
- [Enable Custom API Calls](https://docs.nrai.io/developers/piece-reference/custom-api-calls.md): Learn how to enable custom API calls for your addons
- [Addon Examples](https://docs.nrai.io/developers/piece-reference/examples.md): Explore a collection of example triggers and actions
- [External Libraries](https://docs.nrai.io/developers/piece-reference/external-libraries.md): Learn how to install and use external libraries.
- [Files](https://docs.nrai.io/developers/piece-reference/files.md): Learn how to use files object to create file references.
- [Flow Control](https://docs.nrai.io/developers/piece-reference/flow-control.md): Learn How to Control Flow from Inside the Addon
- [Addon i18n](https://docs.nrai.io/developers/piece-reference/i18n.md): Learn about translating addons to multiple locales
- [Persistent Storage](https://docs.nrai.io/developers/piece-reference/persistent-storage.md): Learn how to store and retrieve data from a key-value store
- [Addon Versioning](https://docs.nrai.io/developers/piece-reference/piece-versioning.md): Learn how to version your addons
- [Props](https://docs.nrai.io/developers/piece-reference/properties.md): Learn about different types of properties used in triggers / actions
- [Props Validation](https://docs.nrai.io/developers/piece-reference/properties-validation.md): Learn about different types of properties validation
- [Overview](https://docs.nrai.io/developers/piece-reference/triggers/overview.md)
- [Polling Trigger](https://docs.nrai.io/developers/piece-reference/triggers/polling-trigger.md): Periodically call endpoints to check for changes
- [Webhook Trigger](https://docs.nrai.io/developers/piece-reference/triggers/webhook-trigger.md): Listen to user events through a single URL
- [Community (Public NPM)](https://docs.nrai.io/developers/sharing-pieces/community.md): Learn how to publish your addon to the community.
- [Contribute](https://docs.nrai.io/developers/sharing-pieces/contribute.md): Learn how to contribute a addon to the main repository.
- [Overview](https://docs.nrai.io/developers/sharing-pieces/overview.md): Learn the different ways to publish your own addon on NRAI.
- [Private](https://docs.nrai.io/developers/sharing-pieces/private.md): Learn how to share your addons privately.
- [Show/Hide Addons](https://docs.nrai.io/embedding/customize-pieces.md)
- [Embed Builder](https://docs.nrai.io/embedding/embed-builder.md)
- [Create/Update Connections](https://docs.nrai.io/embedding/embed-connections.md)
- [Navigation](https://docs.nrai.io/embedding/navigation.md)
- [Overview](https://docs.nrai.io/embedding/overview.md): Understanding how embedding works
- [Predefined Connection](https://docs.nrai.io/embedding/predefined-connection.md)
- [Provision Users](https://docs.nrai.io/embedding/provision-users.md): Automatically authenticate your SaaS users to your NRAI instance
- [SDK Changelog](https://docs.nrai.io/embedding/sdk-changelog.md): A log of all notable changes to NRAI SDK
- [API Requests](https://docs.nrai.io/embedding/sdk-server-requests.md): Send requests to your NRAI instance from the embedded app
- [Delete Connection](https://docs.nrai.io/endpoints/connections/delete.md): Delete an app connection
- [List Connections](https://docs.nrai.io/endpoints/connections/list.md): List app connections
- [Connection Schema](https://docs.nrai.io/endpoints/connections/schema.md)
- [Upsert Connection](https://docs.nrai.io/endpoints/connections/upsert.md): Upsert an app connection based on the app name
- [Get Flow Run](https://docs.nrai.io/endpoints/flow-runs/get.md): Get Flow Run
- [List Flows Runs](https://docs.nrai.io/endpoints/flow-runs/list.md): List Flow Runs
- [Flow Run Schema](https://docs.nrai.io/endpoints/flow-runs/schema.md)
- [Create Flow Template](https://docs.nrai.io/endpoints/flow-templates/create.md): Create a flow template
- [Delete Flow Template](https://docs.nrai.io/endpoints/flow-templates/delete.md): Delete a flow template
- [Get Flow Template](https://docs.nrai.io/endpoints/flow-templates/get.md): Get a flow template
- [List Flow Templates](https://docs.nrai.io/endpoints/flow-templates/list.md): List flow templates
- [Flow Template Schema](https://docs.nrai.io/endpoints/flow-templates/schema.md)
- [Create Flow](https://docs.nrai.io/endpoints/flows/create.md): Create a flow
- [Delete Flow](https://docs.nrai.io/endpoints/flows/delete.md): Delete a flow
- [Get Flow](https://docs.nrai.io/endpoints/flows/get.md): Get a flow by id
- [List Flows](https://docs.nrai.io/endpoints/flows/list.md): List flows
- [Flow Schema](https://docs.nrai.io/endpoints/flows/schema.md)
- [Apply Flow Operation](https://docs.nrai.io/endpoints/flows/update.md): Apply an operation to a flow
- [Create Folder](https://docs.nrai.io/endpoints/folders/create.md): Create a new folder
- [Delete Folder](https://docs.nrai.io/endpoints/folders/delete.md): Delete a folder
- [Get Folder](https://docs.nrai.io/endpoints/folders/get.md): Get a folder by id
- [List Folders](https://docs.nrai.io/endpoints/folders/list.md): List folders
- [Folder Schema](https://docs.nrai.io/endpoints/folders/schema.md)
- [Update Folder](https://docs.nrai.io/endpoints/folders/update.md): Update an existing folder
- [Configure](https://docs.nrai.io/endpoints/git-repos/configure.md): Upsert a git repository information for a project.
- [Git Repos Schema](https://docs.nrai.io/endpoints/git-repos/schema.md)
- [Delete Global Connection](https://docs.nrai.io/endpoints/global-connections/delete.md)
- [List Global Connections](https://docs.nrai.io/endpoints/global-connections/list.md)
- [Global Connection Schema](https://docs.nrai.io/endpoints/global-connections/schema.md)
- [Update Global Connection](https://docs.nrai.io/endpoints/global-connections/update.md)
- [Upsert Global Connection](https://docs.nrai.io/endpoints/global-connections/upsert.md)
- [List MCP servers](https://docs.nrai.io/endpoints/mcp-servers/list.md): List MCP servers
- [Rotate MCP server token](https://docs.nrai.io/endpoints/mcp-servers/rotate.md): Rotate the MCP token
- [MCP Server Schema](https://docs.nrai.io/endpoints/mcp-servers/schema.md)
- [Update MCP Server](https://docs.nrai.io/endpoints/mcp-servers/update.md): Update the project MCP server configuration
- [Overview](https://docs.nrai.io/endpoints/overview.md)
- [Install Addon](https://docs.nrai.io/endpoints/pieces/install.md)
- [Addon Schema](https://docs.nrai.io/endpoints/pieces/schema.md)
- [Delete Project Member](https://docs.nrai.io/endpoints/project-members/delete.md)
- [List Project Member](https://docs.nrai.io/endpoints/project-members/list.md)
- [Project Member Schema](https://docs.nrai.io/endpoints/project-members/schema.md)
- [Create Project Release](https://docs.nrai.io/endpoints/project-releases/create.md)
- [Project Release Schema](https://docs.nrai.io/endpoints/project-releases/schema.md)
- [Create Project](https://docs.nrai.io/endpoints/projects/create.md)
- [Delete Project](https://docs.nrai.io/endpoints/projects/delete.md)
- [List Projects](https://docs.nrai.io/endpoints/projects/list.md)
- [Project Schema](https://docs.nrai.io/endpoints/projects/schema.md)
- [Update Project](https://docs.nrai.io/endpoints/projects/update.md)
- [Queue Stats](https://docs.nrai.io/endpoints/queue-metrics/metrics.md): Get metrics
- [Get Sample Data](https://docs.nrai.io/endpoints/sample-data/get.md)
- [Delete User Invitation](https://docs.nrai.io/endpoints/user-invitations/delete.md)
- [List User Invitations](https://docs.nrai.io/endpoints/user-invitations/list.md)
- [User Invitation Schema](https://docs.nrai.io/endpoints/user-invitations/schema.md)
- [Send User Invitation (Upsert)](https://docs.nrai.io/endpoints/user-invitations/upsert.md): Send a user invitation to a user. If the user already has an invitation, the invitation will be updated.
- [List Users](https://docs.nrai.io/endpoints/users/list.md): List users
- [User Schema](https://docs.nrai.io/endpoints/users/schema.md)
- [Update User](https://docs.nrai.io/endpoints/users/update.md)
- [Building Flows](https://docs.nrai.io/flows/building-flows.md): Flow consists of two parts, trigger and actions
- [Debugging Runs](https://docs.nrai.io/flows/debugging-runs.md): Ensuring your business automations are running properly
- [Technical Limits](https://docs.nrai.io/flows/known-limits.md): Technical limits for NRAI execution
- [Passing Data](https://docs.nrai.io/flows/passing-data.md): Using data from previous steps in the current one
- [Publishing Flows](https://docs.nrai.io/flows/publishing-flows.md): Make your flow work by publishing your updates
- [Version History](https://docs.nrai.io/flows/versioning.md): Learn how flow versioning works in NRAI
- [Welcome to NRAI](https://docs.nrai.io/getting-started/introduction.md): Discover the future of AI-powered automation with NRAI - where intelligent workflows meet limitless possibilities
- [Product Principles](https://docs.nrai.io/getting-started/principles.md)
- [How to handle Requests](https://docs.nrai.io/handbook/customer-support/handle-requests.md)
- [Overview](https://docs.nrai.io/handbook/customer-support/overview.md)
- [How to use Pylon](https://docs.nrai.io/handbook/customer-support/pylon.md): Guide for using Pylon to manage customer support tickets
- [Tone & Communication](https://docs.nrai.io/handbook/customer-support/tone.md)
- [Trial Key Management](https://docs.nrai.io/handbook/customer-support/trial.md): Description of your new file.
- [Handling Downtime](https://docs.nrai.io/handbook/engineering/onboarding/downtime-incident.md)
- [Engineering Workflow](https://docs.nrai.io/handbook/engineering/onboarding/how-we-work.md)
- [On-Call](https://docs.nrai.io/handbook/engineering/onboarding/on-call.md)
- [Onboarding Check List](https://docs.nrai.io/handbook/engineering/onboarding/onboarding-check-list.md)
- [Overview](https://docs.nrai.io/handbook/engineering/overview.md)
- [Queues Dashboard](https://docs.nrai.io/handbook/engineering/playbooks/bullboard.md)
- [Database Migrations](https://docs.nrai.io/handbook/engineering/playbooks/database-migration.md): Guide for creating database migrations in NRAI
- [E2E Tests](https://docs.nrai.io/handbook/engineering/playbooks/e2e-tests.md)
- [Frontend Best Practices](https://docs.nrai.io/handbook/engineering/playbooks/frontend-best-practices.md)
- [Cloud Infrastructure](https://docs.nrai.io/handbook/engineering/playbooks/infrastructure.md)
- [Feature Announcement](https://docs.nrai.io/handbook/engineering/playbooks/product-announcement.md)
- [How to create Release](https://docs.nrai.io/handbook/engineering/playbooks/releases.md)
- [Run Enterprise Edition](https://docs.nrai.io/handbook/engineering/playbooks/run-ee.md)
- [Setup Incident.io](https://docs.nrai.io/handbook/engineering/playbooks/setup-incident-io.md)
- [Our Compensation](https://docs.nrai.io/handbook/hiring/compensation.md)
- [Our Hiring Process](https://docs.nrai.io/handbook/hiring/hiring.md)
- [Our Roles & Levels](https://docs.nrai.io/handbook/hiring/levels.md)
- [Our Team Structure](https://docs.nrai.io/handbook/hiring/team.md)
- [NRAI Handbook](https://docs.nrai.io/handbook/overview.md)
- [Interface Design](https://docs.nrai.io/handbook/product/interface-design.md)
- [Marketing & Content](https://docs.nrai.io/handbook/teams/content.md)
- [Overview](https://docs.nrai.io/handbook/teams/overview.md)
- [Addons](https://docs.nrai.io/handbook/teams/pieces.md)
- [Platform](https://docs.nrai.io/handbook/teams/platform.md)
- [Product](https://docs.nrai.io/handbook/teams/product.md)
- [Sales](https://docs.nrai.io/handbook/teams/sales.md)
- [Engine](https://docs.nrai.io/install/architecture/engine.md)
- [Overview](https://docs.nrai.io/install/architecture/overview.md)
- [Performance & Benchmarking](https://docs.nrai.io/install/architecture/performance.md)
- [Stack & Tools](https://docs.nrai.io/install/architecture/stack.md)
- [Workers & Sandboxing](https://docs.nrai.io/install/architecture/workers.md)
- [Environment Variables](https://docs.nrai.io/install/configuration/environment-variables.md)
- [System Requirements & Performance](https://docs.nrai.io/install/configuration/hardware.md): Optimize your NRAI deployment with intelligent resource planning and performance insights
- [Deployment Checklist](https://docs.nrai.io/install/configuration/overview.md): Checklist to follow after deploying NRAI
- [Separate Workers from App](https://docs.nrai.io/install/configuration/separate-workers.md)
- [Setup App Webhooks](https://docs.nrai.io/install/configuration/setup-app-webhooks.md)
- [Setup HTTPS](https://docs.nrai.io/install/configuration/setup-ssl.md)
- [Troubleshooting](https://docs.nrai.io/install/configuration/troubleshooting.md)
- [AWS (Pulumi)](https://docs.nrai.io/install/options/aws.md): Get NRAI up & running on AWS with Pulumi for IaC
- [Docker](https://docs.nrai.io/install/options/docker.md): Single docker image deployment with SQLite3 and Memory Queue
- [Docker Compose](https://docs.nrai.io/install/options/docker-compose.md)
- [Easypanel](https://docs.nrai.io/install/options/easypanel.md): Run NRAI with Easypanel 1-Click Install
- [Elestio](https://docs.nrai.io/install/options/elestio.md): Run NRAI with Elestio 1-Click Install
- [GCP](https://docs.nrai.io/install/options/gcp.md)
- [Helm](https://docs.nrai.io/install/options/helm.md): Deploy NRAI on Kubernetes using Helm
- [Overview](https://docs.nrai.io/install/overview.md): Introduction to the different ways to install NRAI
- [Connection Deleted](https://docs.nrai.io/operations/audit-logs/connection-deleted.md)
- [Connection Upserted](https://docs.nrai.io/operations/audit-logs/connection-upserted.md)
- [Flow Created](https://docs.nrai.io/operations/audit-logs/flow-created.md)
- [Flow Deleted](https://docs.nrai.io/operations/audit-logs/flow-deleted.md)
- [Flow Run Finished](https://docs.nrai.io/operations/audit-logs/flow-run-finished.md)
- [Flow Run Started](https://docs.nrai.io/operations/audit-logs/flow-run-started.md)
- [Flow Updated](https://docs.nrai.io/operations/audit-logs/flow-updated.md)
- [Folder Created](https://docs.nrai.io/operations/audit-logs/folder-created.md)
- [Folder Deleted](https://docs.nrai.io/operations/audit-logs/folder-deleted.md)
- [Folder Updated](https://docs.nrai.io/operations/audit-logs/folder-updated.md)
- [Overview](https://docs.nrai.io/operations/audit-logs/overview.md)
- [Signing Key Created](https://docs.nrai.io/operations/audit-logs/signing-key-created.md)
- [User Email Verified](https://docs.nrai.io/operations/audit-logs/user-email-verified.md)
- [User Password Reset](https://docs.nrai.io/operations/audit-logs/user-password-reset.md)
- [User Signed In](https://docs.nrai.io/operations/audit-logs/user-signed-in.md)
- [User Signed Up](https://docs.nrai.io/operations/audit-logs/user-signed-up.md)
- [Environments & Releases](https://docs.nrai.io/operations/git-sync.md)
- [Project Permissions](https://docs.nrai.io/security/permissions.md): Documentation on project permissions in NRAI
- [Security & Data Practices](https://docs.nrai.io/security/practices.md): We prioritize security and follow these practices to keep information safe.
- [Single Sign-On](https://docs.nrai.io/security/sso.md)

## OpenAPI Specs

- [openapi](https://docs.nrai.io/openapi.json)