Back to home

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
ParameterRequiredTypeDescription
titleRequiredStringThe title of the article. Required if keyword is not present.
keywordRequiredStringThe keyword or topic of the article. Required if title is not present.
languageOptionalStringDefault is English ("en"): The language in which the article should be written.
countryOptionalStringDefault is United States ("US"): The specific country context for the article.
focusOptionalStringAdditional focus or context for the article.
add_internal_linksOptionalBooleanDefault is false: Whether to add internal links to the article.
project_websiteConditionalStringThe website URL for internal linking. **Required if add_internal_links is true.
add_external_linksOptionalBooleanDefault 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. 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
ParameterRequiredTypeDescription
pageOptionalNumberPage to fetch
limitOptionalNumberNo of items per page.
searchRequiredStringSearch title field, like title/keyword for article or Content ID
statusOptionalStringTo filter data with status. Statuses are: creating/failed/completed
typeOptionalStringTo filter data with type. Type is: article

4. Content Details

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

GEThttps://api.vuela.ai/my-content/{contentId}
ParameterRequiredTypeDescription
contentIdRequiredStringId of content required in my content api, it should be passed in url like url param

5. 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.