Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.msgflash.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET /api/v1/instances/{id}/health

​
Parameters path

NomTypeRequiredDescription
idUUIDyesID de l’instance

​
Success response 200

{
  "data": {
    "instanceId": "inst_uuid",
    "safetyState": "warming",
    "safetyScore": 56,
    "firstConnectedAt": "2026-04-10T08:00:00.000Z",
    "warmupPolicy": {
      "state": "warming",
      "instanceAgeDays": 1.4,
      "hourlyOutboundCap": 25,
      "dailyOutboundCap": 100,
      "hourlyUniqueRecipientsCap": 25,
      "dailyUniqueRecipientsCap": 100,
      "maxCampaignRecipients": 100,
      "maxColdRatio": 0.4
    },
    "usageWindowSummary": {
      "outbound1h": 4,
      "outbound24h": 18,
      "uniqueRecipients1h": 4,
      "uniqueRecipients24h": 16,
      "inboundReplies24h": 2,
      "inboundReplies7d": 3
    },
    "recommendations": [
      "Start with previously engaged contacts before scaling volume."
    ]
  }
}

​
États possibles

ÉtatDescription
newInstance très récente, warmup initial
warmingWarmup en cours
stableInstance plus mature
at_riskSignaux récents plus risqués
restrictedRisque élevé détecté
Cette V1 retourne uniquement de la guidance. Elle ne bloque pas directement les envois.

​
Common errors

HTTPCodeWhen
404NOT_FOUNDInstance does not exist or is outside your account