Create an AI Enrich preview for a single product

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Preview request payload

productId

string

required

ID of the product to preview enrichment for.

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.

instructions

array of objects

required

One instruction object per output attribute. Must have the same length as outputAttributes. Each item targets either a metadata field (use name) or a custom attribute (use id).

instructions*

inputAttributes

array of objects

required

Attributes to provide as AI input context. Each item is either a metadata field (name) or a custom attribute (id). Total count must not exceed the configured inputLimit.

inputAttributes*

outputAttributes

array of objects

required

Attributes the AI will generate values for. Must have the same length as instructions. Each item is either a metadata field (name) or a custom attribute (id). Total count must not exceed the configured outputLimit.

outputAttributes*

usingImage

string

enum

Defaults to false

Whether to include the product image as AI input. Accepts 'true' or 'false'. Requires the selected model to have imageAsInput: true — backend returns 400 if not supported.

Allowed:

assetLabelId

string

Asset label ID used to select the specific product image when usingImage is true. Falls back to the first available asset if not provided.

aiParameters

object

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

Headers

context

string

Locale/channel context used to fetch the product from PIM. Recommended — product fetch behaviour depends on this value.

context-fallback

string

enum

Defaults to true

Whether to fall back to the default context when the specified context has no value. Must be the string 'true' or 'false'. Defaults to true.

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 processing started. Poll GET /ai-enrich/preview/{jobId} for the result.

400Bad Request — model or provider missing/invalid; instructions and outputAttributes arrays have different lengths; instructions, inputAttributes, or outputAttributes exceed the configured limits; usingImage is true but the model does not support image input; product not found.