Miira · leads y WhatsApp v1 solo lectura
miira.
Lee cómo está configurado hoy el agente de ventas: su persona, el guion en orden con lo que guarda y puntúa cada pregunta, las etapas del embudo, las respuestas de referencia, los documentos que se piden por tipo de cliente y los hitos. Con configured: false el workspace sigue con la configuración de demostración. No cambia nada.
Última actualización
POST /api/v1/reads/miira.agent_config_get- Alcance del token
miira.agent_config_get@1- Permiso del workspace
api.miira.agent_config_getapagado por defecto- Quién lee
- La persona detrás del token, con su rol. Quien deja el workspace deja de leer.
Un token con ese alcance, que el dueño del workspace haya encendido la lectura, y que el rol de la persona la vea en el producto. Ninguna basta sola. Solo con OAuth →
Petición
Sin campos.
Respuesta — output cuando status es done
| campo | tipo | reglas | |
|---|---|---|---|
configured | boolean | obligatorio | |
persona | object | null | obligatorio | |
script | object[] | obligatorio | |
stages | object[] | obligatorio | |
responses | object[] | obligatorio | |
documents | object[] | obligatorio | |
milestones | object[] | obligatorio |
persona
| campo | tipo | reglas | |
|---|---|---|---|
name | string | obligatorio | |
role | string | obligatorio | |
business | string | obligatorio | |
tone | string | obligatorio | |
language | string | obligatorio |
script[]
| campo | tipo | reglas | |
|---|---|---|---|
position | integer | obligatorio | ≥ 1 |
question | string | obligatorio | |
field | string | null | obligatorio | |
kind | "capture" | "qualify" | obligatorio | |
points | integer | obligatorio | |
required | boolean | obligatorio | |
atClose | boolean | obligatorio | |
options | string[] | null | obligatorio | |
optionsByGroup | map<string, string[]> | null | obligatorio | |
onlyIf | object | null | obligatorio |
onlyIf
| campo | tipo | reglas | |
|---|---|---|---|
field | string | obligatorio | |
value | string | obligatorio |
stages[]
| campo | tipo | reglas | |
|---|---|---|---|
name | string | obligatorio | |
fromPoints | integer | obligatorio | |
toPoints | integer | obligatorio | |
qualified | boolean | obligatorio |
responses[]
| campo | tipo | reglas | |
|---|---|---|---|
when | string | obligatorio | |
text | string | obligatorio |
documents[]
| campo | tipo | reglas | |
|---|---|---|---|
clientType | string | obligatorio | |
document | string | obligatorio | |
points | number | obligatorio | |
optional | boolean | obligatorio |
milestones[]
| campo | tipo | reglas | |
|---|---|---|---|
name | string | obligatorio | |
markedWhen | "required_questions" | "document" | "manual" | obligatorio |
Ejemplo
# Reads take an OAuth access token, not an API key, and no idempotency key: reading changes nothing.
curl -X POST https://niiko.org/api/v1/reads/miira.agent_config_get \
-H "Authorization: Bearer $NIIKO_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
# 200 → done · 4xx → refused, with a named reasonPor qué puede negarse
Cada motivo dice quién puede arreglarlo y cómo; detail.message, cuando viene, dice qué hacer. Negativas y códigos HTTP →
invalid_inputrole_forbiddengrant_offreads_need_a_person
En los clientes
| @vorluno/niiko-sdk | niiko.getAgentConfig() |
| niiko (Python) | niiko.get_agent_config() desde 0.4.0 · aún no está en el registro |
| niiko-cli | niiko read miira.agent_config_get |
| n8n-nodes-niiko | Sin lecturas: el nodo lleva una llave, y leer pide una persona por OAuth. |
| niiko-mcp-server | miira_agent_config_get readOnlyHint |