Environment: ProductionEnvironment: Production USEnvironment: Test
API Reference

Create an improve-text preview for a single product

post
https://api.test.bluestonepim.com/ai-text/ai-linguist/improve-text/preview

Generates a preview of AI improve-text output for a single product. The preview is processed asynchronously — poll GET /ai-linguist/improve-text/preview/{jobId} for the result.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to create a single-product Linguist preview (translate, improve-text, or spell-checker). The columns array defines which attributes the AI will process.

string
required

ID of the product to preview.

string
required

Model identifier (e.g. 'gpt-4o-2024-11-20'). Must match a model available in the org config.

string
required

AI provider (e.g. 'openai', 'bedrock'). Must match a provider available in the org config.

columns
array of objects
required

List of columns (attributes) the AI will process. Each item uses columnType: name for metadata fields or columnType: attribute for custom attributes. Total count must not exceed the configured columnLimit.

columns*
string

Global instruction for the AI — applies to all columns in this request. Describes the desired transformation (translate to French, improve clarity, fix spelling, etc.).

aiParameters
object

Optional AI parameter overrides (e.g. temperature). Merged with org-level config overrides.

Headers
string
required

Source locale/channel context to read product attribute values from.

string

Target locale/channel context to write improved values into. Optional for improve-text — when omitted the source context is used as the output context.

string
enum
Defaults to true

Whether to fall back to the default context when the specified context has no value.

Allowed:
Responses

500

Internal Server Error.

Updated 6 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?