Submit an AI Enrich job (batch or filtered)

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create job request payload

model

string

required

The model identifier to use for enrichment (e.g. 'gpt-4o-2024-11-20').

provider

string

required

The AI provider (e.g. 'openai', 'bedrock').

usingImage

string

enum

Defaults to false

Whether to use product images as AI input. Accepts 'true' or 'false'. Only valid when the selected model supports imageAsInput.

Allowed:

assetLabelId

string

Optional asset label ID used to select a specific image when usingImage is true.

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). Must not exceed inputLimit from config.

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). Must not exceed outputLimit from config.

outputAttributes*

instructions

array of objects

required

Per-attribute instructions for the AI. Must have the same length as outputAttributes. Each item targets either a metadata field (name) or a custom attribute (id), and carries the instruction text in the input field.

instructions*

filter

object

Core Search filter to select products. Mutually exclusive with productIds and query.

query

object

Query Builder query to select products. Mutually exclusive with productIds and filter.

productIds

array of strings

Explicit list of product IDs to process. Mutually exclusive with filter and query.

productIds

aiParameters

object

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

Headers

context

string

required

The context (locale/channel) used to resolve products and generate enriched content. Required by the backend — job creation will fail without it.

context-fallback

string

enum

Defaults to true

Whether to fall back to the default context when the specified context has no value. Accepts '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

202Job accepted and queued for processing.

400Bad request. Possible reasons: missing required fields, product count exceeds limit, input/output attribute count mismatch with instructions, model/provider not available.