Skip to main content
POST
/
api
/
v1
/
accounts
/
{accountId}
/
ai
/
suggest-template-value
Suggest template value
curl --request POST \
  --url https://api.example.com/api/v1/accounts/{accountId}/ai/suggest-template-value \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldName": "<string>",
  "currentValue": "<string>",
  "purpose": "<string>",
  "tones": [
    "<string>"
  ],
  "context": "<string>"
}
'
{
  "suggestions": [
    {
      "tone": "<string>",
      "value": "<string>"
    }
  ]
}

Path Parameters

​
accountId
string
required

Body

application/json

Request body containing field name, current value, purpose, tones, and context

​
fieldName
string
required

The name of the field to suggest a value for

​
currentValue
string
required

The current value of the field

​
purpose
string
required

The purpose of the suggestion. This should be the goal that the suggestion should try to achieve.

​
tones
string[]
required

The tones that the AI should respond with. Examples: ['friendly', 'professional', 'urgent']

​
context
string
required

The context in which the suggestion will be used.

Response

​
suggestions
object[]
required

The suggestions generated by AI by tones.