Environment: ProductionEnvironment: Production USEnvironment: Test
API Reference

Create a new AI Analyst job

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

Request payload for creating an analyst job.

string
required

The model identifier to use for analysis (e.g. 'claude-3-5-sonnet-20241022').

string
required

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

trainProducts
object
required

Products used as training/example input. Exactly one of 'productIds', 'filter', or 'query' must be provided.

analysedProducts
object
required

Products to be analysed. Exactly one of 'productIds', 'filter', or 'query' must be provided.

trainAttributes
array of strings
required

List of attribute keys the model should learn from the training products.

trainAttributes*
string
Defaults to Custom

Name of the column setup to use. Defaults to 'Custom'.

Headers
string
required

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

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

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?