REST API
Retrieve an article with complete SEO metadata for use in meta tags, Open Graph, and Twitter Cards.
GET
{{baseUrl}}/v1/seo/article/:slugAuth required
| Property | Type | Description | Default |
|---|---|---|---|
id* | string | - | - |
title* | string | - | - |
slug* | string | - | - |
content* | string | - | - |
seo* | SeoMetadata | - | - |
project* | { name, slug, description } | - | - |
| Property | Type | Description | Default |
|---|---|---|---|
metaTitle* | string | - | - |
metaDescription* | string | - | - |
ogTitle | string | - | - |
ogDescription | string | - | - |
ogImage | string | - | - |
twitterCard* | 'summary' | 'summary_large_image' | - | - |
canonicalUrl | string | - | - |
keywords | string[] | - | - |
structuredData | object | JSON-LD data | - |
cURL Command
curl -X GET "https://api.simplist.blog/v1/seo/article/getting-started?baseUrl=https://myblog.com" \
-H "X-API-Key: YOUR_API_KEY"{
"data": {
"id": "art_123",
"title": "Getting Started",
"slug": "getting-started",
"content": "# Introduction...",
"seo": {
"metaTitle": "Getting Started with Simplist - Complete Guide",
"metaDescription": "Learn how to get started with Simplist in this comprehensive guide",
"ogTitle": "Getting Started with Simplist",
"ogDescription": "Complete guide to getting started",
"ogImage": "https://cdn.simplist.blog/covers/getting-started.jpg",
"ogType": "article",
"twitterCard": "summary_large_image",
"canonicalUrl": "https://myblog.com/blog/getting-started",
"keywords": ["simplist", "tutorial", "getting started"],
"structuredData": {
"@context": "https://schema.org",
"@type": "Article",
"headline": "Getting Started"
}
},
"project": {
"name": "My Blog",
"slug": "my-blog",
"description": "A blog about web development"
}
}
}If you're using TypeScript/JavaScript, you can use the SDK instead: client.seo.getArticle()