Apps » Shop-Script » API »

shop.ai.gpt

Returns text generated with the use of AI. The premium license of Shop-Script is required.

HTTP method

POST

Content type

application/x-www-form-urlencoded

Parameters

  • entity POST
    The type of object for which the text must be generated: 'product'.
  • field POST
    The object’s property for which the text must be generated: 'description', 'summary', 'meta_title', 'meta_keywords', 'meta_description', 'page' (e.g., product subpage).
  • entity_id POST Optional
    ID of the object for which the text must be generated; e.g., a product ID. The data currently contained in the object will be used for the generation.
  • objective POST Optional
    Text prompt, required for the combination entity='product' + field='page'.
  • format GET Optional

    Sets response format. Available options: json (default), xml.

Return value

Array with the following keys:

  • summary string Generated text for parameter field='summary'.
  • description string Generated text for parameter field='description'.
  • meta_title string Generated text for parameter field='meta_title'. Available with the following values of parameter field — 'meta_title', 'meta_description', 'meta_keywords'.
  • meta_description string Generated text for parameter field='meta_description'. Available with the following values of parameter field — 'meta_title', 'meta_description', 'meta_keywords'.
  • meta_keywords string Generated text for parameter field='meta_keywords'. Available with the following values of parameter field — 'meta_title', 'meta_description', 'meta_keywords'.
  • content string Generated text for parameter field='page'.