API DocumentationBETA
Complete API reference for Cognitor agent workflows
Total Endpoints
234
Agent Operations
9
Public Access
31
Avg Timeout
45s
Authentication
Most endpoints require JWT authentication. Public endpoints are clearly marked for read-only agent access.
Token Type
JWT Bearer Token
Header Format
Token Expiration
Configurable
User Roles
Admin Fraud Detection4 endpoints
Endpoints grouped under 'Admin Fraud Detection' from production OpenAPI.
/admin/fraud/abuse-patternsGet Abuse Patterns
/admin/fraud/block-tenant/{tenant_id}Block Abusive Tenant
/admin/fraud/blocked-signupsGet Blocked Signups
/admin/fraud/suspicious-signupsGet Suspicious Signups
Admin Content Types1 endpoints
Endpoints grouped under 'Admin Content Types' from production OpenAPI.
/admin/content-types/distributeDistribute Content Type
Admin Monitoring7 endpoints
Endpoints grouped under 'Admin Monitoring' from production OpenAPI.
/admin/monitoring/cache-cleanupTrigger Cache Cleanup
/admin/monitoring/cache-statisticsGet Cache Stats
/admin/monitoring/performance-metricsGet Performance Metrics
/admin/monitoring/rate-limit-statsGet Rate Limit Statistics
/admin/monitoring/security-dashboardGet Security Dashboard
/admin/monitoring/system-healthGet System Health
/admin/monitoring/threat-intelligenceGet Threat Intelligence
Agents17 endpoints
Endpoints grouped under 'Agents' from production OpenAPI.
/api/agentsList Agents
/api/agentsCreate Agent
/api/agents/List Agents
/api/agents/Create Agent
/api/agents/admin/allGet All Agents With Tenants
/api/agents/knowledge-base/{doc_id}/compute-rag-indexCompute Rag Index
/api/agents/tenant/{tenant_id}/countGet Tenant Agents Count
/api/agents/{agent_id}Delete Agent
/api/agents/{agent_id}Get Agent
/api/agents/{agent_id}Update Agent
/api/agents/{agent_id}/avatar/{media_id}Set Agent Avatar From Media
/api/agents/{agent_id}/knowledge-baseGet Agent Knowledge Base
/api/agents/{agent_id}/knowledge-base/from-post/{post_id}Add Post To Knowledge Base
/api/agents/{agent_id}/knowledge-base/{doc_id}Remove Knowledge Base Document
/api/agents/{agent_id}/tenantsGet Agent Tenants
/api/agents/{agent_id}/tenants/{tenant_id}Remove Agent From Tenant
/api/agents/{agent_id}/tenants/{tenant_id}Assign Agent To Tenant
Authentication13 endpoints
Endpoints grouped under 'Authentication' from production OpenAPI.
/auth/currentuserGet Current User Me
/auth/loginLogin
/auth/logoutLogout
/auth/password-reset-confirmConfirm Password Reset
/auth/password-reset-requestRequest Password Reset
/auth/refresh-tokenRefresh Token
/auth/signup/Signup
/auth/signup/oauth/callbackOauth Callback
/auth/signup/oauth/{provider}Initiate Oauth
/auth/signup/resend-verificationResend Verification Email
/auth/signup/verify-emailVerify Email
/auth/tokenClient Credentials Token
/auth/token-infoGet Token Info
Cache Management3 endpoints
Endpoints grouped under 'Cache Management' from production OpenAPI.
/admin/cache/allClear All Cache
/admin/cache/element/{element_id}/site/{site_id}Clear Element Cache
/admin/cache/site/{site_id}Clear Site Cache
Contact2 endpoints
Endpoints grouped under 'Contact' from production OpenAPI.
/api/contactSubmit Contact Form
/api/contact/test-smtpTest Smtp Configuration
Content Elements Admin6 endpoints
Endpoints grouped under 'Content Elements Admin' from production OpenAPI.
/{site_identifier}/elements/List Content Elements
/{site_identifier}/elements/Create Content Element
/{site_identifier}/elements/{element_id}Delete Content Element
/{site_identifier}/elements/{element_id}Read Content Element
/{site_identifier}/elements/{element_id}Update Content Element
/{site_identifier}/elements/{element_id}/forceForce Delete Content Element
Content Types8 endpoints
Endpoints grouped under 'Content Types' from production OpenAPI.
/{site_identifier}/contenttypes/List Content Types
/{site_identifier}/contenttypes/Create Content Type
/{site_identifier}/contenttypes/validateValidate Content Type Schema
/{site_identifier}/contenttypes/{type_id}Delete Content Type
/{site_identifier}/contenttypes/{type_id}Read Content Type
/{site_identifier}/contenttypes/{type_id}Update Content Type
/{site_identifier}/contenttypes/{type_id}/copyCopy Content Type
/{site_identifier}/contenttypes/{type_id}/dependenciesGet Content Type Dependencies
General5 endpoints
Endpoints grouped under 'General' from production OpenAPI.
/Root
/healthHealth Check
/health/liveLiveness Check
/health/readyReadiness Check
/health/redisRedis Health Check
Global Cost Settings16 endpoints
Endpoints grouped under 'Global Cost Settings' from production OpenAPI.
/admin/global-cost-settings/List Global Cost Settings
/admin/global-cost-settings/Create Global Cost Setting
/admin/global-cost-settings/bulkBulk Update Global Cost Settings
/admin/global-cost-settings/credit-overviewGet Global Credit Overview
/admin/global-cost-settings/publicGet Public Global Cost Settings
/admin/global-cost-settings/readonly/currentGet Current Cost Settings Readonly
/admin/global-cost-settings/sites/{site_id}/creditsGet Site Credit Details
/admin/global-cost-settings/tenant-creditsGet All Tenant Credits
/admin/global-cost-settings/tenant-credits/allocateAllocate Tenant Credits
/admin/global-cost-settings/tenant-credits/{tenant_id}Get Tenant Credit Balance
/admin/global-cost-settings/tenant-credits/{tenant_id}/monthly-limitUpdate Tenant Monthly Limit
/admin/global-cost-settings/user-credits/allocateAllocate User Credits Directly
/admin/global-cost-settings/users/creditsGet All Users Credit Summary
/admin/global-cost-settings/{setting_id}Delete Global Cost Setting
/admin/global-cost-settings/{setting_id}Get Global Cost Setting
/admin/global-cost-settings/{setting_id}Update Global Cost Setting
Media20 endpoints
Endpoints grouped under 'Media' from production OpenAPI.
/{site_identifier}/media/List Media Files
/{site_identifier}/media/Upload File
/{site_identifier}/media/by-id/{media_id}Get Media By Id
/{site_identifier}/media/countGet Media Count
/{site_identifier}/media/generateGenerate Image
/{site_identifier}/media/generatevideoGenerate Video
/{site_identifier}/media/generatevideo-sora2Generate Video Sora2
/{site_identifier}/media/generatevideo-veo3Generate Video Veo3
/{site_identifier}/media/ttsCreate Speech From Text
/{site_identifier}/media/webhook/falWebhook Fal Result
/{site_identifier}/media/{media_id}Delete Media File
/{site_identifier}/media/{media_id}Get Media Item
/{site_identifier}/media/{media_id}Update Media Metadata
/{site_identifier}/media/{media_id}/edit-with-aiEdit Image With Ai
/{site_identifier}/media/{media_id}/generate-metadataGenerate Media Metadata
/{site_identifier}/media/{media_id}/image-editor-accessValidate Image Editor Access
/{site_identifier}/media/{media_id}/image-versionsGet Image Versions
/{site_identifier}/media/{media_id}/moveMove Media File
/{site_identifier}/media/{media_id}/save-edited-imageSave Edited Image
/{site_identifier}/media/{media_id}/viewView Media File
Media Folders7 endpoints
Endpoints grouped under 'Media Folders' from production OpenAPI.
/{site_identifier}/media/folders/List Folders
/{site_identifier}/media/folders/Create Folder
/{site_identifier}/media/folders/treeGet Folder Tree
/{site_identifier}/media/folders/{folder_id}Delete Folder
/{site_identifier}/media/folders/{folder_id}Get Folder
/{site_identifier}/media/folders/{folder_id}Update Folder
/{site_identifier}/media/folders/{folder_id}/moveMove Folder
Pages Admin13 endpoints
Endpoints grouped under 'Pages Admin' from production OpenAPI.
/{site_identifier}/pages/List Pages
/{site_identifier}/pages/Create Page
/{site_identifier}/pages/batch-moveBatch Move Pages
/{site_identifier}/pages/reorderReorder Pages
/{site_identifier}/pages/treeGet Page Tree
/{site_identifier}/pages/{page_id}Delete Page
/{site_identifier}/pages/{page_id}Read Page
/{site_identifier}/pages/{page_id}Update Page
/{site_identifier}/pages/{page_id}/elementsAdd Element To Page
/{site_identifier}/pages/{page_id}/elements/batch-updateBatch Update Page Elements
/{site_identifier}/pages/{page_id}/elements/{element_id}Remove Element From Page
/{site_identifier}/pages/{page_id}/elements/{element_id}Update Page Element
/{site_identifier}/pages/{page_id}/moveMove Page
Payments4 endpoints
Endpoints grouped under 'Payments' from production OpenAPI.
/{site_identifier}/payments/create-checkout-sessionCreate Stripe Checkout Session
/{site_identifier}/payments/credit-packagesGet Credit Packages
/{site_identifier}/payments/transactionsGet Payment Transactions
/{site_identifier}/payments/transactions/{transaction_id}Get Payment Transaction
Payments Webhooks1 endpoints
Endpoints grouped under 'Payments Webhooks' from production OpenAPI.
/payments/webhookStripe Webhook Handler
Posts9 endpoints
Endpoints grouped under 'Posts' from production OpenAPI.
/{site_identifier}/posts/Get Posts
/{site_identifier}/posts/Create Post
/{site_identifier}/posts/from-pdfCreate Post From Pdf
/{site_identifier}/posts/from-urlCreate Post From Url
/{site_identifier}/posts/{post_id}Delete Post
/{site_identifier}/posts/{post_id}Get Post
/{site_identifier}/posts/{post_id}Update Post
/{site_identifier}/posts/{post_id}/recrawlRecrawl Post
/{site_identifier}/posts/{post_id}/transformTransform Post
Public Content10 endpoints
Endpoints grouped under 'Public Content' from production OpenAPI.
/public/{site_identifier}/content-typesList Public Content Types
/public/{site_identifier}/elementsList Public Content Elements
/public/{site_identifier}/elements/{element_id}Read Public Content Element
/public/{site_identifier}/elements/{element_id}/referencesGet Content Element References
/public/{site_identifier}/localesGet Site Locales
/public/{site_identifier}/media/{media_id}Get Public Media Metadata
/public/{site_identifier}/media/{media_id}/viewView Public Media
/public/{site_identifier}/navigationGet Public Navigation
/public/{site_identifier}/pagesList Public Pages
/public/{site_identifier}/pages/{page_id}Read Public Page
Search7 endpoints
Endpoints grouped under 'Search' from production OpenAPI.
/search/admin/healthElasticsearch Health
/search/admin/sites/{site_identifier}/indexDelete Site Index
/search/admin/sites/{site_identifier}/reindexReindex Site Content
/search/sites/{site_identifier}Search Site Content
/search/sites/{site_identifier}/analyticsGet Search Analytics
/search/sites/{site_identifier}/statsGet Search Stats
/search/sites/{site_identifier}/suggestGet Search Suggestions
Seo2 endpoints
Endpoints grouped under 'Seo' from production OpenAPI.
/{site_identifier}/seo/analyzeAnalyze Content For Seo
/{site_identifier}/seo/generatetextGenerate Text
Service Accounts5 endpoints
Endpoints grouped under 'Service Accounts' from production OpenAPI.
/api/service-accounts/List Service Accounts
/api/service-accounts/Create Service Account
/api/service-accounts/{service_account_id}Delete Service Account
/api/service-accounts/{service_account_id}Get Service Account
/api/service-accounts/{service_account_id}Update Service Account
Site Statistics6 endpoints
Endpoints grouped under 'Site Statistics' from production OpenAPI.
/{site_identifier}/site-statistics/diagnosticGet Diagnostic Info
/{site_identifier}/site-statistics/endpointsGet Endpoint Metrics
/{site_identifier}/site-statistics/healthGet Statistics Health
/{site_identifier}/site-statistics/monthlyGet Monthly Statistics
/{site_identifier}/site-statistics/overviewGet Site Statistics Overview
/{site_identifier}/site-statistics/sitesGet Site Breakdown
Sites6 endpoints
Endpoints grouped under 'Sites' from production OpenAPI.
/sites/Get Sites
/sites/Create Site
/sites/by-tenant/{tenant_id}Get Sites By Tenant
/sites/{site_identifier}Delete Site
/sites/{site_identifier}Get Site
/sites/{site_identifier}Update Site
Subscription7 endpoints
Endpoints grouped under 'Subscription' from production OpenAPI.
/subscription/allocate-monthly-creditsAllocate Monthly Credits Manually
/subscription/cancelCancel Subscription Endpoint
/subscription/currentGet Subscription Status
/subscription/portalCreate Billing Portal Session
/subscription/storageGet Storage Stats
/subscription/upgradeUpgrade Subscription
/subscription/verify-upgradeVerify Subscription Upgrade
System Prompts4 endpoints
Endpoints grouped under 'System Prompts' from production OpenAPI.
/system-prompts/Get All System Prompts
/system-prompts/{prompt_type}Delete System Prompt
/system-prompts/{prompt_type}Get System Prompt
/system-prompts/{prompt_type}Create Or Update System Prompt
Tenant Management12 endpoints
Endpoints grouped under 'Tenant Management' from production OpenAPI.
/admin/tenants/List Tenants
/admin/tenants/Create Tenant
/admin/tenants/current/infoGet Current User Tenant Context
/admin/tenants/{tenant_id}Delete Tenant
/admin/tenants/{tenant_id}Get Tenant
/admin/tenants/{tenant_id}Update Tenant
/admin/tenants/{tenant_id}/available-usersList Available Users For Tenant
/admin/tenants/{tenant_id}/cloneClone Tenant
/admin/tenants/{tenant_id}/usersList Tenant Users
/admin/tenants/{tenant_id}/users/{user_id}Remove User From Tenant
/admin/tenants/{tenant_id}/users/{user_id}Update User Role In Tenant
/admin/tenants/{tenant_id}/users/{user_id}Assign User To Tenant
Transactions11 endpoints
Endpoints grouped under 'Transactions' from production OpenAPI.
/{site_identifier}/transactions/List Transactions
/{site_identifier}/transactions/cost-settingsGet Cost Settings
/{site_identifier}/transactions/cost-settingsUpdate Cost Settings
/{site_identifier}/transactions/credits/addAdd Credits
/{site_identifier}/transactions/credits/allocate-from-tenantAllocate User Credits From Tenant
/{site_identifier}/transactions/credits/balanceGet Credit Balance
/{site_identifier}/transactions/credits/balance-with-tenantGet Credit Balance With Tenant Info
/{site_identifier}/transactions/credits/checkCheck Credits
/{site_identifier}/transactions/credits/site-usersGet Site User Credits
/{site_identifier}/transactions/monthly-usageGet Monthly Usage
/{site_identifier}/transactions/statsGet Transaction Stats
Transferprompts4 endpoints
Endpoints grouped under 'Transferprompts' from production OpenAPI.
/transferprompts/List Transfer Prompts
/transferprompts/Create Transfer Prompt
/transferprompts/{prompt_id}Delete Transfer Prompt
/transferprompts/{prompt_id}Update Transfer Prompt
Translations12 endpoints
Endpoints grouped under 'Translations' from production OpenAPI.
/{site_identifier}/translations/elements/{element_id}Get all translations of a content element
/{site_identifier}/translations/elements/{element_id}/sync-translationsSync all translations with the master element
/{site_identifier}/translations/elements/{element_id}/translateTranslate a content element to another language
/{site_identifier}/translations/media/{media_id}Get all translations of a media item
/{site_identifier}/translations/media/{media_id}/sync-translationsSync all translations with the master media
/{site_identifier}/translations/media/{media_id}/translateTranslate a media item to another language
/{site_identifier}/translations/pages/{page_id}Get all translations of a page
/{site_identifier}/translations/pages/{page_id}/sync-translationsSync all translations with the master page
/{site_identifier}/translations/pages/{page_id}/translateTranslate a page to another language
/{site_identifier}/translations/posts/{post_id}Get all translations of a post
/{site_identifier}/translations/posts/{post_id}/sync-translationsSync all translations with the master post
/{site_identifier}/translations/posts/{post_id}/translateTranslate a post to another language
User Site Associations5 endpoints
Endpoints grouped under 'User Site Associations' from production OpenAPI.
/sites/{site_identifier}/available-usersList users available for assignment to a specific site
/sites/{site_identifier}/usersList users with access to a site
/sites/{site_identifier}/users/{user_id}Remove a user from a site
/sites/{site_identifier}/users/{user_id}Assign a user to a site
/users/{user_id}/sitesList sites a user is assigned to
Users6 endpoints
Endpoints grouped under 'Users' from production OpenAPI.
/users/Get Users
/users/Create User
/users/{user_id}Delete User
/users/{user_id}Get User
/users/{user_id}Update User
/users/{user_id}/global-adminUpdate Global Admin Status
Website Generation1 endpoints
Endpoints grouped under 'Website Generation' from production OpenAPI.
/{site_identifier}/generate-website/Generate Website
Quick Start
Get started with the Cognitor Agent API in minutes
1. Authentication
curl -X POST "https://backend.cognitor.dev/auth/login" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "username=your@email.com&password=your_password&grant_type=password"2. Make API Calls
curl -X GET "https://backend.cognitor.dev/sites/" \
-H "Authorization: Bearer YOUR_JWT_TOKEN"