Generate Sending Text

POST

https://api.mpc.dev.placewise.com/v1/ml/sending/generate_text

API Permit:ML:SendingTextGeneration:Post

API Context:Loyalty Club

Authorizations:User

Generates sending text.

Body Parameters

Parameter	Type	Required?	Description
about	String	yes	What about the text should be.
include_keywords	Array[String]	yes	Keywords that should be included.
word_limit	Integer	yes	Text limit in words.
tone	String	yes	Tone of the text, e.g `engaging`, `emotional`.
occasion	String	yes	Occasion of sending, e.g `christmas`, `valentines`
variation	String	yes	How varied should text be, options: `none`, `medium`, `high`
target_language	String	yes	Language in ISO format, e.g. `pl`, `en`.

Parameters like: about, include_keywords (Array[String]), occasion, can be in any language supported by deepl.
(https://www.deepl.com/docs-api/translate-text/). Each parameter will be translated from target_language to en to build full prompt in English.
After that we concatenate the prompt as follows: PROMPT + 'Use {target_language} language.'.
Where target_language (in ISO format) will me mapped to target_language in full name format e.g pl -> Polish...

Example

When successful, returns:

{
    'sending_text_generation_task': {
        'id': 1
    }
}

Request

Header Params

Body Params application/json

Example

{
    "about": "string",
    "include_keywords": [
        "string"
    ],
    "word_limit": 0,
    "tone": "string",
    "occasion": "string",
    "variation": "none",
    "target_language": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/ml/sending/generate_text' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "about": "string",
    "include_keywords": [
        "string"
    ],
    "word_limit": 0,
    "tone": "string",
    "occasion": "string",
    "variation": "none",
    "target_language": "string"
}'

Responses

🟢200Success

application/json

Body

Example

{}

Modified at 2025-05-29 12:33:44

Generate Text

Introduction

Generate Sending Text

Body Parameters#

Example#

Request

Request Code Samples

Responses

Body Parameters

Example