Environment: ProductionEnvironment: Production USEnvironment: Test
API Reference

Submit a spell-check job

post
https://api.test.bluestonepim.com/ai-text/ai-linguist/spell-checker
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to submit a Linguist batch job (translate, improve-text, or spell-checker). Provide exactly one of productIds, filter, or query to select the products to process.

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 job. Describes the desired transformation (translate to French, improve clarity, fix spelling, etc.).

string

Optional label for the column setup used in this job. Stored for reference only.

productIds
array of strings

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

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

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 corrected values into. Optional — 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?