apyhub
Back

AI Writing Assistant API

What it does

AI Writing Assistant helps you generate citations, check grammar and spelling, and outline a user manual from structured prompts. Send the specific text or document details each endpoint needs, and get back a formatted result you can use directly in your app.

Use Citation Generator when you need APA, MLA, or Chicago references. Provide style, authors, title, and optional url, year, and siteOrPublisher, then receive a single formatted citation in result along with the tool name.

Use Grammar & Spelling Checker for plain text review. Send text and get a result object with the corrected version, a count of corrections, a list of issues, suggestions, and the rule-based method used. That makes it useful for editor workflows, support content, and any user-generated copy that needs a quick cleanup.

Use User Manual Outline Generator to turn a product name and task list into a manual outline. Provide product and tasks, and it returns a title plus ordered sections, including one "How to" section per task. That fits onboarding docs, help centers, and internal enablement content.

▣ ENDPOINT 01 / 03
POST
Citation Generator (APA, MLA, Chicago)
https://api.eu.apyhub.com/freedailypro/ai-writing-assistant-api/text/citation

QUICKSTART

GUIDE

Quickstart

Create a citation for a web page by sending the required style, authors, and title fields.

curl -X POST "https://api.eu.apyhub.com/freedailypro/ai-writing-assistant-api/text/citation" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "style": "apa",
    "authors": "Smith, John",
    "title": "Understanding API Documentation"
  }'

What you'll get back

Returns a JSON object with a tool string and a result string. tool is the name of the tool that produced the response, and result is the formatted citation.

{
  "tool": "citation-generator",
  "result": "Smith, J. (2024). Understanding API documentation."
}
TRY ITLIVE · 10 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*

About this endpoint

What it does

Generates a formatted citation for a source in one of the supported styles: APA, MLA, or Chicago. You send the source details in the request body and receive a JSON object containing the citation text and the tool name.

Request Body

ParameterTypeMandatoryDescription
urlStringNoSource URL.
yearStringNoPublication year. Accepts a string or number.
styleENUMYesCitation style. Allowed values: apa, mla, chicago.
titleStringYesSource title.
authorsStringYesAuthor name(s).
siteOrPublisherStringNoSite or publisher name.

Response

Returns a JSON object with required tool and result string fields. result contains the formatted citation, and tool identifies the tool that produced the response.

ParameterTypeMandatoryDescription
toolStringYesName of the tool that produced the response.
resultStringYesThe formatted citation.
▣ ENDPOINT 02 / 03
POST
Grammar & Spelling Checker
https://api.eu.apyhub.com/freedailypro/ai-writing-assistant-api/text/grammar-check

QUICKSTART

GUIDE

Quickstart

Check a piece of text for grammar issues by sending it in the request body.

curl -X POST "https://api.eu.apyhub.com/freedailypro/ai-writing-assistant-api/text/grammar-check" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"This are a test."}'

What you'll get back

Returns a JSON object with tool and result fields. tool is a string naming the tool that produced the response, and result is an object containing the grammar-check output: corrected (string), issues (array), suggestions (array), method (string), and corrections (number).

{
  "tool": "string",
  "result": {
    "corrected": "string",
    "issues": [],
    "suggestions": [],
    "method": "string",
    "corrections": 0
  }
}
TRY ITLIVE · 10 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*

About this endpoint

What it does

Checks the submitted text for grammar and spelling issues, then returns the corrected text along with the detected issues, uncorrected suggestions, the checking method, and a correction count.

Request Body

ParameterTypeMandatoryDescription
textStringYesThe text to check for grammar and spelling issues. Maximum length: 20000 characters.

Response

Returns a JSON object with a tool string field and a result object field. The result object contains the corrected text, a list of issues, a list of suggestions, the checking method, and the number of corrections made.

ParameterTypeMandatoryDescription
toolStringYesName of the tool that produced the response.
resultObjectYesGrammar check results. Contains corrected, issues, suggestions, method, and corrections.
result.correctedStringYesThe text with all corrections applied.
result.issuesString ArrayYesProblems that were found and corrected. Each item is either a string or an object with type and message.
result.suggestionsObject ArrayYesPossible problems that were not corrected automatically. Each item is either an object with type and message, or a string.
result.methodStringYesHow the check was done (rule-based).
result.correctionsNumberYesNumber of corrections made.
▣ ENDPOINT 03 / 03
POST
User Manual Outline Generator
https://api.eu.apyhub.com/freedailypro/ai-writing-assistant-api/text/user-manual

QUICKSTART

GUIDE

Quickstart

Create a user manual outline for a product and its task list.

curl -X POST "https://api.eu.apyhub.com/freedailypro/ai-writing-assistant-api/text/user-manual" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product": "Acme Project Management App",
    "tasks": [
      "Create a new project",
      "Invite team members",
      "Assign tasks to a teammate"
    ]
  }'

What you'll get back

Returns a JSON object with tool and result fields. tool is the name of the tool that produced the response, and result is an object containing the manual outline with a title string and a sections array of strings in order.

{
  "tool": "manual-outline-generator",
  "result": {
    "title": "Acme Project Management App User Manual",
    "sections": [
      "Introduction",
      "Getting Started",
      "How to Create a New Project",
      "How to Invite Team Members",
      "How to Assign Tasks to a Teammate"
    ]
  }
}
TRY ITLIVE · 10 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
tasks*

About this endpoint

What it does

Generates a user manual outline for a product based on the product name and a list of tasks. The response returns the producing tool name and a manual outline containing a title and ordered section headings.

Request Body

ParameterTypeMandatoryDescription
productStringYesThe product the manual is for.
tasksString ArrayYesThe tasks to cover in the manual.

Response

Returns a JSON object with a tool string field and a result object field. The result object contains a title string and a sections string array with the manual outline, including one "How to" section per task.

ParameterTypeMandatoryDescription
toolStringYesName of the tool that produced the response.
resultObjectYesThe user manual outline.
result.titleStringYesTitle of the manual.
result.sectionsString ArrayYesSection headings in order, including one "How to" section per task.
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.