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.

Authentication

To access the RapidTextAI API, you need to authenticate using the auth endpoint.

Endpoint

URL: https://app.rapidtextai.com/openai/auth

Method

GET

Parameters

Parameter Description Example Value
gigsixkey Your API key YOUR_API_KEY

Example Request

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

curl 'https://app.rapidtextai.com/openai/auth?gigsixkey=YOUR_API_KEY'
    

Response

The API will return a JSON response containing the id and session_id:

{
    "id": "your_id",
    "session_id": "your_session_id"
}
    

Prompts

Endpoint

URL

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

Method

POST

Headers

Include the following headers in your request:

Header Value
Accept text/plain, */*; q=0.01
Content-Type multipart/form-data; boundary=----WebKitFormBoundaryBdniA4Y0JzheQcPs
Origin https://app.rapidtextai.com
Referer https://app.rapidtextai.com/dashboard/bot/?chatsession=CHAT_SESSION_ID
User-Agent Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36

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
chatsession Chat session identifier CHAT_SESSION_ID
userid User ID USER_ID

Example Request

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

curl 'https://app.rapidtextai.com/openai/detailedarticle-v2?gigsixkey=YOUR_API_KEY' \
-H 'Accept: text/plain, */*; q=0.01' \
-H 'Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryBdniA4Y0JzheQcPs' \
-H 'Origin: https://app.rapidtextai.com' \
-H 'Referer: https://app.rapidtextai.com/dashboard/bot/?chatsession=CHAT_SESSION_ID' \
-H 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36' \
--data-raw $'------WebKitFormBoundaryBdniA4Y0JzheQcPs\r\nContent-Disposition: form-data; name="type"\r\n\r\ncustom_prompt\r\n------WebKitFormBoundaryBdniA4Y0JzheQcPs\r\nContent-Disposition: form-data; name="toneOfVoice"\r\n\r\n\r\n------WebKitFormBoundaryBdniA4Y0JzheQcPs\r\nContent-Disposition: form-data; name="language"\r\n\r\n\r\n------WebKitFormBoundaryBdniA4Y0JzheQcPs\r\nContent-Disposition: form-data; name="text"\r\n\r\n\r\n------WebKitFormBoundaryBdniA4Y0JzheQcPs\r\nContent-Disposition: form-data; name="temperature"\r\n\r\n0.7\r\n------WebKitFormBoundaryBdniA4Y0JzheQcPs\r\nContent-Disposition: form-data; name="custom_prompt"\r\n\r\nOkay\r\n------WebKitFormBoundaryBdniA4Y0JzheQcPs\r\nContent-Disposition: form-data; name="chatsession"\r\n\r\nCHAT_SESSION_ID\r\n------WebKitFormBoundaryBdniA4Y0JzheQcPs\r\nContent-Disposition: form-data; name="userid"\r\n\r\nUSER_ID\r\n------WebKitFormBoundaryBdniA4Y0JzheQcPs--\r\n'

Response

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.

All set to level up
your content game?

Get Started Now
cta-area