Text Intelligence Analyzer API

Text Intelligence Analyzer - a simple tool for text analysis. Shows tone, readability, statistics, and creates charts. Just paste your text and get helpful tips

Input

Send these Fields as input. A Field not listed here is refused.

text_input

Text to Analyze

  • Type: string
  • Required: yes
  • Length in characters: 1 to 30000

analysis_mode

Analysis Type

  • Type: string
  • Required: yes
  • Allowed values: comprehensive, sentiment_focus, word_analysis, readability_focus

include_wordcloud

Generate Word Cloud

  • Type: list of strings
  • Required: no
  • Allowed values: true

include_insights

Get Writing Tips

  • Type: list of strings
  • Required: no
  • Allowed values: true

Run it

One call presses the Widget and answers the run once its status is succeeded or failed, however long it takes. The key is read from ABYSS_API_KEY. Install the library with npm install abysshub or pip install abysshub; cURL sends the Fields as a form.

JavaScript

// index.mjs
import Abyss from "abysshub";

const abyss = new Abyss();

const run = await abyss.run("widget_241", {
  text_input: "Dear Team,\r\n\r\nI hope this message finds you well. I wanted to update you on our project progress and discuss next steps.\r\n\r\nWe've successfully completed phase one ahead of schedule. The client feedback has been overwhelmingly positive, and they're excited to move forward with the next phase.\r\n\r\nHowever, we need to address a few challenges before proceeding. The budget requires adjustment due to scope changes, and we'll need additional resources for the upcoming deadline.\r\n\r\nLet's schedule a meeting this week to discuss these items in detail.\r\n\r\nBest regards,\r\nJohn",
  analysis_mode: "sentiment_focus",
  include_wordcloud: ["true"],
});

for (const path of await run.save("output")) {
  console.log(path);
}

Python

from abysshub import Abyss

abyss = Abyss()

run = abyss.run("widget_241", {
    "text_input": "Dear Team,\r\n\r\nI hope this message finds you well. I wanted to update you on our project progress and discuss next steps.\r\n\r\nWe've successfully completed phase one ahead of schedule. The client feedback has been overwhelmingly positive, and they're excited to move forward with the next phase.\r\n\r\nHowever, we need to address a few challenges before proceeding. The budget requires adjustment due to scope changes, and we'll need additional resources for the upcoming deadline.\r\n\r\nLet's schedule a meeting this week to discuss these items in detail.\r\n\r\nBest regards,\r\nJohn",
    "analysis_mode": "sentiment_focus",
    "include_wordcloud": ["true"],
})

for path in run.save("output"):
    print(path)

cURL

curl https://api.abysshub.com/v1/widgets/widget_241/runs \
  -H "Authorization: Bearer $ABYSS_API_KEY" \
  -F 'text_input=Dear Team,

I hope this message finds you well. I wanted to update you on our project progress and discuss next steps.

We'\''ve successfully completed phase one ahead of schedule. The client feedback has been overwhelmingly positive, and they'\''re excited to move forward with the next phase.

However, we need to address a few challenges before proceeding. The budget requires adjustment due to scope changes, and we'\''ll need additional resources for the upcoming deadline.

Let'\''s schedule a meeting this week to discuss these items in detail.

Best regards,
John' \
  -F analysis_mode=sentiment_focus \
  -F "include_wordcloud[]=true"

A succeeded run carries its result and its output_files. Their URLs are signed for each read: re-read the run, never store a URL. A run still queued or running in the answer (after an hour, or when the API is busy) is read again at its Location with ?wait=true.

More

Keys, files, errors and limits: API access.