WriteText.ai API - Get generated text for multiple records

Requirements

Authentication Required

Bearer access_token

Request Headers

Authorization: Bearer access_token

Example API Request

                    <p><a href="https://api-eu.writetext.ai/text/generate?type=Product&recordId=example1&storeId=www.example.com/en&language=en&field=page+description&historyCount=1&includeUpdateHistory=true">https://api-eu.writetext.ai/text/generate?type=Product&recordId=example1&storeId=www.example.com/en&language=en&field=page+description&historyCount=1&includeUpdateHistory=true</a></p>
                

Parameter Name	Type	Description
type	string, required	Specifies the type of text to generate. Must be either "Product" or "Category."
recordId	string, required	A single or comma-separated list of record IDs to retrieve the generated text for.
storeId	string, optional	Filters results by the store ID.
language	string, optional	Filters results by the language code.
field	string, optional	Filters by the field name. Accepts comma-separated values.
historyCount	integer, optional	The number of historical text generations to return (default=1).
includeUpdateHistory	boolean, optional	If true, the response will include the update history of the text.
matchIsoTwoLetterLanguageCode	boolean, optional	If true, language filter returns matches for ISO two letter language code for reviews. (e.g. "en-US" will also return "en" reviews)

Response

200

401

404

500

//This status is returned when the generated text for the specified records is successfully retrieved.

<p>{<br>    "type": "Product",<br>    "records": [<br>        {<br>            "recordId": "example1",<br>            "stores": [<br>                {<br>                    "storeId": "www.example.com/en",<br>                    "language": "en",<br>                    "field": "page description",<br>                    "texts": [<br>                        {<br>                            "id": "1234567890123456789_abcd1234-5678-90ef-1234-abcdef567890",<br>                            "date": "2024-08-23T04:48:11.332Z",<br>                            "keywords": [<br>                                "lager",<br>                                "beer"<br>                            ],<br>                            "value": "An iconic lager beer from Example Brewery, Sample Lager 0.33l. Price €1.49. Made in Example Country with BARLEY MALT. Store in a cool and dark place.",<br>                            "history": [<br>                                {<br>                                    "value": "An iconic lager beer from Example Brewery, Sample Lager 0.33l. Price €1.49. Made in Example Country with BARLEY MALT. Store in a cool and dark place.",<br>                                    "date": "2024-08-23T05:30:13.871Z",<br>                                    "publish": true,<br>                                    "reviewed": true<br>                                }<br>                            ] <br>                        }<br>                    ],<br>                    "reviews": [] <br>                }<br>            ]<br>        }<br>    ]<br>}</p>

//This status is returned if the API key is missing or invalid.

//This status is returned if no generated text is found for the specified record ID(s).

//The server encountered an error when processing the request.

Parameter Name	Type	Description
type	string	The type of text generated, such as "Product" or "Category."
records	array of objects	The list of records containing the generated text. recordId (string): The ID of the record. stores (array of objects): Information about the store where the text applies. storeId (string): The store ID where the text applies. language (string): The language of the generated texts. field (string): The field where the generated text is applied (e.g., "page description"). texts (array of objects): List of generated texts. id (string): A unique identifier for the generated text. date (string, date-time): The timestamp when the text was generated. datePublished (string, date-time): The timestamp when a generated text was last published. dateReviewed (string, date-time): The timestamp when a generated text was last marked as reviewed. keywords (array of strings): The keywords used in the generated text. value (string): The generated text content. history (array of objects, optional): A history of updates to the generated text, if available. value (string): The text content in the history. date (string, date-time): The timestamp of the historical update. publish (boolean): Indicates whether the text was published. reviewed (boolean): Indicates whether the text was reviewed. reviews (array of objects, optional): Lists reviews, if any.

Parameter Name

Type

Description

type

string

The type of text generated, such as "Product" or "Category."

records

array of objects

The list of records containing the generated text.

recordId (string): The ID of the record.
stores (array of objects): Information about the store where the text applies.
- storeId (string): The store ID where the text applies.
- language (string): The language of the generated texts.
- field (string): The field where the generated text is applied (e.g., "page description").
- texts (array of objects): List of generated texts.

- - id (string): A unique identifier for the generated text.
  - date (string, date-time): The timestamp when the text was generated.
  - datePublished (string, date-time): The timestamp when a generated text was last published.
  - dateReviewed (string, date-time): The timestamp when a generated text was last marked as reviewed.
  - keywords (array of strings): The keywords used in the generated text.
  - value (string): The generated text content.
  - history (array of objects, optional): A history of updates to the generated text, if available.
    - value (string): The text content in the history.
    - date (string, date-time): The timestamp of the historical update.
    - publish (boolean): Indicates whether the text was published.
    - reviewed (boolean): Indicates whether the text was reviewed.
- reviews (array of objects, optional): Lists reviews, if any.