Skip to main content
POST
/
analyze-landing-text
Analyze Text Endpoint
curl --request POST \
  --url https://api.example.com/analyze-landing-text \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>"
}
'
{
  "understood": true,
  "message": "<string>",
  "redirect_url": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.nivara.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Analyze Text Endpoint

Analyzes text from the landing page to determine which action to take.

​
Request Body

FieldTypeRequiredDescription
textstringYesText to analyze

​
Responses

StatusDescriptionContent Type
200Analysis resultsapplication/json
422Validation Errorapplication/json

​
Response Schema

{
  "understood": true,
  "message": "Text was understood",
  "redirect_url": "/shipment"
}
FieldTypeDescription
understoodbooleanWhether the text was understood
messagestringResponse message
redirect_urlstringOptional URL to redirect to (can be null)

Body

application/json
​
text
string
required

Response

Successful Response

​
understood
boolean
required
​
message
string
required
​
redirect_url
string | null