# Archie Documentation

## Docs

- [Changelog](https://archie.com/docs/changelog.md): Release notes and product updates for Archie.
- [Overview](https://archie.com/docs/features/assets/overview.md): Upload, organize, and serve images, videos, documents, and other files used in your Archie app from a centralized media surface.
- [Email templates](https://archie.com/docs/features/backend/app-services/authentication-providers/archie-auth/email-templates.md): Customize the verification and password-recovery email templates and the sender branding — per environment, via the dashboard or the GraphQL API.
- [Getting started](https://archie.com/docs/features/backend/app-services/authentication-providers/archie-auth/getting-started.md): Enable Archie Auth, configure the password policy and token TTLs, and walk the full signup → verify → login flow.
- [GraphQL API](https://archie.com/docs/features/backend/app-services/authentication-providers/archie-auth/graphql-api.md): GraphQL mutations and queries for Archie Auth — signup, login, password reset, refresh, admin operations, and configuration.
- [Overview](https://archie.com/docs/features/backend/app-services/authentication-providers/archie-auth/overview.md): Archie Auth is the built-in authentication system — email/password sign-in, user management, password reset, and email verification, all per-environment.
- [REST API](https://archie.com/docs/features/backend/app-services/authentication-providers/archie-auth/rest-api.md): HTTP endpoints for Archie Auth — signup, login, password reset, refresh, JWKS, and the error code reference.
- [Security](https://archie.com/docs/features/backend/app-services/authentication-providers/archie-auth/security.md): Password hashing, JWT signing, JWE encryption, refresh-token rotation, rate limiting, account lockout, and key rotation.
- [User management](https://archie.com/docs/features/backend/app-services/authentication-providers/archie-auth/user-management.md): Block users, force logout, resend verification, and inspect login activity from the Archie Auth admin panel — or do all of it via the GraphQL admin API.
- [Overview](https://archie.com/docs/features/backend/app-services/authentication-providers/overview.md): Authentication Providers configure who can sign into your app and how — built-in Archie Auth, third-party providers, or both.
- [Custom APIs](https://archie.com/docs/features/backend/app-services/custom-apis.md): Register HTTP routes that reverse-proxy to internal services with CORS, rate limiting, request transformation, circuit breakers, and caching.
- [File Manager](https://archie.com/docs/features/backend/app-services/file-manager.md): Connect your project to a cloud storage provider — S3, Google Cloud Storage, Azure Blob, or Filestack — to serve uploads and assets.
- [Overview](https://archie.com/docs/features/backend/app-services/overview.md): App Services control authentication, permissions, file storage, and the custom API gateway across your backend.
- [Role-Based Access](https://archie.com/docs/features/backend/app-services/role-based-access.md): Define roles and the read, write, update, and delete permissions they grant on every table — including row-level filtering.
- [Deploying Custom Functions](https://archie.com/docs/features/backend/custom-functions/deploying.md): Ship your custom functions to your app.
- [Overview](https://archie.com/docs/features/backend/custom-functions/overview.md): Server-side functions in Archie.
- [Writing Custom Functions](https://archie.com/docs/features/backend/custom-functions/writing.md): Author server-side logic for your app.
- [Data Types](https://archie.com/docs/features/backend/data-model/data-types.md): Data Types are reusable named enums you can apply to fields across tables — defined once, applied everywhere.
- [Data Viewer](https://archie.com/docs/features/backend/data-model/data-viewer.md): The Data tab is a spreadsheet-like editor for the records inside a table. Browse, edit, filter, sort, and customize columns.
- [Exporting data](https://archie.com/docs/features/backend/data-model/exporting-data.md): Download the rows in a table as a CSV file. Filters and visible columns control exactly what gets exported.
- [Fields](https://archie.com/docs/features/backend/data-model/fields.md): A field is a column on a table. Archie supports nine field types, each with its own validation, defaults, and configuration options.
- [Boolean field](https://archie.com/docs/features/backend/data-model/fields/boolean.md): Boolean fields store true / false flags. Use them for yes/no, on/off, and any binary state.
- [Date field](https://archie.com/docs/features/backend/data-model/fields/date.md): Date fields store calendar dates and timestamps. Pick the timestamp type to match how you'll use the value.
- [Inline enum field](https://archie.com/docs/features/backend/data-model/fields/inline-enum.md): Inline enum fields constrain a column to a fixed list of values defined directly on the field — no shared Data Type required.
- [JSONB field](https://archie.com/docs/features/backend/data-model/fields/jsonb.md): JSONB fields store structured JSON objects and arrays. Validated on write, indexable, and queryable by key.
- [Number field](https://archie.com/docs/features/backend/data-model/fields/number.md): Number fields store integers, decimals, and floats. Pick the number type to match the precision and range you need.
- [Relationship field](https://archie.com/docs/features/backend/data-model/fields/relationship.md): Relationship fields connect two tables with a foreign key. Archie generates the inverse query in GraphQL automatically.
- [Text field](https://archie.com/docs/features/backend/data-model/fields/text.md): Text fields store strings of any length. The most versatile field type, suitable for names, titles, descriptions, and free-form content.
- [User-defined field](https://archie.com/docs/features/backend/data-model/fields/user-defined.md): User-defined fields use a reusable Data Type (enum) that's shared across tables. Define the list once, apply it everywhere.
- [UUID field](https://archie.com/docs/features/backend/data-model/fields/uuid.md): UUID fields store 128-bit unique identifiers. Globally unique, hard to guess, and safe to expose in URLs.
- [Importing data](https://archie.com/docs/features/backend/data-model/importing-data.md): Bulk-load records into a table from a CSV file with column mapping and schema-aware validation.
- [Indexes](https://archie.com/docs/features/backend/data-model/indexes.md): Indexes speed up lookups on frequently queried fields and can enforce uniqueness across one or more columns.
- [Overview](https://archie.com/docs/features/backend/data-model/overview.md): The Data Model is where you design your app's database schema, define relationships, and configure data validation.
- [Relationships](https://archie.com/docs/features/backend/data-model/relationships.md): Relationships connect tables with foreign keys. Choose between one-to-one, one-to-many, and many-to-many.
- [Tables](https://archie.com/docs/features/backend/data-model/tables.md): Create, rename, and delete tables in your Data Model. Every table generates a GraphQL and REST API automatically.
- [Views](https://archie.com/docs/features/backend/data-model/views.md): A View is a virtual table defined by a saved SQL SELECT query. Views appear in the GraphQL API like a standard table.
- [Backups](https://archie.com/docs/features/backend/environments/backups.md): Automatic pre-merge snapshots, manual backups on demand, and restore — including to environments that have been deleted.
- [Configuration](https://archie.com/docs/features/backend/environments/configuration.md): What's scoped per-environment — the data model, app services, settings, and integrations that each environment maintains independently.
- [Creating environments](https://archie.com/docs/features/backend/environments/creating.md): Branch a new environment from any active source. Pick a branch mode, choose what configuration to copy, and decide what stays per-environment.
- [Deleting environments](https://archie.com/docs/features/backend/environments/deleting.md): Permanently remove an environment, its database, and its scoped configuration. Backups outlive the environment and remain restorable.
- [Schema diff](https://archie.com/docs/features/backend/environments/diff.md): Compare the schemas of two environments side by side. Forward-only semantics surface exactly the changes that need to flow from source to target.
- [Migration history](https://archie.com/docs/features/backend/environments/history.md): An audit trail of every merge operation — who ran it, when, what changed, and the backup taken alongside.
- [Merge](https://archie.com/docs/features/backend/environments/merge.md): Apply schema changes from one environment to another. Cherry-pick the changes you want, run them transactionally, and roll back automatically on failure.
- [Overview](https://archie.com/docs/features/backend/environments/overview.md): Environments are isolated copies of your backend that let you develop, test, and ship changes safely without affecting production.
- [Environment tree](https://archie.com/docs/features/backend/environments/tree.md): The parent-child hierarchy of your environments. Visualizes lineage and drives diff target selection, merge direction, and backup restore scope.
- [Mutations](https://archie.com/docs/features/backend/graphql-api-explorer/mutations.md): Create, update, and delete records through the auto-generated GraphQL mutations. Includes bulk operations and atomic upserts.
- [Overview](https://archie.com/docs/features/backend/graphql-api-explorer/overview.md): The GraphQL API Explorer is an in-browser IDE for querying and mutating your app's data through the auto-generated GraphQL schema.
- [Queries](https://archie.com/docs/features/backend/graphql-api-explorer/queries.md): Read records from the auto-generated GraphQL schema. Single record, list, filtered, paginated, sorted, aggregated, grouped.
- [Standard operations](https://archie.com/docs/features/backend/graphql-api-explorer/standard-operations.md): Filters, relationship traversal, nested mutations, and the standard patterns shared across every query and mutation in the schema.
- [Subscriptions](https://archie.com/docs/features/backend/graphql-api-explorer/subscriptions.md): Real-time event streams over WebSockets. Subscribe to inserts, updates, and deletes on any table.
- [Variables](https://archie.com/docs/features/backend/graphql-api-explorer/variables.md): Parameterize GraphQL operations with typed variables. The right move for reusable, dynamic, and safe queries.
- [Building Custom Integrations](https://archie.com/docs/features/backend/integrations/building-custom.md): Author custom integrations Archie does not ship.
- [Overview](https://archie.com/docs/features/backend/integrations/overview.md): Connect Archie apps to third-party services through built-in integrations or custom ones — credentials live in your project, calls go through the GraphQL API.
- [SendGrid](https://archie.com/docs/features/backend/integrations/sendgrid.md): Send transactional and marketing email — single sends, bulk sends, dynamic templates, contact management, and delivery analytics.
- [Shopify](https://archie.com/docs/features/backend/integrations/shopify.md): Read and write Shopify store data — products, orders, customers, and inventory — through Archie's GraphQL API.
- [Slack](https://archie.com/docs/features/backend/integrations/slack.md): Send notifications and interactive messages to Slack channels and DMs from your Archie app.
- [Stripe](https://archie.com/docs/features/backend/integrations/stripe.md): Process payments, manage subscriptions, and run a Stripe-hosted billing portal — all through Archie's auto-generated GraphQL API.
- [Twilio](https://archie.com/docs/features/backend/integrations/twilio.md): Send SMS, place voice calls, and run verification flows from your Archie app through Twilio's programmable communications API.
- [Webhooks](https://archie.com/docs/features/backend/integrations/webhooks.md): Receive webhooks from your app or send them to external systems.
- [Logs](https://archie.com/docs/features/backend/logs.md): Inspect application logs across services and environments in Archie Core.
- [Overview](https://archie.com/docs/features/backend/overview.md): Build, extend, and integrate with apps you ship on Archie.
- [Error handling](https://archie.com/docs/features/backend/rest-api-explorer/error-handling.md): The REST API uses RFC 9457 Problem Details for every error response. Predictable shape, machine-readable types, field-level details.
- [File management](https://archie.com/docs/features/backend/rest-api-explorer/file-management.md): Upload, list, download, and delete files via the REST API. Works with any storage provider configured in App Services.
- [Idempotency](https://archie.com/docs/features/backend/rest-api-explorer/idempotency.md): Make POST requests safely retryable with the Idempotency-Key header. The same key returns the cached response instead of creating a duplicate.
- [Mutations](https://archie.com/docs/features/backend/rest-api-explorer/mutations.md): Create, update, and delete records via standard HTTP verbs. Includes bulk operations and update-by-filter.
- [OpenAPI specification](https://archie.com/docs/features/backend/rest-api-explorer/openapi-specification.md): Every project gets an auto-generated OpenAPI 3.1 spec that documents every endpoint, schema, and auth requirement — always in sync with your data model.
- [Overview](https://archie.com/docs/features/backend/rest-api-explorer/overview.md): The REST API Explorer is a Swagger UI interface for browsing and testing your app's auto-generated REST endpoints.
- [Queries](https://archie.com/docs/features/backend/rest-api-explorer/queries.md): Read records over HTTP — single, list, filtered, paginated, sorted, aggregated, with field selection and an advanced JSON query endpoint.
- [Webhooks](https://archie.com/docs/features/backend/rest-api-explorer/webhooks.md): Subscribe to data changes and have them delivered to your services as signed HTTP POSTs. Retry, filter, and verify with HMAC signatures.
- [API Keys](https://archie.com/docs/features/backend/settings/api-keys.md): Manage API keys at the developer level.
- [Environment variables](https://archie.com/docs/features/backend/settings/environment-variables.md): Set environment variables for your project.
- [Network](https://archie.com/docs/features/backend/settings/network.md): Configure CORS and rate limiting settings for your project.
- [SQL Playground](https://archie.com/docs/features/backend/sql-playground.md): Run SQL against your app's database.
- [Adding context](https://archie.com/docs/features/blueprint/context.md): Provide reference materials and clarifying answers that inform your blueprint.
- [Editing integrations](https://archie.com/docs/features/blueprint/editing-integrations.md): Add third-party services to your blueprint.
- [Editing modules](https://archie.com/docs/features/blueprint/editing-modules.md): Add, remove, and refine the modules in your blueprint.
- [Editing services](https://archie.com/docs/features/blueprint/editing-services.md): Configure built-in services like authentication, file storage, and roles.
- [Editing the tech stack](https://archie.com/docs/features/blueprint/editing-tech-stack.md): Choose and adjust the technical foundation for your app.
- [Editing user types](https://archie.com/docs/features/blueprint/editing-user-types.md): Define who uses your app and what each user type can do.
- [Generating a blueprint](https://archie.com/docs/features/blueprint/generating.md): Submit an idea and let Archie produce your blueprint.
- [Iterating on the blueprint](https://archie.com/docs/features/blueprint/iterating.md): Use the blueprint chat to refine your plan in conversation.
- [Overview](https://archie.com/docs/features/blueprint/overview.md): What a blueprint is and why it is the unit of editing in Archie.
- [Reviewing the blueprint](https://archie.com/docs/features/blueprint/reviewing.md): Read your generated blueprint and identify what to refine.
- [When to run the build](https://archie.com/docs/features/blueprint/when-to-build.md): Signals that your blueprint is ready to compile into a working app.
- [Code editor](https://archie.com/docs/features/frontend/code-editor.md): Edit your app's code directly with the built-in IDE — Monaco-powered file editing, file tree navigation, and inline build errors.
- [Components](https://archie.com/docs/features/frontend/components.md): Work with the generated component library in your Archie app — shadcn/ui based, customizable, and extensible.
- [Connecting to the backend](https://archie.com/docs/features/frontend/connecting-to-the-backend.md): How your Archie frontend talks to Archie Core — typed API client, authentication tokens, and real-time subscriptions.
- [Deployment](https://archie.com/docs/features/frontend/deployment.md): Publish your Archie app to production with one click — Archie hosting, custom domains, environments, and rollbacks.
- [Overview](https://archie.com/docs/features/frontend/overview.md): The Archie frontend — a generated React app with visual editing, chat-based code edits, and a full IDE for direct code work.
- [Routing](https://archie.com/docs/features/frontend/routing.md): How routing works in your Archie app — pages, dynamic routes, navigation, and route protection.
- [Talking to Archie](https://archie.com/docs/features/frontend/talking-to-archie.md): Use the chat to edit your Archie app's code in plain language — the primary editing modality after the build.
- [Theming](https://archie.com/docs/features/frontend/theming.md): Configure branding, colors, fonts, and dark mode for your Archie app — applied across every component and page.
- [Visual editor](https://archie.com/docs/features/frontend/visual-editor.md): Edit your Archie app visually with element inspection, point-and-click property editing, and live preview updates.
- [Connecting GitHub](https://archie.com/docs/features/github/connecting.md): Link your Archie project to a GitHub repository.
- [GitHub OAuth](https://archie.com/docs/features/github/oauth.md): Configure GitHub OAuth for authentication.
- [Overview](https://archie.com/docs/features/home.md): Build production-ready applications with Archie's blueprint-first flow, integrated backend, visual editing, and full-stack code generation.
- [Activity](https://archie.com/docs/introduction/account/activity.md): Review a timeline of your actions across projects, organizations, and teams in Archie.
- [Managing your account](https://archie.com/docs/introduction/account/managing-your-account.md): Overview of the My Account surface in Archie — profile, billing, notifications, activity, and security in one place.
- [Notifications](https://archie.com/docs/introduction/account/notifications.md): Configure email and in-app notifications for Archie project events, team activity, and billing.
- [Profile and preferences](https://archie.com/docs/introduction/account/profile-and-preferences.md): Update your name, email, time zone, and Archie interface preferences from your account settings.
- [Security](https://archie.com/docs/introduction/account/security.md): Manage your password, two-factor authentication, active sessions, and connected devices for your Archie account.
- [Community](https://archie.com/docs/introduction/community-support/community.md): The Archie Discord is where builders share work, ask questions, and talk to the team — plus LinkedIn for company updates.
- [Contacting support](https://archie.com/docs/introduction/community-support/contacting-support.md): Two ways to reach Archie support — Discord for most questions, email for anything account, billing, security, or private.
- [FAQ](https://archie.com/docs/introduction/community-support/faq.md): 50 answers to common questions about Archie — getting started, building, the blueprint, comparisons to other tools, pricing, infrastructure, security, and account topics.
- [Troubleshooting](https://archie.com/docs/introduction/community-support/troubleshooting.md): Common Archie issues and their fixes — sign-in, build failures, deployment problems, missing data, and more.
- [Overview](https://archie.com/docs/introduction/enterprise/overview.md): Enterprise-grade Archie with SSO, SOC 2, HIPAA, GDPR, dedicated infrastructure, custom pricing, and dedicated support.
- [Create an account](https://archie.com/docs/introduction/getting-started/create-an-account.md): Sign up directly at app.archie.com or kick off your account by submitting a prompt at archie.com — both routes land you on the free plan with no credit card.
- [Plans and credits](https://archie.com/docs/introduction/getting-started/plans-and-credits.md): Compare Archie's Free, Pro, Team, and Enterprise plans, see Archie Core backend pricing, and learn how AI credits work.
- [Prompting best practices](https://archie.com/docs/introduction/getting-started/prompting-best-practices.md): How to think about what you're building so Archie's blueprint lands close to what you want, and where to spend your iteration time.
- [Quick start](https://archie.com/docs/introduction/getting-started/quick-start.md): Submit a prompt, review the blueprint, choose your scope and stack, and generate your app — Archie's idea-to-app flow end to end.
- [Welcome to Archie](https://archie.com/docs/introduction/getting-started/welcome.md): Archie is an agentic platform that turns ideas into production-ready apps. Start with a prompt, shape the blueprint, generate the build.
- [Managing team members](https://archie.com/docs/introduction/organizations/managing-team-members.md): Invite, remove, and assign roles to members of your Archie organization with per-project permissions.
- [Organization integrations](https://archie.com/docs/introduction/organizations/organization-integrations.md): Connect GitHub, Slack, and other organization-wide integrations to your Archie organization for source control and notifications.
- [Overview](https://archie.com/docs/introduction/organizations/overview.md): Organizations let teams collaborate on shared Archie projects with pooled credits, role-based access, and centralized billing.
- [Setting up an organization](https://archie.com/docs/introduction/organizations/setting-up-an-organization.md): Create an Archie organization, configure billing and plan, and invite your team to collaborate on shared projects.