Ir al contenido

Propone o mejora un texto. Consume créditos y no guarda nada.

POST
/ai-helper/suggest
curl --request POST \
--url https://api.matiasimpulso.com/ai-helper/suggest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "about": "example", "mode": "idea", "text": "example", "maxWords": 80, "context": { "businessDescription": "example", "agentName": "example", "agentRole": "example", "tone": "example", "language": "es" }, "variables": [ "firstName", "ticket_id" ] }'
Media type application/json
object
about
required

Qué es el campo y quién lo lee. Es dato para el modelo, no instrucción.

string
>= 3 characters <= 200 characters
mode
required
string
Allowed values: idea improve
text

Texto a mejorar (obligatorio con mode=improve) o idea de la que partir (mode=idea).

string
<= 2000 characters
maxWords
number
default: 80 >= 10 <= 300
context
object
businessDescription
string
<= 600 characters
agentName
string
<= 60 characters
agentRole
string
<= 80 characters
tone
string
<= 30 characters
language
string
/^[a-z]{2}$/

Example

es
variables

Variables que el campo sustituye al usarse (sin llaves). Únicos marcadores que puede escribir el modelo.

Array<string>
<= 20 items

Example

[
"firstName",
"ticket_id"
]

{ suggestion, truncated }

Petición no válida o usuario sin empresa

Sin créditos o modelo fuera del plan

Requiere perfil de administrador

El modelo rechazó redactar el texto

Demasiadas peticiones seguidas

Asistente no disponible o sin respuesta

El modelo tardó demasiado