apyhub
▣ ARTIFICIAL INTELLIGENCE · SMART GENERATION

Generate Product Review Sentiment API

What it does

Review Sentiment Analysis classifies product review text and returns a sentiment result for the submitted job. Send a review in the content field, then use the returned job_id or status_url to check processing status.

The initial response gives you a UUID job_id and a status_url for the asynchronous job. When the job completes, the status endpoint returns a data object with id, type, and attributes. Inside attributes, you get the job status, plus a result object containing score and opinion.

Use this when you need to triage customer feedback, label product reviews at scale, or route negative comments into support and product workflows. Because the response is job-based, it fits batch pipelines where review text is submitted first and checked later for completion.

Review Sentiment Analysis keeps the output narrow and predictable: a job identifier up front, then the final sentiment fields once processing is done.

▣ ENDPOINT 01 / 02
POST
Submit Generate Product Review Sentiment job
https://api.eu.apyverse.com/sharpapi/generate-product-review-sentiment

QUICKSTART

GUIDE

Quickstart

Submit a review text for asynchronous sentiment analysis.

curl -X POST "https://api.eu.apyverse.com/sharpapi/generate-product-review-sentiment" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content":"This product is excellent and works exactly as expected."}'

What you'll get back

Returns a JSON object with status_url and job_id string fields. status_url is a URI for checking the job status, and job_id is the UUID identifier of the submitted asynchronous job.

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status_url": "https://example.com/jobs/550e8400-e29b-41d4-a716-446655440000"
}
TRY ITLIVE · 50 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*
Provide review text to analyze the sentiment.

About this endpoint

What it does

Submits a product review sentiment analysis job and returns identifiers you can use to check progress later. The request body includes the review text in content, and the response returns a job identifier plus a status URL for polling.

Request Body

ParameterTypeMandatoryDescription
contentStringYesProvide review text to analyze the sentiment.

Response

Returns a JSON object with required job_id and status_url string fields. job_id is the submitted asynchronous job identifier, and status_url is the URI used to check the job status.

ParameterTypeMandatoryDescription
job_idStringYesIdentifier of the submitted asynchronous job. Format: UUID.
status_urlStringYesURL used to check the submitted job status. Format: URI.

Notes

This endpoint kicks off an async job and returns immediately with a job identifier; the actual work runs in the background. Pair this call with the corresponding job_check endpoint — poll that until the status reaches a terminal state to retrieve the result. Extract the job identifier from job_id.

Body

Name
Type
Description
bodyREQUIRED
object
—
▣ ENDPOINT 02 / 02
GET
Get Generate Product Review Sentiment job status
https://api.eu.apyverse.com/sharpapi/generate-product-review-sentiment/job/status/:job_id

QUICKSTART

GUIDE

Quickstart

Check the status of a review-sentiment job by its job_id path parameter.

curl -X GET "https://api.eu.apyverse.com/sharpapi/generate-product-review-sentiment/job/status/:job_id" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a data object. Inside data, id and type are strings, and attributes is an object containing type (string), status (string), and result (an object with score and opinion strings).

{
  "data": {
    "id": "job-123",
    "type": "job",
    "attributes": {
      "type": "review-sentiment",
      "status": "completed",
      "result": {
        "score": "0.87",
        "opinion": "positive"
      }
    }
  }
}
TRY ITLIVE · 1 ATOM
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns the current status of a Generate Product Review Sentiment async job identified by job_id. When the job has completed successfully, the response also includes the result payload under data.attributes.result.

Path Parameter(s)

AttributeTypeMandatoryDescription
job_idStringYesJob identifier in UUID format.

Response

Returns a JSON object with a data object field. The data object contains id and type string fields, plus an attributes object with type, status, and result fields.

AttributeTypeMandatoryDescription
dataObjectNoWrapper object containing the job details.
data.idStringNoJob identifier.
data.typeStringNoResource type.
data.attributesObjectNoObject containing job attributes.
data.attributes.typeStringNoAttribute type.
data.attributes.statusStringNoCurrent job status.
data.attributes.resultObjectNoJob result object, populated when the job has completed successfully.
data.attributes.result.scoreStringNoSentiment score.
data.attributes.result.opinionStringNoSentiment opinion.

Notes

Poll this endpoint with the job_id returned by the submit call. The status field cycles through transitional values before reaching a terminal state; the result fields under data.attributes.result are only populated once status is success.

Path parameters

Name
Type
Description
job_idREQUIRED
string
—
▣ 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.

Product
CatalogPricingQuickstartBecome a providerStatus (opens in new tab)
Company
AboutBlogCareers (opens in new tab)Contact
Legal
Terms of ServicePrivacy PolicyProvider terms
© 2026 APYHUB · BUILT FOR DEVELOPERS