API Documentation for AiPlazza

About AiPlazza.com

AiPlazza offers comprehensive solutions to help everyone harness the power of AI models effectively. Our API is designed for developers and businesses looking to integrate AiPlazza's advanced AI services into their own applications. Below, you will find the necessary information to ensure consistent and seamless integration.

Start your free trial at: Free Trial

Obtain your API key at: User Dashboard

Explore our free offerings:

Usage

In this section, we explain that you must obtain an API key and API email to use the services.
You can create your first API key and API email by starting a free trial:

Free Trial

The free trial gives you 200 free usage credits. If you find these services beneficial, you can add more credits by subscribing to a package:

API Overview

All API endpoints accept only the POST method.
Requests made using other HTTP methods will be rejected with a {"status":"failure","message":"Invalid request method"}
HTTP Method : POST

Each API endpoint requires the POST method for making requests. Ensure your client application is configured to use POST when interacting with the API.

Endpoint Structure

Our API endpoints are designed with a consistent and predictable structure to ensure ease of use and integration. Below is an overview of the endpoint structure used in our API.

Base URL

All API requests are made to the following base URL:

https://api.aiplazza.com/

This is the root URL for all endpoints provided by AiPlazza. Each specific endpoint extends this base URL.

Endpoint Format

Endpoints are structured in a logical and hierarchical manner. The general format for an endpoint is as follows:

https://api.aiplazza.com/{service}/{version}/{resource}

{service}: The name of the service you are accessing (e.g., subscription, elitewriters, url-buddy).
{version}: The version of the API you are using (e.g., v1).
{resource}: The specific resource or action you want to perform within the service.

Example Endpoint

Here is an example of an endpoint for generating articles using the EliteWriters service:

https://api.aiplazza.com/elitewriters/v1/generate

Subscription

Endpoint : https://api.aiplazza.com/subscription/v1/

This endpoint allows you to view your subscription details including remaining credits and expiration date.

Example Curl Command

curl -X POST https://api.aiplazza.com/subscription/v1/ \
		-H "Content-Type: application/json" \
		-d '{
		"apikey": "your_apikey", // obtain your api key at https://aiplazza.com/user-dashboard.html
		"apiemail": "your_apiemail" // obtain your api email at https://aiplazza.com/user-dashboard.html
		}'

Explanation of Fields

apikey: Your API key obtained from User Dashboard.
apiemail: Your API email obtained from User Dashboard.

URL Processing

Endpoint : https://api.aiplazza.com/url/v1/

This endpoint processes content from a given URL using AI-powered tasks such as text parsing, grammar correction, fact extraction, and more.

Example Curl Command

curl -X POST https://api.aiplazza.com/url/v1/ \
		-H "Content-Type: application/json" \
		-d '{
		"apikey": "your_apikey", // obtain your api key at https://aiplazza.com/user-dashboard.html
		"apiemail": "your_apiemail", // obtain your api email at https://aiplazza.com/user-dashboard.html
		"url": "https://www.yoursite.com", // URL you want to parse
		"task": "parsetext", // task to be performed on the given URL (see more at Explanation of Fields)
		"content_type": "", // content type of the target URL, please see the documentation
		"elements_selected": "", // element class or id to parse only (e.g., #maincontent, .article-body)
		"elements_excluded": "", // elements class or id to exclude from parsing
		"output_language": "", // output language of the result
		"extra_notes": "" // extra commands, prompts, or notes you want to provide to the AI
		}'

Explanation of Fields

apikey: Your API key obtained from User Dashboard.
apiemail: Your API email obtained from User Dashboard.
url: The URL of the website you want to parse.
task: The specific task you want to perform on the given URL. Possible tasks include:
- parsetext: Extracts text from the URL.
- interprete_rewrite: interpret the content from the URLs, analyzes the content for any grammatical, spelling, punctuation, and overall language usage errors. Improves it for readability and clarity. Avoids sounding overly robotic or technical. Correct and rewrite it as new, unique content. Output is html format.
- grammarize: Performs grammar correction on the extracted text.
- parsefacts: Extracts factual information from the text.
- parseqa: Extracts questions and answers from the text.
- parseqajsonl: Extracts questions and answers and returns them in JSONL format.
- summarize: Summarizes the content of the URL.
- translate: Translates the content to another language.
content_type: The type of content found at the URL (e.g., text/html, application/json). Refer to the documentation for supported content types.
elements_selected: Specific elements to parse, identified by class or id (e.g., #maincontent,.article-body).
elements_excluded: Specific elements to exclude from parsing, identified by class or id (e.g., #copyright,.sidebar,#banner).
output_language: The language in which you want the output. Leave blank to use the same language as the content.
extra_notes: Any additional commands, prompts, or notes you want to provide to the AI for processing the URL.

List of Content Types

Below you can find the latest updated list of content types. It is important to choose a content type when you are creating facts, QA pairs, or any type of training data.

Explanation of Content Types:

Art: Categorizes the content type of URL, Document, or Text as "Art" and searches especially the fields: artwork, artist bio, pricing, materials, dimensions, exhibition history, galleries.
Automotive: Categorizes the content type of URL, Document, or Text as "Automotive" and searches especially the fields: vehicle specs, pricing, dealer info, customer reviews, fuel efficiency, safety ratings, warranty.
Beauty: Categorizes the content type of URL, Document, or Text as "Beauty" and searches especially the fields: beauty product ingredients, directions, pricing, user reviews, brand information, skin type suitability.
Business: Categorizes the content type of URL, Document, or Text as "Business" and searches especially the fields: products/services, pricing, case studies, team bios, contact info, market analysis, industry trends.
Culture: Categorizes the content type of URL, Document, or Text as "Culture" and searches especially the fields: cultural traditions, artifacts, expert analysis, related events, historical context, significance.
Education: Categorizes the content type of URL, Document, or Text as "Education" and searches especially the fields: course curriculum, duration, certification, pricing, enrollment policies, accreditation, student reviews.
Entertainment: Categorizes the content type of URL, Document, or Text as "Entertainment" and searches especially the fields: show/movie details, cast, ratings, pricing, viewing options, release date, genre, director.
Environment: Categorizes the content type of URL, Document, or Text as "Environment" and searches especially the fields: environmental facts, product sustainability, green tips, impact analysis, conservation efforts.
Event: Categorizes the content type of URL, Document, or Text as "Event" and searches especially the fields: event details, date/time, location, agenda, speakers, registration info, sponsors, attendees.
Fashion: Categorizes the content type of URL, Document, or Text as "Fashion" and searches especially the fields: clothing/accessory details, sizes, materials, pricing, care info, designer, collection.
Finance: Categorizes the content type of URL, Document, or Text as "Finance" and searches especially the fields: financial products, interest rates, fees, eligibility, application process, risk analysis, investment options.
Food: Categorizes the content type of URL, Document, or Text as "Food" and searches especially the fields: recipes, ingredients, nutrition info, cooking instructions, user ratings, cuisine type, dietary restrictions.
Gaming: Categorizes the content type of URL, Document, or Text as "Gaming" and searches especially the fields: game features, system requirements, pricing, online play, release date, developer, platform.
Health: Categorizes the content type of URL, Document, or Text as "Health" and searches especially the fields: medical info, treatments, medications, dosage, side effects, doctor ratings, patient testimonials, alternative therapies.
History: Categorizes the content type of URL, Document, or Text as "History" and searches especially the fields: historical event details, dates, locations, key figures, references, impact, legacy.
Home: Categorizes the content type of URL, Document, or Text as "Home" and searches especially the fields: home products, dimensions, materials, pricing, care instructions, brand, energy efficiency.
Legal: Categorizes the content type of URL, Document, or Text as "Legal" and searches especially the fields: terms, conditions, privacy, refund policies, legal precedents, compliance, case studies.
Lifestyle: Categorizes the content type of URL, Document, or Text as "Lifestyle" and searches especially the fields: lifestyle tips, product recommendations, expert advice, trends, personal stories.
Music: Categorizes the content type of URL, Document, or Text as "Music" and searches especially the fields: album/song details, artist info, pricing, streaming options, genre, release date, record label.
News: Categorizes the content type of URL, Document, or Text as "News" and searches especially the fields: headline/title, subheadline, publication date and time, author, news source, article body, summary/abstract, keywords/tags, category/section, multimedia content, location, related articles/links, comments/discussion, social media integration, editor's note/correction, advertisement.
Pets: Categorizes the content type of URL, Document, or Text as "Pets" and searches especially the fields: pet product details, pricing, feeding instructions, veterinarian info, breed specifics, care tips.
Politics: Categorizes the content type of URL, Document, or Text as "Politics" and searches especially the fields: political candidate bios, policy platforms, election info, campaign news, endorsements, voting records.
Product: Categorizes the content type of URL, Document, or Text as "Product" and searches especially the fields: product features, technical specs, pricing details, policies, versions, delivery info, user ratings, language support, brand, warranty.
Real Estate: Categorizes the content type of URL, Document, or Text as "Real Estate" and searches especially the fields: property details, pricing, neighborhood info, agent contact, floor plans, photos, virtual tours.
Science: Categorizes the content type of URL, Document, or Text as "Science" and searches especially the fields: scientific research details, findings, citations, expert commentary, methodology, implications.
Service: Categorizes the content type of URL, Document, or Text as "Service" and searches especially the fields: service offerings, pricing, policies, supported languages, user feedback, service area, guarantees.
Sports: Categorizes the content type of URL, Document, or Text as "Sports" and searches especially the fields: team/player stats, schedules, scores, tickets, merchandise, league standings, player bios.
Technology: Categorizes the content type of URL, Document, or Text as "Technology" and searches especially the fields: software features, system requirements, pricing, support options, version history, compatibility, user manuals.
Travel: Categorizes the content type of URL, Document, or Text as "Travel" and searches especially the fields: destination details, dates, pricing, package inclusions, booking policies, travel tips, local attractions.
Tutorial: Categorizes the content type of URL, Document, or Text as "Tutorial" and searches especially the fields: step-by-step instructions, required materials or tools, expected duration, difficulty level, visual aids, prerequisites.
User Guide: Categorizes the content type of URL, Document, or Text as "User Guide" and searches especially the fields: product overview, setup instructions, troubleshooting tips, maintenance and care, contact information for support, FAQs.
DIY: Categorizes the content type of URL, Document, or Text as "DIY" and searches especially the fields: project instructions, required materials, difficulty level, step-by-step guide, safety tips.
Photography: Categorizes the content type of URL, Document, or Text as "Photography" and searches especially the fields: camera specs, shooting techniques, editing tips, pricing, photographer bio, portfolio.
Literature: Categorizes the content type of URL, Document, or Text as "Literature" and searches especially the fields: book details, author info, genre, publication date, synopsis, reviews, awards.
Parenting: Categorizes the content type of URL, Document, or Text as "Parenting" and searches especially the fields: childcare tips, product recommendations, expert advice, developmental milestones, health and safety.

Content Writer

Endpoint : https://api.aiplazza.com/contentwriter/v1/

This endpoint generates content by using given parameters.

Example Curl Command

curl -X POST https://api.aiplazza.com/contentwriter/v1/ \
    -H "Content-Type: application/json" \
    -d '{
    "apikey": "your_apikey", // obtain your API key at https://aiplazza.com/user-dashboard.html
    "apiemail": "your_apiemail", // obtain your API email at https://aiplazza.com/user-dashboard.html
    "task": "new_writing", // task to be performed
    "content": "Your existing content here", // existing content to be used for reference
    "title": "Title of the content", // title of the content to be generated
    "keywords": ["keyword1", "keyword2"], // list of keywords to be included
    "writing_style": "informative", // desired writing style (e.g., informative, descriptive)
    "writing_tone": "formal", // desired writing tone (e.g., formal, neutral)
    "audience": "general_public", // target audience
    "audience_age": ["adults", "seniors"], // age range of the target audience
    "add_tagline": true, // whether to add a tagline
    "add_intro": true, // whether to add an introduction
    "add_conclusion": true, // whether to add a conclusion
    "minwords": 300, // minimum number of words
    "maxwords": 1000, // maximum number of words
    "add_metatitle": true, // whether to add a meta title
    "add_metadescription": true, // whether to add a meta description
    "add_metakeywords": true, // whether to add meta keywords
    "output_language": "en", // output language of the content
    "output_format": "html", // format of the output (e.g., html, plain text)
    "content_purpose": "blog_post", // purpose of the content (e.g., blog_post, article)
    "references_url": ["https://reference1.com", "https://reference2.com"], // list of reference URLs
    "reference_content": "Additional reference content", // additional reference content
    "reading_level": ["college", "professional"], // desired reading level (e.g., easy, medium, difficult)
    "regional_preferences": ["north_america", "western_europe"], // regional preferences (e.g., US, UK)
    "extra_notes": "Any extra notes or instructions for the AI"
    }'

Explanation of Fields

apikey: Your API key obtained from User Dashboard.
apiemail: Your API email obtained from User Dashboard.
task: The specific task you want to perform. For content writing, use new_writing.
content: The existing content you want to use as a reference.
title: The title of the content to be generated.
keywords: A list of keywords you want to include in the content.
writing_style: The desired writing style, such as informative, descriptive, creative, narrative, persuasive, expository, reflective, argumentative, analytical, critical, evaluative, journalistic, technical, academic, scientific, or poetic.
writing_tone: The desired tone for the content, such as formal, neutral, assertive, cheerful, humorous, informal, inspirational, sarcastic, sceptical, optimistic, or pessimistic.
audience: The target audience for the content, such as general_public, professionals, students, researchers, academics, children, teenagers, adults, seniors, customers, clients, employees, employers, managers, executives, investors, developers, designers, engineers, healthcare_providers, patients, educators, learners, enthusiasts, hobbyists, gamers, travelers, shoppers, readers, writers, entrepreneurs, small_business_owners, large_corporations, non_profit_organizations, government_officials, policy_makers, parents, teachers, sports_fans, artists, musicians, scientists, environmentalists, technologists, it_professionals, marketing_professionals, sales_professionals, human_resources, legal_professionals, financial_analysts, accountants, consultants, advisors, media_and_journalists, bloggers, vloggers, social_media_influencers, or content_creators.
audience_age: The age range of the target audience, such as infants, toddlers, children, preteens, teenagers, young_adults, adults, middle_aged_adults, seniors, or elderly.
add_tagline: Whether to add a tagline to the content. Set to true or false.
add_intro: Whether to add an introduction to the content. Set to true or false.
add_conclusion: Whether to add a conclusion to the content. Set to true or false.
minwords: The minimum number of words for the content.
maxwords: The maximum number of words for the content.
add_metatitle: Whether to add a meta title. Set to true or false.
add_metadescription: Whether to add a meta description. Set to true or false.
add_metakeywords: Whether to add meta keywords. Set to true or false.
output_language: The language in which you want the output.
output_format: The format of the output, such as html or raw.
content_purpose: The purpose of the content, such as academic_article, advertisement_copy, announcement, annual_report, blog_post, brochure_content, case_study, company_profile, comparison_article, conference_paper, content_for_virtual_tours, corporate_communication, cover_letter, ebook, editorial, email_campaign, event_description, FAQ_page, funding_proposal, grant_proposal, how_to_guide, infographic_content, internal_memo, interview, invitation_letter, job_description, knowledge_base_article, landing_page_content, lecture_notes, lesson_plan, marketing_copy, mission_statement, motivational_letter, news_article, newsletter, online_course_material, opinion_piece, patent_description, podcast_script, policy_document, poll_content, poster_presentation, presentation, press_release, product_description, quiz_content, research_abstract, research_report, resume/cv, review, scholarship_application, script_for_interactive_content, SEO_article, social_media_post, speech, survey_analysis, technical_documentation, testimonial, thesis/dissertation, training_material, tutorial, user_manual, video_script, vision_statement, webinar_script, website_copy, or white_paper.
references_url: A list of URLs to use as references.
reference_content: Any additional reference content you want to provide. Provide specific content to use, HTML content will be converted to text, and the maximum length is 2000 words.
reading_level: The desired reading level, such as elementary, middle_school, high_school, college, graduate, post_graduate, professional, or general_audience.
regional_preferences: The regional preferences, such as north_america, south_america, western_europe, eastern_europe, northern_europe, southern_europe, central_europe, middle_east, north_africa, sub_saharan_africa, east_asia, south_asia, southeast_asia, central_asia, australia, new_zealand, pacific_islands, caribbean, or central_america.
extra_notes: Any additional notes or instructions for the AI.

List of Output Languages

Below you can find the latest updated list of output languages. Choose an appropriate output language for your AI tasks to get the desired results.

Afrikaans
Albanian
Amharic
Arabic
Armenian
Azerbaijani
Basque
Belarusian
Bengali
Bosnian
Bulgarian
Catalan
Cebuano
Chichewa
Chinese Simplified
Chinese Traditional
Corsican
Croatian
Czech
Danish
Dutch
English
Esperanto
Estonian
Filipino
Finnish
French
Frisian
Galician
Georgian
German
Greek
Gujarati
Haitian Creole
Hausa
Hawaiian
Hebrew
Hindi
Hmong
Hungarian
Icelandic
Igbo
Indonesian
Irish
Italian
Japanese
Javanese
Kannada
Kazakh
Khmer
Korean
Kurdish
Kyrgyz
Lao
Latin
Latvian
Lithuanian
Luxembourgish
Macedonian
Malagasy
Malay
Malayalam
Maltese
Maori
Marathi
Mongolian
Myanmar (Burmese)
Nepali
Norwegian
Odia
Pashto
Persian
Polish
Portuguese
Punjabi
Romanian
Russian
Samoan
Scots Gaelic
Serbian
Sesotho
Shona
Sindhi
Sinhala
Slovak
Slovenian
Somali
Spanish
Sundanese
Swahili
Swedish
Swiss German
Tajik
Tamil
Tatar
Telugu
Thai
Turkish
Turkmen
Ukrainian
Urdu
Uyghur
Uzbek
Vietnamese
Welsh
Xhosa
Yiddish
Yoruba
Zulu

Error Codes

In the development and usage of our API, you may encounter various error codes that help identify specific issues and guide you towards resolving them. Understanding these error codes is crucial for troubleshooting and ensuring seamless integration with our services. Below is a comprehensive list of error codes, along with their descriptions, to assist you in diagnosing and addressing any problems that may arise during your interactions with our API.

0: Unauthorized access attempt from {ipaddress}
1: API key or email is missing
2: Invalid API key or API Email
3: API key expired
4: Insufficient credits
5: Parsed URL {url} does not have any data
6: No task provided
7: No title provided
8: Exceeded the maximum context size of 128000 tokens.
9: Failed to open stream {parse_url or reference_url}