Certainly! Here’s the revised section with the addition of the “email” parameter:

API Endpoint Documentation: Dynamic Article Creation

Overview

This API endpoint is specially designed for the dynamic generation of comprehensive, SEO-optimized articles. It significantly enhances online content visibility and engagement by providing high-quality, tailored content across various languages. Ideal for content marketers, SEO specialists, and digital platforms, this endpoint is a powerful tool for boosting web presence and effectively engaging a global audience.

Features

• Multilingual Support: Offers content generation in multiple languages including English, French, Spanish, German, Italian, Dutch, and Portuguese, catering to a wide international audience.
• SEO Optimization: Ensures articles are created following SEO best practices, featuring strategic keyword placement and HTML formatting with H1 tags for improved search rankings.
• Customizable Content: Allows users to specify a ‘query’—a list of keywords separated by “+”—and a ‘customer question’ to direct the content creation process, ensuring both relevance and engagement.
• Competitor Analysis-Based Length: Article length is not restricted by predefined limits. It is determined based on an analysis of competitor pages for the given ‘query’ keywords, ensuring comprehensive coverage to compete effectively in search rankings.
• HTML Format Delivery: Articles are delivered in HTML format, ready for immediate web publishing.
• Direct Email Delivery: Upon creation, articles are directly sent to a specified email address, facilitating a streamlined review and publication process.

Endpoint Details

• URL: /create_article
• Method: POST
• Content-Type: application/json

Request Parameters

• query (required): A string of keywords related to the desired article content, separated by “+”.
• lang_code (required): The ISO code for the article’s language, with support for “en”, “fr”, “es”, “de”, “it”, “nl”, and “pt”.
• customer_question (required): A relevant question that the article should address to enhance content focus and relevance.
• country_code (optional): The ISO country code relevant to the content, aiding in regional SEO optimization.
• email (required): The email address where the generated content will be sent, ensuring the user can easily access and review the article.

Response Structure

• The API returns an HTML-formatted article optimized for SEO, including the use of H1 tags, tailored to the specified keywords and question, and directly emailed to the specified address.

Example Request

{
  "query": "eco-friendly+home+products",
  "lang_code": "en",
  "customer_question": "What are the best eco-friendly products for a sustainable home?",
  "country_code": "us",
  "email": "user@example.com"
}

Error Handling

The API utilizes standard HTTP response codes to indicate the success or failure of requests:

• 200 OK: The request was successfully processed, and the article has been generated and sent.
• 400 Bad Request: An issue was detected with the request, such as missing parameters.
• 500 Internal Server Error: An error occurred on the server while processing the request.

Best Practices

• Always review the generated articles for accuracy and alignment with your brand voice before publishing.
• Utilize the multilingual capabilities to expand your reach and connect with a broader audience.
• Regularly update your keyword strategy based on SEO trends and performance metrics to ensure continued relevance and effectiveness.

This enhanced documentation provides a thorough guide to leveraging the dynamic article creation API endpoint for producing SEO-friendly, engaging content tailored to your specific needs, audience, and now, with the convenience of direct email delivery.