Developer Documentation โ
Overview โ
Welcome to the Quaily Developer Documentation! This guide provides all the information you need to integrate your applications and services with Quaily. Whether you're looking to build custom publishing workflows, automate content management, or create unique reader experiences, our API offers the flexibility and power to bring your ideas to life.
Quaily empowers creators to build vibrant membership communities. Our developer tools are designed to extend that power, allowing you to connect, create, and innovate.
Getting Started โ
To start building with Quaily, you'll typically follow these steps:
- Authentication: Familiarize yourself with our Authorization methods to securely connect to the API.
- Explore API References: Understand the available API endpoints for interacting with Users, Channels, Posts, and more.
- Make Your First Call: Try a simple API request, like fetching your user details or listing your channels.
API Base โ
Quaily's API base URL is:
https://api.quail.inkAuthentication โ
Securely access the Quaily API.
Key Concepts โ
Understanding these core Quaily concepts will help you navigate our API:
- User: Represents an individual account on Quaily, whether a creator or a reader.
- Channel: A creator's publication space where posts are published.
- Post: An article or piece of content published within a channel.
- Subscription: Represents a reader's subscription to a channel.
Opensource Projects โ
If you prefer to start with production-ready code, Quaily provides some opensource projects to help you get started.
- Quaily CLI: A command line tool to help you manage your Quaily account.
- Obsidian Plugin of Quaily: The Obsidian plugin for Quaily.
API Reference โ
Detailed information about each API endpoint:
- Response Object: The standard response structure for all API calls.
- User: Manage user-related operations.
- Channel: Interact with channels and their settings.
- Post: Create, retrieve, update, and delete posts.
- Subscription: Manage channel subscriptions.
- Attachment: Upload and manage file attachments for posts.
- Composer: Leverage AI functionalities to assist with content creation.
Community & Support โ
Join our developer community on Discord to ask questions, share your projects, and get support from the Quaily team and other developers.
We are excited to see what you build with Quaily!