Documentation Index Fetch the complete documentation index at: https://mintlify.com/hyeprlabs/clypai/llms.txt
Use this file to discover all available pages before exploring further.
Account Setup & Configuration
This guide covers everything you need to set up your ClypAI account, configure your workspace, and manage your settings.
Creating Your Account
ClypAI offers flexible signup options to get you started quickly.
Signup Methods
Email Registration
GitHub OAuth
Waitlist Access
Create an account using your email address.
Complete Registration Form
Fill in the required information: // Required fields
{
name : string , // 3-32 characters
email : string , // Valid email format
password : string // 8-64 characters
}
Name Requirements:
Minimum 3 characters
Maximum 32 characters
Can include letters, numbers, and spaces
Email Requirements:
Must be a valid email format
Will be used for login and notifications
Password Requirements:
Minimum 8 characters
Maximum 64 characters
Recommended: Mix of uppercase, lowercase, numbers, and symbols
Create Account
Click “Create Account” to complete registration. You’ll be automatically logged in and redirected to /overview.
Your password is hashed using Better Auth’s secure encryption before storage. ClypAI never stores plain-text passwords.
Sign up using your GitHub account for quick authentication.
Click GitHub Button
Click “Continue with GitHub” to initiate OAuth flow.
Authorize Application
On GitHub’s authorization page:
Review requested permissions
Click “Authorize” to grant access
ClypAI requests:
Read access to your profile (name, email)
Read access to your public repositories (optional)
Redirect to Dashboard
After authorization, you’ll be redirected to /overview?provider=github with your account created automatically.
Using GitHub OAuth means you never need to manage a separate password for ClypAI. Sign in with GitHub anytime.
If public signups are currently disabled, join the waitlist.
Enter Email
In the waitlist form, enter your email address: // Waitlist signup
await authClient . waitlist . join ({
email: "your-email@example.com"
})
Confirmation
Upon successful submission:
You’ll see a success toast notification
A confetti animation confirms your registration
Check your email for confirmation
Wait for Invitation
When spots open up:
You’ll receive an email invitation
Follow the link to create your account
No need to rejoin the waitlist
Waitlist mode is enabled during beta or maintenance periods. Follow @clypai on X for updates on availability.
Login Process
Once your account is created, log in at https://clypai.com/login .
Enter Credentials
Use your email and password, or click “Continue with GitHub” for OAuth login.
Authentication
ClypAI uses Better Auth for secure session management:
Sessions are stored securely
Automatic token refresh
Support for remember me functionality
Redirect to Dashboard
After successful login, you’ll be redirected to your dashboard at /overview.
Organization Management
Organizations are the primary way to structure your workspace in ClypAI. Each organization has its own projects, connections, brand kits, and settings.
Creating an Organization
Access Organization Creator
Click the organization switcher in the sidebar, then select “Create Organization” or click the create button.
Fill Organization Details
Enter your organization information in the dialog: Name Field
Example: “Acme Corp.”
Minimum 3 characters
Displayed in the UI and organization switcher
Slug Field
Example: “acme”
URL-friendly identifier
Auto-generated from name, but customizable
Must match regex: ^[a-zA-Z0-9-]+$
Used in URLs and API endpoints
// Organization creation schema
const schema = z . object ({
name: z . string (). min ( 3 , "Name must be at least 3 characters." ),
slug: z . string ()
. min ( 3 , "Slug must be at least 3 characters." )
. regex ( / ^ [ a-zA-Z0-9- ] + $ / , "Only letters, numbers and hyphens are allowed." )
})
Auto-Slug Generation
As you type the name, the slug is automatically generated:
“Acme Corp.” → “acme-corp”
“My Awesome Agency” → “my-awesome-agency”
“Test123” → “test123”
You can manually edit the slug if needed. Once you manually edit it, auto-generation stops.
Create Organization
Click “Create Organization” to finalize. The new organization becomes your active workspace. // Organization creation API call
await authClient . organization . create ({
name: data . name ,
slug: data . slug ,
userId: session . user . id ,
keepCurrentActiveOrganization: false
})
The organization creator adapts to your device—it uses a dialog on desktop and a drawer on mobile for the best experience.
Switching Organizations
You can create and manage multiple organizations for different projects or clients.
Open Organization Switcher
Click the organization name in the sidebar to open the switcher.
Select Organization
Click on any organization in the list to switch to it. The active organization is highlighted.
Context Switch
All dashboard views (projects, connections, metrics, etc.) will update to show data for the selected organization.
Each organization maintains separate:
Projects and clips
Social media connections
Brand kits and templates
Team members (coming soon)
Billing and usage quotas
Dashboard Overview
After logging in, you’ll land on the Overview dashboard at /overview.
Navigation Structure
The sidebar contains primary navigation items: Overview (/overview)
Dashboard home with welcome message
Quick stats and recent activity
Getting started guide
Create (/create)
Upload and process videos
Generate AI clips
Main content creation workflow
Projects (/projects)
Manage your video projects
View processing status
Access generated clips
Connections (/connections)
Manage social media integrations
Add new platform connections
View connection status
Brand Kits (/brand-kits)
Create reusable brand assets
Manage fonts, colors, and logos
Apply consistent styling
Metrics (/metrics)
Analytics and performance data
Track clip engagement
Platform-specific insights
Workers (/workers)
Background job status
Processing queue
Job history and logs
Connect your social media accounts to enable direct publishing from ClypAI.
TikTok Connect your TikTok account to post clips directly to your profile
Instagram Business Link Instagram Business or Creator accounts for Reels posting
YouTube Connect your YouTube channel to publish Shorts automatically
X (Twitter) Link your X account for seamless video posting
Adding a Connection
Navigate to Connections
Click “Connections” in the sidebar navigation.
Open Connection Dialog
Click “Add Connection” button to see available platforms.
Select Platform
Choose the platform you want to connect from the list: // Available platforms
const platforms = [
{ id: "1" , name: "TikTok" , slug: "tiktok" },
{ id: "2" , name: "Instagram Business" , slug: "instagram" },
{ id: "3" , name: "YouTube" , slug: "youtube" },
{ id: "4" , name: "X/Twitter" , slug: "x" }
]
Authorize Platform
You’ll be redirected to the platform’s OAuth page: TikTok Authorization
Grants permission to post videos
Access to basic profile information
Instagram Authorization
Requires Business or Creator account
Grants permission to post Reels
Access to Instagram Insights
YouTube Authorization
Grants permission to upload videos
Access to channel information
X Authorization
Grants permission to post videos
Access to basic profile information
Verify Connection
After authorization:
You’ll be redirected back to ClypAI
The connection appears in your connections list
Connection status shows as “Active”
Instagram Requirements:
Must use a Business or Creator account
Personal accounts cannot be connected due to Instagram API limitations
Convert your account in Instagram settings under “Account Type”
Managing Connections
Each connection card displays:
Platform name and logo
Connected username
Connection status (Active/Inactive)
Created and last updated timestamps
View Connection Details
Reconnect Account
Remove Connection
Click on a connection card to view detailed information:
Account username and avatar
Authorization scope
Connection health status
Usage statistics
If a connection becomes inactive:
Click the dropdown menu on the connection card
Select “Reconnect”
Re-authorize on the platform
To disconnect a platform:
Click the dropdown menu on the connection card
Select “Remove”
Confirm deletion in the dialog
Revoke access on the platform’s settings (recommended)
Brand Kits
Brand Kits allow you to create reusable styling templates for consistent branding across all your clips.
Creating a Brand Kit
Navigate to Brand Kits
Click “Brand Kits” in the sidebar navigation.
Create New Kit
Click “Create Brand Kit” to open the brand kit editor.
Configure Branding
Set up your brand elements: Colors
Primary brand color
Secondary/accent colors
Text colors
Background colors
Typography
Primary font family
Secondary font family
Font weights and styles
Logo
Upload your logo (PNG or SVG)
Set positioning and size
Configure opacity and blending
Caption Styling
Font selection
Size and positioning
Animation style
Background and outline
Save Brand Kit
Name your brand kit and save it. You can create multiple kits for different clients or campaigns.
Applying Brand Kits
When creating clips:
Select a brand kit from the dropdown
All styling is applied automatically
Override individual settings if needed
Preview before processing
Brand Kits are organization-specific. Each organization maintains its own library of brand kits.
Profile Settings
Manage your personal account settings and preferences.
Navigate to Profile
Click your avatar in the sidebar, then select “Profile”.
Edit Information
Update your profile details:
Name
Email address
Avatar/profile picture
Change Password
If you signed up with email:
Enter current password
Enter new password (8-64 characters)
Confirm new password
Click “Update Password”
If you signed up with GitHub OAuth, password management is handled by GitHub.
Save Changes
Click “Save” to update your profile information.
Notification Preferences
Configure which notifications you want to receive.
Navigate to Notifications
Go to /settings/notifications from the settings menu.
Configure Email Notifications
Toggle notifications for:
Video processing completion
Clip publishing status
Performance milestones
Account and billing updates
Product announcements
Configure Push Notifications
Enable browser notifications for:
Real-time processing updates
Team mentions (coming soon)
Important alerts
Save Preferences
Your notification settings are saved automatically.
Organization Settings
Manage organization-level configuration and preferences.
Updating Organization Details
Navigate to Organization Settings
Go to /settings/organization from the settings menu.
Edit Organization Info
Update:
Organization name
Organization slug
Organization avatar/logo
Default Settings
Configure organization-wide defaults:
Default clip length
Default platform targets
Default caption style
Default brand kit
Save Changes
Click “Save” to apply organization settings.
Changing the organization slug will update all URLs associated with that organization. Update any saved bookmarks accordingly.
Billing & Subscription
Manage your ClypAI subscription and usage.
Current Plan
Upgrade Plan
Usage Monitoring
View your current subscription details:
Plan name (Free or Pro)
Monthly/yearly billing
Current usage
Quota limits
To upgrade from Free to Pro:
Click Upgrade
In organization settings, click “Upgrade to Pro”.
Choose Billing Cycle
Select monthly (29 / m o n t h ) o r y e a r l y ( 29/month) or yearly ( 29/ m o n t h ) orye a r l y ( 290/year) billing. Yearly billing saves you $58 per year compared to monthly.
Enter Payment Details
Provide payment information securely processed by Polar.
Confirm Upgrade
Review and confirm your subscription. Pro features activate immediately.
Track your usage against plan limits: Free Plan Limits:
3 platform integrations
1,000 API calls/month
Basic analytics
Community support
Pro Plan Limits:
Unlimited integrations
100,000 API calls/month
Advanced analytics
Priority support
Custom webhooks
Team collaboration
Usage resets on the first day of each billing cycle.
Security & Authentication
Session Management
ClypAI uses Better Auth for secure session handling:
Sessions are stored in secure, HTTP-only cookies
Automatic token refresh for extended sessions
Session expiration after 30 days of inactivity
Logout clears all session data
Logging Out
Open User Menu
Click your avatar in the sidebar.
Select Logout
Click “Log out” from the dropdown menu.
Confirm Logout
Confirm in the alert dialog. You’ll be redirected to the homepage.
For security, always log out when using shared or public computers.
Account Security Best Practices
Minimum 8 characters, ideally 12+
Mix uppercase, lowercase, numbers, and symbols
Don’t reuse passwords from other sites
Consider using a password manager
Enable OAuth When Possible
GitHub OAuth is more secure than password authentication
OAuth uses temporary tokens instead of stored passwords
Easier to revoke access if needed
Review Connected Platforms
Check the Workers page for unexpected jobs
Review usage metrics regularly
Report suspicious activity to support immediately
Next Steps
Now that your account is set up, you’re ready to create content!
Create Your First Clip Follow our quick start guide to generate your first AI clip
Connect Social Media Link your platforms for seamless publishing
Set Up Brand Kits Create consistent branding for all your clips
Explore Features Learn about all of ClypAI’s powerful features
Troubleshooting
Solutions:
Verify your email and password are correct
Try resetting your password
Clear browser cookies and cache
Try a different browser or incognito mode
If using GitHub OAuth, ensure GitHub account is accessible
Organization Creation Fails
Solutions:
Check that the slug is unique
Ensure slug only contains letters, numbers, and hyphens
Verify name is at least 3 characters
Try a different organization name/slug combination
Platform Connection Issues
Solutions:
Ensure email format is valid
Check password meets minimum requirements
Try refreshing the page
Log out and back in
Contact support if error persists
Get Support
Join Community Connect with other users and get help from the community
Contact Support Reach out to our support team for assistance