API
Connect API to Citeca and publish articles automatically.
Pull your published articles into any stack. Useful when you render your own front end, or want the content in a system we do not publish to directly.
Setup time
About 2 minutes
Access needed
Admin on the site or store
What we touch
Blog posts only
Note
This connection can only read and publish blog posts. Your theme, products and settings are never modified.
What you need#
- An API key, generated in Settings → Integrations → API
Connecting API#
Open Settings → Publishing, find API and press Connect. The wizard walks you through the steps below.
- 1
Generate an API key
Create a key to read your published articles programmatically (read-only, never drafts).
- Your key is shown once — store it somewhere safe.
- Send it as a header:
- Base URL:
- Endpoints:
API access ready
Send your key as the x-api-key header to pull your published articles into any stack.
Check it worked#
Verify it’s working
3 checks
- A request with your key returns
200and anarticleslist. - Published articles appear in the response with their HTML body.
- Requests without a key are rejected with
401.
To test without waiting for a scheduled article, open any finished article in Blog content and press Publish. You get a result per destination immediately, including the exact error if something is wrong.
Managing the connection#
Once connected, the API card shows a green Connected dot and a Manage button. Everything about the connection is changed from there — there are three controls.
- Test connection — checks the credentials against API right now. If they fail you get the platform’s own response, not a generic message.
- Reconnect — walks through the setup again. This is how you paste a rotated credential or change where we publish. It replaces what is stored rather than adding a second connection.
- Disconnect — deletes the stored credentials and stops publishing. Articles already published stay on your site untouched, and your drafts and schedule in Citeca are kept.
Note
When something fails you get a plain explanation and the steps to fix it. The platform’s own response — status code, endpoint and response body — is folded away under Details for support; “Copy error report” puts all of it in one paste for a support message.
TroubleshootingQuestions#
I lost my API key.
Keys are shown once and cannot be recovered. Generate a new one in Settings → Publishing — the old key stops working the moment you do, so update anything using it at the same time.
What is in the response?
Published articles only, each with its title, slug, meta description, hero image and HTML body. Drafts and scheduled articles are not exposed, so you cannot accidentally render something unfinished.
Is there a rate limit?
Yes: 100 requests a minute per key, answered with 429 and a Retry-After header past that. Cache responses (or revalidate hourly) rather than fetching per page view and you will not think about it.
curl "https://www.citeca.ai/api/integrations/v1/articles?page=1&limit=20" \
-H "x-api-key: $CITECA_API_KEY"
# → { "articles": [ … ], "page": 1, "limit": 20, "hasMore": false }
# limit is 1–100 (default 20). Each article has id, title, slug,
# metaDescription, content_html, content_markdown, heroImageUrl,
# heroImageAlt, keywords, jsonLd, faqJsonLd, languageCode, publicUrl,
# wordCount, readingTime and publishedAt.curl "https://www.citeca.ai/api/integrations/v1/articles/your-article-slug" \
-H "x-api-key: $CITECA_API_KEY"
# → the article object, or 404 { "error": "Article not found." }Heads up
Your key is shown once. Store it in a secret manager or an environment variable — never in client-side code, where anyone can read it.
Something missing or wrong here? Tell us and we will fix it.