Create a translate preview for a single product

post

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

productId

string

required

ID of the product to preview.

model

string

required

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

provider

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*

instructionText

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

context

string

required

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

output-context

string

required

Target locale/channel context to translate into. Must be different from the source context — the server enforces this.

context-fallback

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.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Preview job created and initial state returned. Poll GET /{jobId} for the AI result.

400Bad request. Possible reasons: context equals output-context, columns exceed limit, product not found, model/provider not available.