Skip to content
SONOEDocs
EspañolESConsole

GET /v1/model

The model behind your key, and the question sets it carries for the apps Sonoe was trained for.

GEThttps://api.sonoeai.com/v1/model

curl https://api.sonoeai.com/v1/model \
  -H "Authorization: Bearer $SONOE_API_KEY"

Response

nombrestringrequired
The model's display name, e.g. Sonoe 1.1.
modelostringrequired
The versioned id, e.g. sonoe-1.1.0.
appsmap<string, map<string, Question>>required

Ready-made questions for each app, keyed by app and then by question id. Each one is a native question (type, ask, options) plus ids, which maps each option to that app's own identifier, and the app's own min_confidence when it has one.

{
  "nombre": "Sonoe 1.1",
  "modelo": "sonoe-1.1.0",
  "apps": {
    "cuidarse": {
      "situacion": { "type": "choice", "ask": "¿Qué está pasando?", "options": { "…": "…" }, "ids": { "…": "…" } },
      "categoria": { "…": "…" },
      "urgencia": { "…": "…" }
    },
    "lados": {
      "tipo": { "…": "…" }
    }
  }
}

Today it lists the question sets for Cuidarse and Lados. Use them as they are with /v1/decide, or as examples of well-described options. For the names the model field accepts, use GET /v1/models.