apyhub
Back
▣ ARTIFICIAL INTELLIGENCE · MARKETING

Generate Product Introduction API

What it does

Product Introduction Generator creates a product introduction from your content. Send a content string, and you can also set language, max_length, and voice_tone in the request body to steer the output.

Use it when you need a concise intro for a landing page, app store listing, marketing draft, or internal product brief. The POST request returns a job_id, so generation runs asynchronously and you can poll for completion without blocking your workflow.

Check the job status with job_id through GET /job/status/:job_id. The status response includes the job id, the current status (queued, running, success, or failed), and, when complete, a result object containing product_intro.

Product Introduction Generator fits pipelines that need AI-written copy with a controllable tone and length, while keeping the response format simple for downstream automation.

▣ ENDPOINT 01 / 02
POST
Generate Product Introduction
https://api.eu.apyhub.com/sharpapi/generate-product-introduction

QUICKSTART

GUIDE

Quickstart

Submit product content to generate an introduction. This call sends the required content field in a JSON body.

curl -X POST "https://api.eu.apyhub.com/sharpapi/generate-product-introduction" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Our smart water bottle tracks hydration and reminds you to drink throughout the day."
  }'

What you'll get back

Returns a JSON object with a job_id string — the UUID of the submitted job. Poll the job status endpoint with this id to retrieve the result.

{
  "job_id": "7b421ced-711f-4583-a848-9f531e91c42f"
}
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*

About this endpoint

What it does

Submits a job to generate a product introduction from the provided content. The endpoint returns identifiers you can use to check job progress later.

Request Body

ParameterTypeDescription
contentStringInput content used to generate the product introduction.
languageStringLanguage for the generated introduction. Default: English.
max_lengthIntegerMaximum length for the generated introduction.
voice_toneStringDesired tone of voice for the generated introduction.

Response

Returns a JSON object with a job_id string — the UUID of the submitted job. Poll the job status endpoint with this id to retrieve the result.

ParameterTypeDescription
job_idStringThe unique identifier for the submitted job.

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.

▣ ENDPOINT 02 / 02
GET
Check Product Intro Status
https://api.eu.apyhub.com/sharpapi/generate-product-introduction/job/status/:job_id

QUICKSTART

GUIDE

Quickstart

Check the status of a product introduction job by its job_id.

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

What you'll get back

Returns a JSON object with a data object. data includes the job id and type, plus an attributes object with status and, when available, result.product_intro.

{
  "data": {
    "id": "uuid-1234",
    "type": "api_job_result",
    "attributes": {
      "status": "success",
      "result": {
        "product_intro": "Introducing our new wireless earbuds, designed for all-day comfort and clear sound."
      }
    }
  }
}
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

Checks the status of a product-introduction generation job by job ID. The response returns a data object with the job identifier, current status, and, when available, the generated product introduction result.

Path Parameter(s)

AttributeTypeDescription
job_idStringThe job's unique UUID.

Response

Returns a JSON object with a data object. Inside data, id is a string job identifier, type is a string, and attributes is an object containing status and, when the job has completed successfully, result.product_intro.

AttributeTypeDescription
dataObjectThe response wrapper containing the job record.
data.idStringThe job's unique UUID.
data.typeStringThe resource type. The schema example shows api_job_result.
data.attributesObjectJob metadata, including status and result fields.
data.attributes.statusENUMCurrent status of the asynchronous job. Allowed values: running, failed, queued, success.
data.attributes.resultObjectThe generated result payload. Populated when the job reaches success.
data.attributes.result.product_introStringThe generated product introduction text.

Notes

Poll this endpoint with the job_id returned by the submit call. The data.attributes.status field cycles through transitional values (queued, running) before reaching a terminal state (success, failed). The result field data.attributes.result.product_intro is only populated once status is success; treat it as absent otherwise.

▣ 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.

Similar APIs

Closest matches in the catalog based on this service.

CALLGenerate Product Categories APISharpAPICALLJob Description Generator APISharpAPICALLGenerate Thank You E-mail APISharpAPICALLJob Description Generator APISumalya APIs

From the blog

Reads that touch this API.

The API Sprawl Problem in Ecommerce: How Teams Lose Time to Utility CodeAug 5, 2026Getting Started with APIs: A Beginner’s Guide 2026Sep 17, 2026How to Promote Your API After You Publish ItAug 14, 2026Generate Barcode API vs Generate QR Code API: Full Comparison & Use CasesJul 9, 2026