Documentation Index
Fetch the complete documentation index at: https://api-docs.hrizn.io/llms.txt
Use this file to discover all available pages before exploring further.
content_tools:write
The content_tools:write scope allows you to generate supplementary data for content — SEO metadata, structured data schemas, social media snippets, page slugs, post tags, and search intent analysis. You can generate all tools at once or target a specific tool.
Endpoints
| Method | Path | Description |
|---|
POST | /public/content/{id}/content-tools | Generate all or selected content tools |
POST | /public/content/{id}/content-tools/{tool} | Generate a single content tool |
Available content tools
| Tool | Description |
|---|
seo-metadata | Page title, meta description, and keywords |
schemas | JSON-LD structured data (Article, Author, Organization, FAQ, etc.) |
social-snippets | Facebook, Twitter, Instagram, and Google Business snippets |
page-slugs | SEO-friendly URL slugs |
post-tags | Content categorization tags |
search-intent | Search intent analysis |
Generate content tools
POST /public/content/{id}/content-tools
content:read) to check when each component is ready, or subscribe to the content_tools.completed webhook event.
Path parameters
| Name | Type | Required | Description |
|---|
id | string (UUID) | Yes | Article ID |
Request body (optional)
| Field | Type | Required | Description |
|---|
tools | array of strings | No | Specific tools to generate. If omitted, default tools are generated |
curl -X POST https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/content-tools \
-H "X-API-Key: hzk_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"tools": ["seo-metadata", "schemas", "social-snippets", "page-slugs", "post-tags", "search-intent"]
}'
Response — 202 Accepted
{
"data": {
"article_id": "d4e5f6a7-b8c9-0123-def0-456789abcdef",
"tools": [
"seo-metadata",
"schemas",
"social-snippets",
"page-slugs",
"post-tags",
"search-intent"
],
"status": "generating"
}
}
curl -X POST https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/content-tools \
-H "X-API-Key: hzk_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"tools": ["seo-metadata", "schemas"]
}'
Response — 202 Accepted
{
"data": {
"article_id": "d4e5f6a7-b8c9-0123-def0-456789abcdef",
"tools": ["seo-metadata", "schemas"],
"status": "generating"
}
}
Status codes
| Code | Description |
|---|
202 | Content tool generation started |
400 | Validation error (invalid tool name, article ID missing) |
401 | Missing or invalid API key |
403 | API key does not have content_tools:write scope |
404 | Content not found or belongs to a different site |
500 | Internal server error |
Generate a single content tool
POST /public/content/{id}/content-tools/{tool}
Path parameters
| Name | Type | Required | Description |
|---|
id | string (UUID) | Yes | Article ID |
tool | string | Yes | The tool to generate (e.g. seo-metadata, schemas) |
Example
curl -X POST https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/content-tools/seo-metadata \
-H "X-API-Key: hzk_your_key_here"
Response — 202 Accepted
{
"data": {
"article_id": "d4e5f6a7-b8c9-0123-def0-456789abcdef",
"tools": ["seo-metadata"],
"status": "generating"
}
}
Retrieving generated content tools
Once generated, retrieve the components using the content:read scope:
curl https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/components/SeoMetadata \
-H "X-API-Key: hzk_your_key_here"
{
"data": {
"id": "comp-002-uuid",
"type": "seoMetadata",
"content": {
"title": "2026 Honda Civic vs Toyota Corolla | Full Comparison",
"description": "Compare the 2026 Honda Civic and Toyota Corolla on price, fuel economy, and features.",
"keywords": ["honda civic", "toyota corolla", "2026", "comparison", "compact sedan"]
},
"metadata": {},
"status": "complete",
"created_at": "2026-02-01T15:25:00Z",
"updated_at": "2026-02-01T15:26:00Z"
}
}
Status codes
| Code | Description |
|---|
202 | Content tool generation started |
400 | Invalid tool name or content ID missing |
401 | Missing or invalid API key |
403 | API key does not have content_tools:write scope |
404 | Content not found or belongs to a different site |
500 | Internal server error |
Error response — Missing scope
If your API key does not include content_tools:write, any request to these endpoints returns:
{
"error": {
"code": "forbidden",
"message": "This API key requires one of the following scopes: content_tools:write",
"details": {
"required_scopes": ["content_tools:write"]
}
}
}
