Miira · leads & WhatsApp v1 read-only
miira.
Reads how the sales agent is configured today: its persona, the script in order with what each question saves and scores, the funnel stages, the reference responses, the documents asked per client type and the milestones. With configured: false the workspace still has the demo setup. Changes nothing.
Last updated
POST /api/v1/reads/miira.agent_config_get- Token scope
miira.agent_config_get@1- Workspace permission
api.miira.agent_config_getoff by default- Who reads
- The person behind the token, with their role. Someone who leaves the workspace stops reading.
A token with that scope, the workspace owner having switched the read on, and the person's role seeing it in the product. None of them is enough alone. OAuth only →
Request
No fields.
Response — output when status is done
| field | type | rules | |
|---|---|---|---|
configured | boolean | required | |
persona | object | null | required | |
script | object[] | required | |
stages | object[] | required | |
responses | object[] | required | |
documents | object[] | required | |
milestones | object[] | required |
persona
| field | type | rules | |
|---|---|---|---|
name | string | required | |
role | string | required | |
business | string | required | |
tone | string | required | |
language | string | required |
script[]
| field | type | rules | |
|---|---|---|---|
position | integer | required | ≥ 1 |
question | string | required | |
field | string | null | required | |
kind | "capture" | "qualify" | required | |
points | integer | required | |
required | boolean | required | |
atClose | boolean | required | |
options | string[] | null | required | |
optionsByGroup | map<string, string[]> | null | required | |
onlyIf | object | null | required |
onlyIf
| field | type | rules | |
|---|---|---|---|
field | string | required | |
value | string | required |
stages[]
| field | type | rules | |
|---|---|---|---|
name | string | required | |
fromPoints | integer | required | |
toPoints | integer | required | |
qualified | boolean | required |
responses[]
| field | type | rules | |
|---|---|---|---|
when | string | required | |
text | string | required |
documents[]
| field | type | rules | |
|---|---|---|---|
clientType | string | required | |
document | string | required | |
points | number | required | |
optional | boolean | required |
milestones[]
| field | type | rules | |
|---|---|---|---|
name | string | required | |
markedWhen | "required_questions" | "document" | "manual" | required |
Example
# 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 reasonWhy it may refuse
Each reason names who can fix it and how; detail.message, when present, says what to do. Refusals & HTTP codes →
invalid_inputrole_forbiddengrant_offreads_need_a_person
In the clients
| @vorluno/niiko-sdk | niiko.getAgentConfig() |
| niiko (Python) | niiko.get_agent_config() from 0.4.0 · not on the registry yet |
| niiko-cli | niiko read miira.agent_config_get |
| n8n-nodes-niiko | No reads: the node holds a key, and reading needs a person through OAuth. |
| niiko-mcp-server | miira_agent_config_get readOnlyHint |