BETA
This is a beta version of Cognitor CMS. Features may be incomplete or subject to change.

API Documentation
BETA

Complete REST API reference for Cognitor CMS

Total Endpoints

110

AI Features

11

Public Access

11

Avg Timeout

45s

Authentication

Most endpoints require JWT authentication. Public endpoints are clearly marked.

Token Type

JWT Bearer Token

Header Format

Authorization: Bearer <token>

Token Expiration

24 hours

User Roles

Admin
Editor
Author

Authentication & Users
7 endpoints

User management, authentication, and authorization endpoints

POST
/auth/login
Public

User login with email and password

Timeout: 30s
Public Access
GET
/auth/currentuser

Get details of currently authenticated user

Timeout: 20s
Auth Required
GET
/users/

List all users (requires authentication)

Timeout: 20s
Auth Required
POST
/users/
Public

Create a new user account

Timeout: 30s
Public Access
GET
/users/{user_id}

Get user details by ID

Timeout: 20s
Auth Required
PATCH
/users/{user_id}

Update user information (username, email, role)

Timeout: 30s
Auth Required
DELETE
/users/{user_id}

Delete user account (admin or self)

Timeout: 30s
Auth Required

Sites & Content Management
11 endpoints

Multi-site management and content operations

GET
/sites/

List all sites with pagination

Timeout: 20s
Auth Required
POST
/sites/

Create a new site

Timeout: 30s
Auth Required
GET
/sites/{site_identifier}

Get site details by identifier

Timeout: 20s
Auth Required
PATCH
/sites/{site_identifier}

Update site information

Timeout: 30s
Auth Required
DELETE
/sites/{site_identifier}

Delete a site

Timeout: 30s
Auth Required
GET
/{site_identifier}/posts/

List posts for a specific site

Timeout: 20s
Auth Required
POST
/{site_identifier}/posts/

Create a new post

Timeout: 30s
Auth Required
GET
/{site_identifier}/posts/{post_id}

Get specific post details

Timeout: 20s
Auth Required
PATCH
/{site_identifier}/posts/{post_id}

Update post content and metadata

Timeout: 30s
Auth Required
DELETE
/{site_identifier}/posts/{post_id}

Delete a post

Timeout: 30s
Auth Required
POST
/{site_identifier}/posts/{post_id}/transform
AI

Transform post content using AI prompts

Timeout: 60s
Auth Required

User-Site Associations
4 endpoints

Manage user assignments to sites

POST
/sites/{site_identifier}/users/{user_id}

Assign a user to a site (admin only)

Timeout: 30s
Auth Required
DELETE
/sites/{site_identifier}/users/{user_id}

Remove a user from a site (admin only)

Timeout: 30s
Auth Required
GET
/sites/{site_identifier}/users

List users assigned to a site

Timeout: 20s
Auth Required
GET
/users/{user_id}/sites

List sites a user is assigned to

Timeout: 20s
Auth Required

AI-Powered Media Generation
11 endpoints

Artificial intelligence features for content creation

POST
/{site_identifier}/media/generate
AI

Generate images using AI (FLUX, Stable Diffusion)

Timeout: 120s
Auth Required
POST
/{site_identifier}/media/generatevideo
AI

Generate videos using Kling 2.1 (without audio)

Timeout: 300s
Auth Required
POST
/{site_identifier}/media/generatevideo-veo3
AI

Generate videos using Google VEO3 (with audio support)

Timeout: 300s
Auth Required
POST
/{site_identifier}/media/tts
AI

Convert text to speech using OpenAI TTS

Timeout: 60s
Auth Required
POST
/{site_identifier}/media/{media_id}/edit-with-ai
AI

Edit images using AI (FLUX Kontext Max)

Timeout: 120s
Auth Required
POST
/{site_identifier}/media/{media_id}/generate-metadata
AI

Generate SEO metadata using GPT-4o Vision

Timeout: 30s
Auth Required
POST
/{site_identifier}/seo/generatetext
AI

Generate text content using OpenAI GPT models

Timeout: 60s
Auth Required
POST
/{site_identifier}/seo/analyze
AI

Analyze content for SEO optimization

Timeout: 30s
Auth Required
POST
/{site_identifier}/generate-website/
AI

Generate complete websites using v0 AI

Timeout: 180s
Auth Required
POST
/{site_identifier}/generate-website/preview
AI

Preview website generation without creating files

Timeout: 60s
Auth Required
POST
/{site_identifier}/generate-website/deploy-to-netlify
AI

Generate and deploy website directly to Netlify

Timeout: 300s
Auth Required

Media Library & Storage
11 endpoints

File management, uploads, and media organization

GET
/{site_identifier}/media/

List media files with pagination and filtering

Timeout: 20s
Auth Required
POST
/{site_identifier}/media/

Upload new media files

Timeout: 120s
Auth Required
GET
/{site_identifier}/media/{media_id}

Get media file details

Timeout: 20s
Auth Required
PATCH
/{site_identifier}/media/{media_id}

Update media metadata

Timeout: 30s
Auth Required
DELETE
/{site_identifier}/media/{media_id}

Delete media file

Timeout: 30s
Auth Required
GET
/{site_identifier}/media/count

Get total media count for site

Timeout: 10s
Auth Required
POST
/{site_identifier}/media/{media_id}/move

Move media file to different folder

Timeout: 30s
Auth Required
GET
/{site_identifier}/media/{media_id}/image-editor-access

Validate image editor access for media item

Timeout: 10s
Auth Required
POST
/{site_identifier}/media/{media_id}/save-edited-image

Save edited image as new version or replace original

Timeout: 60s
Auth Required
GET
/{site_identifier}/media/{media_id}/image-versions

Get all versions of an image

Timeout: 20s
Auth Required
POST
/{site_identifier}/media/webhook/fal
Public

Webhook endpoint for FAL AI service results

Timeout: 30s
Public Access

Media Folders
7 endpoints

Hierarchical folder organization for media files

GET
/{site_identifier}/media/folders/

List media folders with optional parent filtering

Timeout: 20s
Auth Required
POST
/{site_identifier}/media/folders/

Create new media folder

Timeout: 30s
Auth Required
GET
/{site_identifier}/media/folders/tree

Get complete folder tree structure

Timeout: 20s
Auth Required
GET
/{site_identifier}/media/folders/{folder_id}

Get specific folder details

Timeout: 20s
Auth Required
PATCH
/{site_identifier}/media/folders/{folder_id}

Update folder name or parent

Timeout: 30s
Auth Required
DELETE
/{site_identifier}/media/folders/{folder_id}

Delete folder and optionally its contents

Timeout: 30s
Auth Required
POST
/{site_identifier}/media/folders/{folder_id}/move

Move folder to new parent location

Timeout: 30s
Auth Required

Content Types & Elements
13 endpoints

Dynamic content types and content element management

GET
/{site_identifier}/contenttypes/

List content types for site

Timeout: 20s
Auth Required
POST
/{site_identifier}/contenttypes/

Create new content type

Timeout: 30s
Auth Required
GET
/{site_identifier}/contenttypes/{type_id}

Get specific content type details

Timeout: 20s
Auth Required
PATCH
/{site_identifier}/contenttypes/{type_id}

Update content type schema

Timeout: 30s
Auth Required
DELETE
/{site_identifier}/contenttypes/{type_id}

Delete content type

Timeout: 30s
Auth Required
POST
/{site_identifier}/contenttypes/validate

Validate content type schema

Timeout: 10s
Auth Required
GET
/{site_identifier}/contenttypes/{type_id}/dependencies

Get content type dependencies

Timeout: 20s
Auth Required
GET
/{site_identifier}/elements/

List content elements with type filtering

Timeout: 20s
Auth Required
POST
/{site_identifier}/elements/

Create content element

Timeout: 30s
Auth Required
GET
/{site_identifier}/elements/{element_id}

Get specific content element

Timeout: 20s
Auth Required
PATCH
/{site_identifier}/elements/{element_id}

Update content element data

Timeout: 30s
Auth Required
DELETE
/{site_identifier}/elements/{element_id}

Delete content element

Timeout: 30s
Auth Required
DELETE
/{site_identifier}/elements/{element_id}/force

Force delete content element (admin cleanup)

Timeout: 30s
Auth Required

Pages & Page Builder
8 endpoints

Page management and content element composition

GET
/{site_identifier}/pages/

List pages with content elements

Timeout: 20s
Auth Required
POST
/{site_identifier}/pages/

Create new page

Timeout: 30s
Auth Required
GET
/{site_identifier}/pages/{page_id}

Get specific page with content elements

Timeout: 20s
Auth Required
PATCH
/{site_identifier}/pages/{page_id}

Update page metadata

Timeout: 30s
Auth Required
DELETE
/{site_identifier}/pages/{page_id}

Delete page

Timeout: 30s
Auth Required
POST
/{site_identifier}/pages/{page_id}/elements

Add content element to page

Timeout: 30s
Auth Required
PATCH
/{site_identifier}/pages/{page_id}/elements/{element_id}

Update page element position and layout

Timeout: 30s
Auth Required
DELETE
/{site_identifier}/pages/{page_id}/elements/{element_id}

Remove element from page

Timeout: 30s
Auth Required

Search & Analytics
7 endpoints

Elasticsearch-powered search and analytics features

GET
/search/sites/{site_identifier}
Public

Search content across site (public endpoint)

Timeout: 20s
Public Access
GET
/search/sites/{site_identifier}/suggest
Public

Get search suggestions/autocomplete

Timeout: 10s
Public Access
GET
/search/sites/{site_identifier}/stats

Get search statistics (requires auth)

Timeout: 20s
Auth Required
GET
/search/sites/{site_identifier}/analytics

Get search analytics with trends

Timeout: 20s
Auth Required
POST
/search/admin/sites/{site_identifier}/reindex

Reindex site content for search (admin only)

Timeout: 60s
Auth Required
GET
/search/admin/health

Get Elasticsearch cluster health (admin only)

Timeout: 10s
Auth Required
DELETE
/search/admin/sites/{site_identifier}/index

Delete entire search index for site (admin only)

Timeout: 30s
Auth Required

Transactions & Credits
8 endpoints

Cost tracking, credit management, and usage analytics

GET
/{site_identifier}/transactions/cost-settings

Get cost settings for site

Timeout: 10s
Auth Required
PUT
/{site_identifier}/transactions/cost-settings

Update cost settings for site

Timeout: 30s
Auth Required
GET
/{site_identifier}/transactions/credits/balance

Get current user's credit balance

Timeout: 10s
Auth Required
POST
/{site_identifier}/transactions/credits/add

Add credits to user balance (admin only)

Timeout: 30s
Auth Required
POST
/{site_identifier}/transactions/credits/check

Check if user has sufficient credits

Timeout: 10s
Auth Required
GET
/{site_identifier}/transactions/

List transactions with filtering and pagination

Timeout: 20s
Auth Required
GET
/{site_identifier}/transactions/stats

Get transaction statistics

Timeout: 20s
Auth Required
GET
/{site_identifier}/transactions/monthly-usage

Get monthly usage statistics

Timeout: 20s
Auth Required

Prompts & System Configuration
8 endpoints

Reusable prompts and system prompt management

GET
/transferprompts/

List reusable transfer prompts

Timeout: 20s
Auth Required
POST
/transferprompts/

Create new transfer prompt (admin only)

Timeout: 30s
Auth Required
PATCH
/transferprompts/{prompt_id}

Update transfer prompt

Timeout: 30s
Auth Required
DELETE
/transferprompts/{prompt_id}

Delete transfer prompt

Timeout: 30s
Auth Required
GET
/system-prompts/

Get all system prompts (requires auth)

Timeout: 20s
Auth Required
GET
/system-prompts/{prompt_type}
Public

Get system prompt by type (image, video, text)

Timeout: 10s
Public Access
POST
/system-prompts/{prompt_type}

Create or update system prompt (admin only)

Timeout: 30s
Auth Required
DELETE
/system-prompts/{prompt_type}

Delete system prompt (admin only)

Timeout: 30s
Auth Required

Cache Management
3 endpoints

Redis cache management and optimization

DELETE
/admin/cache/all

Clear entire Redis cache (admin only)

Timeout: 30s
Auth Required
DELETE
/admin/cache/site/{site_id}

Clear cache for specific site

Timeout: 30s
Auth Required
DELETE
/admin/cache/element/{element_id}/site/{site_id}

Clear cache for specific content element

Timeout: 30s
Auth Required

System Administration
7 endpoints

Admin-only endpoints for monitoring and system management

GET
/admin/monitoring/system-health

Get overall system health status

Timeout: 10s
Auth Required
GET
/admin/monitoring/cache-statistics

Get detailed cache performance statistics

Timeout: 10s
Auth Required
GET
/admin/monitoring/rate-limit-stats

Get rate limiting statistics

Timeout: 10s
Auth Required
GET
/admin/monitoring/performance-metrics

Get comprehensive performance metrics

Timeout: 20s
Auth Required
POST
/admin/monitoring/cache-cleanup

Manually trigger cache cleanup

Timeout: 30s
Auth Required
GET
/admin/monitoring/threat-intelligence

Get threat intelligence and security trends

Timeout: 20s
Auth Required
GET
/admin/monitoring/security-dashboard

Get comprehensive security monitoring dashboard

Timeout: 20s
Auth Required

Public API
5 endpoints

Public endpoints for website rendering and content access

GET
/public/{site_identifier}/pages
Public

Get published pages (public access)

Timeout: 20s
Public Access
GET
/public/{site_identifier}/pages/{page_id}
Public

Get specific published page with content elements

Timeout: 20s
Public Access
GET
/public/{site_identifier}/elements
Public

List published content elements (public access)

Timeout: 20s
Public Access
GET
/public/{site_identifier}/elements/{element_id}
Public

Get content element for public rendering

Timeout: 20s
Public Access
GET
/
Public

API root endpoint

Timeout: 5s
Public Access

Quick Start

Get started with the Cognitor CMS API in minutes

1. Authentication

curl -X POST "https://api.cognitor.com/login" \ -H "Content-Type: application/json" \ -d '{"email": "your@email.com", "password": "password"}'

2. Make API Calls

curl -X GET "https://api.cognitor.com/sites/" \ -H "Authorization: Bearer YOUR_JWT_TOKEN"