API Documentation

1.Validate Token

API to validate token, pass api token to check if it configured properly.

POSThttps://api.vuela.ai/generate/validate-token

Authorization

Each request should send Authorization token as Bearer token, this token can be generated from dashboard.

2. Informative Article Generation

Generates informative article focused on SEO and user intent satisfaction

POSThttps://api.vuela.ai/generate/article

Parameter	Required	Type	Description
title	Required	String	The title of the article. Required if keyword is not present.
keyword	Required	String	The keyword or topic of the article. Required if title is not present.
language	Optional	String	Default is English ("en"): The language in which the article should be written.
country	Optional	String	Default is United States ("US"): The specific country context for the article.
focus	Optional	String	Additional focus or context for the article.
add_images	Optional	Boolean	Default is false: Whether to add images to the article.
images_focus	Optional	String	Specific focus or details for the images in the article. Only applicable if add_images is true.
add_internal_links	Optional	Boolean	Default is false: Whether to add internal links to the article.
project_website	Conditional	String	The website URL for internal linking. **Required if add_internal_links is true.
add_external_links	Optional	Boolean	Default is false: Whether to add external links to the article.

* Important: At least either the title or the keyword must be provided.

* Bulk Creation: API allow generating one content in one API call, so you can send multiple calls to generate multiple content at same time.

3. Product Page Generation

Generates a product page optimized for e-commerce

POSThttps://api.vuela.ai/generate/product-description

Parameter	Required	Type	Description
product	Required	String	The name of the product. Required if ean is not present.
ean	Required	String	The EAN (European Article Number) of the product. Required if product is not present.
output_format	Required	Object	Defines output content. At least one sub-field must be set to true.
description	Optional	Boolean	If true, includes description of the product
features_specifications_list	Optional	Boolean	Include a list of features and specifications.
reviews	Optional	Boolean	Include reviews
pros_cons	Optional	Boolean	Include pros and cons.
features_specifications	Optional	String	Details of product features or specifications.
use_external_sources	Optional	Boolean	Default is false: Whether external sources should be used for SEO-focused content (may cause hallucinations).
image_urls	Optional	Array of strings	URLs of product images.
paragraph_count	Optional	Integer	From 1 to 10. The number of paragraphs in the description. If 0, a random number of paragraphs will be generated.
paragraph_length	Optional	String	"mini" or "normal". The length of each paragraph.
language	Optional	String	Default is English ("en"): The language in which the product page should be written.
country	Optional	String	Default is United States ("US"): The specific country context for the product page.

* Bulk Creation: API allow generating one content in one API call, so you can send multiple calls to generate multiple content at same time.

4. Category Page Generation

Creates a category page for product listings

POSThttps://api.vuela.ai/generate/category-description

Parameter	Required	Type	Description
category_title	Required	String	The title of the category.
url	Required	String	The URL of the ecommerce site or a competitor's site.
output_format	Required	Object	Defines output content. At least one sub-field must be set to true.
description	Optional	Boolean	Include description.
frequent_questions	Optional	Boolean	Include frequently asked questions.
use_external_sources	Optional	Boolean	Default is false: Whether external sources should be used for SEO-focused content (may cause hallucinations).
intro	Optional	Boolean	Default is false: Include an introductory paragraph.
intro_length	Optional	String	"mini" or "normal" The length of the introductory paragraph.
paragraph_count	Optional	Integer	From 1 to 10. The number of paragraphs in the description. If 0, a random number of paragraphs will be generated.
paragraph_length	Optional	String	"mini" or "normal". The length of each paragraph.
language	Optional	String	Default is English ("en"): The language in which the category page should be written.
country	Optional	String	Default is United States ("US"): The specific country context for the category page.

* Bulk Creation: API allow generating one content in one API call, so you can send multiple calls to generate multiple content at same time.

5. Get My Contents

Fetch list of contents, you have added to generate, below are the list of query parameters to filter data

GEThttps://api.vuela.ai/my-content

Parameter	Required	Type	Description
page	Optional	Number	Page to fetch
limit	Optional	Number	No of items per page.
search	Required	String	Search title field, like title/keyword for article, product/ean for productDescription and category_title for categoryDescription or Content ID
status	Optional	String	To filter data with status. Statuses are: creating/failed/completed
type	Optional	String	To filter data with type. Types are: article/productDescription/categoryDescription

6. Content Details

Fetch details of single content, below is the details how to replace {contentId} in url

GEThttps://api.vuela.ai/my-content/{contentId}

Parameter	Required	Type	Description
contentId	Required	String	Id of content required in my content api, it should be passed in url like url param

7. Credit Consumption

To use Vuela's API, you must have credits in your account. Our credit system ensures fair usage and helps maintain the quality of our services.

Please note: In the event of an API error or if Vuela is unable to generate content, no credits will be charged to your account. We only deduct credits for successful operations that deliver content.