Writer Tool API

The Writer tool API provides a simple yet powerful interface for multiple writing tools used by writers.

Endpoint

POST /text/v1/writer-tool

Body

inputs (array, required): An array of inputs.
language (string, required): The language to be used.
number (number, required): The number of items to generate.
useCase (string, required): The use case for the generation.
action (string, required): The action to be performed.
tone (string, required): The tone of the generated text.

Here are multiple formats for inputs depending on the useCase, explained as follows:

Example

Request

POST /text/v1/writer-tool
Content-Type: application/json
x-access-key: YOUR_ACCESS_KEY

{
    "inputs": [
        {
            "jobRole": "ai machine learning dev",
            "jobSkills": "communication skills, fast learner"
        }
    ],
    "language": "English",
    "number": 1,
    "useCase": "CoverLetter",
    "action": "generate_writenow",
    "tone": "Critical"
}

Response

Success

HTTP/1.1 200 OK
{
    "data": {
    "language": "English",
    "useCase": "CoverLetter",
    "word_count": 204,
    "text": {
      "choices": [
        {
          "text": "Dear Hiring Manager,

I am writing to express my interest in the AI Machine Learning Developer role at your company. With a strong background in communication skills and a proven track record as a fast learner, I am confident in my ability to thrive in a fast-paced and challenging environment.

My exceptional communication skills have enabled me to effectively collaborate with cross-functional teams and convey complex technical concepts in a clear and concise manner. This skill set has been instrumental in my previous roles, allowing me to drive successful project outcomes and foster strong working relationships.

Furthermore, my ability to quickly grasp new concepts and technologies has been a key asset throughout my career. I am constantly seeking out opportunities to expand my knowledge and skill set, ensuring that I am always at the forefront of industry trends and advancements.

I am excited about the opportunity to bring my unique blend of communication skills and fast-learning abilities to your team. I am confident that my dedication and passion for AI and machine learning will make me a valuable asset to your organization.

Thank you for considering my application. I look forward to the possibility of discussing my application with you further.

Sincerely,

[Your Name]",
          "index": 0,
          "word_count": 204
        }
      ]
    }
  },
    "success": true,
    "message": "<process success message>"
}

Error

HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "success": false,
    "message": "<An error message containing the details>"
}

Introduction Arabygpt