Novel
Get NovelGuidesAPI Reference
Latest - 2025.1.0
Latest - 2025.1.0
  • Welcome to Novel
  • Start
  • Philosophy
  • Tech Stack
  • Releases
  • Versions
  • Changelog
  • License
  • Privacy
  • Warranty
  • Security Policy
  • Errors
    • Cannot start Novel
    • Unauthorized
    • Invalid Session
    • Validation Failed
  • Novel Server
    • Getting Started
    • Project Structure
    • With Novel Web
    • Configuration
    • Novel CLI
      • novel dev
      • novel start
      • novel new
    • Novel API
      • API Reference
    • Database
      • Caching
    • Migrations
    • Models
    • Routing
      • Route Directives
      • Middleware
      • Request Helpers
      • Schema
    • Sessions
    • Authentication
      • Passwords
      • Magic Links
      • Two-Factor Authentication
      • Forget Password
      • Email Verification
      • OAuth2 Support
    • Authorization
    • Users
    • Organizations
    • Subscriptions
    • Pricing
    • Validation
    • Mail
    • Notifications
    • API Keys
    • Events
    • Errors
    • Feature Flags
    • Uploading Files
    • Testing
    • Scheduled Cron Jobs
    • Background Jobs
    • Sockets
    • Logging
    • Telemetry
    • Deployment
  • Novel Web
    • Getting Started
    • Configuration
    • Project Structure
    • Routing
    • Layout and Styles
    • Authentication
    • Authorization
    • Requests
    • Request Files
    • Validation
    • Components
      • Button
      • Alerts
      • Copybox
      • Inline Notify
      • Input
      • Select
      • Toast
      • Toggle
      • Upload
      • Stripe Card
    • Hooks
      • useSession
      • useMobile
      • getSession
      • useFeature
      • useAuthorized
      • useNotification
      • useSocket
    • Localstorage
    • Errors
    • Internationalization (i18n)
    • Constants
    • Feature Flags
    • Testing
    • Telemetry
    • Deployment
    • Devtools (Alpha)
Powered by GitBook
On this page
  • Configuring your Instance
  • Working with the API
  • Working with Data

Was this helpful?

  1. Novel Server

Getting Started

Last updated 5 months ago

Was this helpful?

Your license grants you access to the repository where the Novel API codebase can be cloned and installed from.

Novel Web, Novel Studio, and Novel Native(Soon) all make use of the Novel API to function. You will not be able to use any of these other products without Novel API.

You can start by checking any of the guides below or searching with the documentation search box.

Configuring your Instance

Working with the API

Working with Data

How do I define my Pricing?

How can I send emails?

What configurations are available?

How do I create a new endpoint?

How do I secure endpoints?

How can I write my own middleware?

How do I use background jobs?

How can I set up a scheduled cron job?

How do I setup my Social Providers

How do I write tests for my features?

How do I create a new Table?

How do I override an existing Model?

How can I query my new tables?

How do I make updates?

How does validation work?

https://github.com/madewithnovel/novel
Start | Novel
Logo