RapidTextAI API Documentation

blog
Author RapidTextAI

Category

Page

Publish

26, July 2024

Overview

The RapidTextAI API provides an endpoint for generating detailed articles using custom prompts. This documentation will guide you through the process of using the API to submit a request and receive a generated article.

Endpoints

URL

https://app.rapidtextai.com/openai/detailedarticle-v2

Available Endpoints

1. Detailed Article v2

https://app.rapidtextai.com/openai/detailedarticle-v2?gigsixkey=YOUR_API_KEY

Primary endpoint for generating articles with latest features.

2. Detailed Article

https://app.rapidtextai.com/openai/detailedarticle?gigsixkey=YOUR_API_KEY

Legacy endpoint for article generation.

2.1 Premium Article Generation

ttps://app.rapidtextai.com/openai/detailedarticle-v3?gigsixkey=YOUR_API_KEY

Enhanced endpoint for generating high-quality articles with advanced features:

  • Advanced language models
  • Better context understanding
  • Improved content structure
  • SEO optimization
  • Higher word count limits

This endpoint requires a premium subscription and follows the same request parameters as the standard article endpoints.

3. GPT-4

https://app.rapidtextai.com/openai/gpt4?gigsixkey=YOUR_API_KEY

Endpoint for accessing GPT-4 model.

4. GPT-4 Online

https://app.rapidtextai.com/openai/gpt4o?gigsixkey=YOUR_API_KEY

Endpoint for accessing online version of GPT-4.

5. Gemini Plus

https://app.rapidtextai.com/openai/gemini-plus?gigsixkey=YOUR_API_KEY

Endpoint for Gemini 1.5 Pro model.

6. Claude 3.5

https://app.rapidtextai.com/openai/claude-3-5?gigsixkey=YOUR_API_KEY

Endpoint for Claude 3.5 model.

7. LLaMA Models

Base URL: https://app.rapidtextai.com/openai/llama-ai?gigsixkey=YOUR_API_KEY

Available model parameters:

  • &llama_model=llama-7b - LLaMA 7B model
  • &llama_model=deepseek-r1 - DeepSeek R1 model
  • &llama_model=deepseek-v3 - DeepSeek V3 model
  • &llama_model=Qwen1.5-7B-Chat - Qwen 1.5 7B Chat model
  • &llama_model=llama3.2-3b - LLaMA 3.2 3B model

All endpoints require authentication via the gigsixkey parameter and accept the same request parameters as detailed in the Request Body section above.

Note: Model availability may depend on your subscription level and API access rights.

Method

POST

Request Body

The request body should be formatted as multipart/form-data with the following fields:

Field Name Description Example Value
type Type of the request(required) custom_prompt
toneOfVoice Tone of the generated article
language Language of the article
text Text for the article
temperature Creativity of the response 0.7
custom_prompt Custom prompt for the article (required) Okay

Below is an example using curl to send a request to the API:

Example Request

Endpoint: https://app.rapidtextai.com/openai/detailedarticle-v2

Required Parameters:

  • gigsixkey: Your API key for authentication

Request Body (multipart/form-data):

  • type: 'custom_prompt' (string) - Type of request
  • toneOfVoice: (string) - Desired tone
  • language: (string) - Target language
  • text: (string) - Additional context
  • temperature: (float) - AI creativity (0.0 to 1.0)
  • custom_prompt: (string) - Your prompt/question

Example cURL Request:

curl -X POST 'https://app.rapidtextai.com/openai/detailedarticle-v2?gigsixkey=YOUR_API_KEY' \
    -H 'Content-Type: multipart/form-data' \
    -F 'type=custom_prompt' \
    -F 'toneOfVoice=' \
    -F 'language=' \
    -F 'text=' \
    -F 'temperature=0.7' \
    -F 'custom_prompt=Your question here'

Headers:

  • Accept: text/plain, */*; q=0.01
  • Content-Type: multipart/form-data
Note: Replace YOUR_API_KEY, CHAT_SESSION_ID, and USER_ID with actual values

Response (String)

The API will return the generated article based on the provided custom prompt and other parameters. The response format and structure will depend on the specific implementation of the RapidTextAI API.

This documentation provides the essential information needed to interact with the RapidTextAI API to generate detailed articles using custom prompts. For further assistance, refer to the official API documentation or contact RapidTextAI support.

Premium Article Generation

Examples

JavaScript Implementation


async function generate_article(apiKey) {
    const url = 'https://app.rapidtextai.com/openai/detailedarticle-v3?gigsixkey=' + apiKey;
    
    var calltoactionprompt = jQuery('#callToAction').val() ? ' with a call to action: ' + jQuery('#callToAction').val() : '';
    var referencesprompt = jQuery('#references').val() ? ' with references: ' + jQuery('#references').val() : '';
    var articleToneprompt = jQuery('#articleTone').val() ? ' with the tone of voice: ' + jQuery('#articleTone').val() : '';
    var targetAudienceprompt = jQuery('#targetAudience').val() ? ' for the target audience: ' + jQuery('#targetAudience').val() : '';
    var articleLengthprompt = jQuery('#articleLength').val() ? ' with the article length: ' + jQuery('#articleLength').val() : '';
    var writingstyleprompt = jQuery('#writingStyle').val() ? ' with the writing style: ' + jQuery('#writingStyle').val() : '';
    var articleStructureprompt = jQuery('#articleStructure').val() ? ' with the article structure: ' + jQuery('#articleStructure').val() : '';
    var internalLinksprompt = jQuery('#internalLinks').val() ? ' with internal links: ' + jQuery('#internalLinks').val() : '';
    var externalLinksprompt = jQuery('#externalLinks').val() ? ' with external links: ' + jQuery('#externalLinks').val() : '';
    
    const formData = new FormData();
    formData.append('type', 'custom_prompt');
    formData.append('toneOfVoice', 'professional');
    formData.append('language', 'en');
    formData.append('text', '');
    formData.append('temperature', '0.7');
    formData.append('custom_prompt', ' Generate a detailed article on the topic of ${topic} with the following keywords: ${keywords}${calltoactionprompt}${referencesprompt}${articleToneprompt}${targetAudienceprompt}${articleLengthprompt}${writingstyleprompt}${articleStructureprompt}${internalLinksprompt}${externalLinksprompt}'';
    ');

    try {
        const response = await fetch(url, {
            method: 'POST',
            body: formData
        });
        const result = await response.text();
        return result;
    } catch (error) {
        console.error('Error:', error);
        throw error;
    }
}

cURL Implementation


# Set API key
API_KEY="YOUR_API_KEY"

# Set endpoint URL
URL="https://app.rapidtextai.com/openai/detailedarticle-v3?gigsixkey=$API_KEY"

# Make the POST request
curl -X POST "$URL" \
  -H "Content-Type: multipart/form-data" \
  -F "type=custom_prompt" \
  -F "toneOfVoice=professional" \
  -F "language=en" \
  -F "text=" \
  -F "temperature=0.7" \
  -F "custom_prompt=Generate a detailed article on the topic of ${topic} with the following keywords: ${keywords}${calltoactionprompt}${referencesprompt}${articleToneprompt}${targetAudienceprompt}${articleLengthprompt}${writingstyleprompt}${articleStructureprompt}${internalLinksprompt}${externalLinksprompt}'"
Usage Example:

generate_article('YOUR_API_KEY')
    .then(article => console.log(article))
    .catch(error => console.error(error));
Note: Premium article generation requires appropriate subscription level and API access rights.

Image Generation API

Image Generation Endpoint

Endpoint: https://app.rapidtextai.com/openai/dall-e

Authentication:

  • gigsixkey: Your API key (required)

Request Body (multipart/form-data):

  • prompt: (string) - Description of the image to generate
  • style: (string) - Style of the image
  • resolution: (string) - Image resolution/size
  • imageCount: (integer) - Number of images to generate
  • mimeType: (string) - Image format (default: image/png)
  • userid: (string) - User identifier
  • chatsession: (string) - Chat session identifier

Example cURL Request:

curl -X POST 'https://app.rapidtextai.com/openai/dall-e?gigsixkey=YOUR_API_KEY' \
    -H 'Content-Type: multipart/form-data' \
    -F 'prompt=A beautiful sunset over mountains' \
    -F 'style=realistic' \
    -F 'resolution=1024x1024' \
    -F 'imageCount=1' \
    -F 'mimeType=image/png'

Response Format:

{
    "status": "success",
    "images": [
        "base64_encoded_image_data",
        ...
    ]
}
Notes:
  • Images are returned as base64 encoded strings
  • The API requires user authentication via gigsixkey
  • Free users may have limited response capacity

API Pricing

Usage & Credits

Cost per Operation

  • Single API Request 1 prompt
  • Article Generation 10 prompts
  • Image Generation 50 prompts

Monthly Prompt Allowance

Account Type Monthly Prompts
Free User 100 prompts
Basic Subscriber 10,000 prompts
Premium Subscriber 30,000 prompts
Note: Unused prompts do not roll over to the next month. Subscription levels determine your monthly prompt allocation.

All set to level up
your content game?

Get Started Now
cta-area