CoreProse API
API for programmatic access to CoreProse content generation platform.
## Authentication
All API requests require authentication via API key. Include your API key in the `X-API-Key` header:
```
X-API-Key: cp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
API keys can be created and managed from your [dashboard](/api-keys).
Public endpoints (under `/public/*`) do not require authentication.
## Rate Limits
Rate limits vary by plan:
- **Free**: 100 requests/minute
- **Starter**: 200 requests/minute
- **Pro**: 500 requests/minute
- **Business**: 2000 requests/minute
## Errors
The API uses standard HTTP status codes:
- `200` - Success
- `400` - Bad Request (invalid parameters)
- `401` - Unauthorized (missing or invalid API key)
- `403` - Forbidden (insufficient permissions or quota exceeded)
- `404` - Not Found
- `409` - Conflict (duplicate resource)
- `422` - Unprocessable Entity (e.g. KB coverage too low)
- `429` - Too Many Requests (rate limit exceeded)
- `500` - Internal Server Error
Server:
https://www.coreprose.com/apiArticles
Article generation and management
GET
/articlesList articlesGET
/articles/{id}Get article by IDPATCH
/articles/{id}Update articleDELETE
/articles/{id}Delete articlePOST
/articles/generateGenerate article directlyPOST
/articles/generate-planGenerate article planPOST
/articles/generate-from-planGenerate article from planGET
/articles/generation-status/{articleId}Get article generation statusPOST
/articles/check-kb-coverageCheck KB coverage for topicPOST
/articles/enrich-kb-topicOn-demand KB enrichmentGET
/articles/enrichment-status/{taskId}Poll enrichment task progressPOST
/articles/suggest-topicSuggest topicPOST
/articles/validate-topicValidate topicGET
/articles/available-lengthsGet available article lengthsPOST
/articles/{id}/publishPublish articleGET
/articles/{id}/export-pdfExport article as PDFAgents
AI agent management
GET
/agentsList agentsPOST
/agentsCreate agentGET
/agents/{id}Get agent by IDPATCH
/agents/{id}Update agentDELETE
/agents/{id}Delete agentPOST
/agents/{id}/toggleEnable/disable agentPOST
/agents/{id}/executeExecute agentGET
/agents/{id}/executionsGet execution historyGET
/agents/eventsAgent status events (SSE)Niches
Niche/topic management
GET
/nichesList nichesPOST
/nichesCreate custom nicheGET
/niches/listSimple niche listGET
/niches/activatedGet activated nichesGET
/niches/{id}Get niche detailsPATCH
/niches/{id}Update niche settingsDELETE
/niches/{id}Delete custom nichePOST
/niches/{id}/activateActivate nichePOST
/niches/{id}/deactivateDeactivate nicheGET
/niches/{id}/dashboardGet niche dashboardGET
/niches/{id}/settingsGet niche settingsPATCH
/niches/{id}/settingsUpdate niche settingsGET
/niches/{id}/article-scheduleGet article schedulePATCH
/niches/{id}/article-scheduleUpdate article schedulePOST
/niches/requestRequest new nicheKB Coverage
Knowledge Base coverage and SEO analysis
GET
/kb/{nicheKey}/statsGet KB statisticsGET
/kb/{nicheKey}/entitiesGet KB entitiesGET
/kb/{nicheKey}/graphGet entity graphGET
/governance/{nicheKey}Get governance evaluationGET
/seo/topic-coverageGet topic coverage analysisPOST
/seo/topic-coverageRefresh topic coverageIntegrations
Third-party integrations (WordPress, Shopify, etc.)
GET
/integrationsList integrationsPOST
/integrationsCreate integrationGET
/integrations/providersList available providersGET
/integrations/{id}Get integration detailsPATCH
/integrations/{id}Update integrationDELETE
/integrations/{id}Delete integrationPOST
/integrations/{id}/testTest integration connectionPOST
/integrations/{id}/publishPublish article via integrationGET
/integrations/providers/{provider}/optionsGet provider-specific optionsDocuments
Private document management
GET
/documentsList private documentsGET
/documents/availableGet available documentsPOST
/documents/uploadUpload private documentPOST
/documents/urlAdd document from URLGET
/documents/{id}Get document detailsPATCH
/documents/{id}Update document metadataDELETE
/documents/{id}Delete documentPOST
/documents/searchSemantic search in KBTenant
Account and quota information
GET
/tenantGet tenant detailsGET
/tenant/quotasGet account quotasPATCH
/tenant/settingsUpdate tenant settingsPublic
Public endpoints (no authentication required)
GET
/public/trend-radarGet trending topicsGET
/public/trends/{slug}Get single trend detailPOST
/public/trend-alertsSubscribe to trend alertsPOST
/public/trend-radar-clickRecord trend engagementGET
/public/kb-articlesList public KB articlesGET
/public/kb-articles/{slug}Get public KB articleGET
/public/statsPlatform statisticsGET
/public/top-nichesTop niches by scoreGET
/public/widget/trendsTrends widgetTeam
Team member management and invitations
GET
/teamList team membersPOST
/team/inviteInvite team memberPATCH
/team/{id}Update team member roleDELETE
/team/{id}Remove team memberAccount
Account profile management
GET
/accountGet account detailsPATCH
/account/profileUpdate profileReviews
User reviews and ratings
GET
/reviewsList reviewsPOST
/reviewsSubmit a reviewGET
/reviews/my-reviewGet my reviewPATCH
/reviews/{id}Update reviewDELETE
/reviews/{id}Delete reviewPOST
/reviews/{id}/helpfulMark review as helpful