Skip to main content
POST
/
api
/
ult
curl --request POST \
  --url https://whetdata.com/api/ult/api/ult \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "action": "classification",
  "ruleset": "product_description",
  "text": "Premium wireless headphones with active noise cancellation, 30-hour battery life, and crystal-clear audio quality.",
  "threshold": 0.8
}'
{
  "success": true,
  "action": "classification",
  "ruleset": "product_descriptions",
  "result": {
    "valid": true,
    "confidence": 0.5,
    "score": 0.5,
    "reason": "<string>",
    "threshold": 123
  },
  "rateLimit": {
    "dailyRemaining": 123,
    "monthlyRemaining": 123
  }
}

​
Overview

Generate actionable improvement suggestions for your text. This analyzes your content and provides specific, prioritized recommendations to enhance quality and conversion potential. The endpoint is POST /api/ult; the request body sets action: "nudges".

​
Parameters

​
action
string
required
Must be "nudges".
​
ruleset
string
required
Ruleset to use (for example product_description).
​
text
string
required
Input text (max 5,000 characters).
​
max_nudges
number
default:"3"
Number of suggestions to return (minimum 1).

​
Example

cURL
curl -X POST https://whetdata.com/api/ult \
  -H "x-api-key: whet_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "nudges",
    "ruleset": "product_description",
    "text": "This product is good and works well.",
    "max_nudges": 3
  }'
title: “Nudges” openapi: “POST /api/ult”

​
Overview

The nudges action generates actionable improvement suggestions for your text. It analyzes your content and provides specific, prioritized recommendations to enhance quality and conversion potential.

​
Use This Action To

  • Improve existing product descriptions
  • Generate variations for A/B testing
  • Identify gaps in your content strategy
  • Learn what makes effective copy

​
Parameters

​
action
string
required
Must be "nudges"
​
ruleset
string
required
Ruleset name for analysis (e.g., product_descriptions, marketing_copy, technical_docs, reviews)
​
text
string
required
Text to improve (max 5,000 characters)
​
max_nudges
number
required
Maximum number of nudges to generate (minimum: 1)

​
Tips

Start by requesting 3-5 nudges initially. Focus on high-priority suggestions first for maximum impact.
The maximum text length is 5,000 characters. For longer texts, split them into chunks.

Authorizations

​
x-api-key
string
header
required

Your Whetdata API key. Get a free key here.

Body

application/json
​
action
enum<string>
default:classification
required

Action type: classification | nudges | clean

Available options:
classification,
nudges,
clean
​
text
string
default:Premium wireless headphones with active noise cancellation, 30-hour battery life, and crystal-clear audio quality.
required

Input text (max 5,000 characters)

Maximum length: 5000
​
ruleset
enum<string>
default:product_description

Ruleset name (required for classification and nudges)

Available options:
product,
product_description,
marketing_copy,
product_review,
technical_documentation,
date_online
​
threshold
number
default:0.7

Classification threshold (0.0 to 1.0)

Required range: 0 <= x <= 1

Response

Successful response

  • Option 1
  • Option 2
  • Option 3
​
success
boolean
Example:

true

​
action
string
Example:

"classification"

​
ruleset
string
Example:

"product_descriptions"

​
result
object
​
rateLimit
object
⌘I