DEVELOPERS

API Documentation

TSME-128D exposes a REST API. All endpoints require the x-api-key header and respect your plan limits.

Authentication

All authenticated requests are identified by the x-api-key header. This key uniquely identifies the user, their plan, and applicable limits. Do not send user credentials in the body: the server derives them from the API key.

Headers:
  Content-Type: application/json
  x-api-key:    tsme_xxxxxxxxxxxxxxxxxxxxxxxx

⚠ Keep your API key out of public client code. Use it only from your own backends or protected environments.

Versioning

Current stable endpoint: /api/analisis/json.

Next version: /api/v1/analyze — same semantics with a versioned contract. Breaking changes only in major versions with 90-day transition.

POST /api/analisis/json

Main endpoint: send tabular data and receive the full structural analysis.

REQUEST

POST /api/analisis/json
Headers:
  Content-Type: application/json
  x-api-key:    <your-api-key>

Body:
{
  "data": [
    { "temp": 20.1, "pressure": 1013, "flow": 50.2 },
    { "temp": 20.3, "pressure": 1014, "flow": 49.8 },
    ...
  ],
  "nombre":   "my-dataset",
  "language": "en"
}

RESPONSE 200

{
  "request_id": "01J9FZ...",
  "mode": "dynamic",
  "global": {
    "regime":      "S1",
    "regime_name": "Stable",
    "risk_level":  "LOW",
    "n_variables": 3
  },
  "domains":             [...],
  "dominant_domains":    [...],
  "coupling_matrix":     [...],
  "temporal_domains":    {...},
  "system_breakdown":    {...},
  "systemic_risk_vector":{...},
  "recommended_action":  {
    "priority":         "low",
    "summary":          "...",
    "specific_actions": [...]
  },
  "benchmark": {...},
  "insights":  [...]
}

API quotas by plan (monthly)

FREE: no API access (web upload only).
PROFESSIONAL: 1,000 calls / month · 50 analyses / month.
PREMIUM: 100,000 calls / month · 1,000 analyses / month.

Quotas reset at the start of each UTC month. When exceeded: 429 response with current cap details.

Input limits by plan

Max file size: FREE 50 MB · PROFESSIONAL 500 MB · PREMIUM/ENTERPRISE 5 GB.
Max variables: FREE 20 · PROFESSIONAL 100 · PREMIUM 150 · ENTERPRISE 200.
Max rows: FREE 500 · PROFESSIONAL 1,000 · PREMIUM 2,000 · ENTERPRISE 10,000.
Temporal recommendation: ≥40 rows for dynamic analysis (with S0-S5 regime evolution over time).

Global metrics

Coherence: structural stability. Close to 1 = high cohesion.
Entropy: informational dispersion.
Anomaly: global rupture indicator. Baseline ≈ 1.

Regimes S0–S5

S0 — Static: no significant dynamics.
S1 — Stable: high coherence, normal micro-fluctuations.
S2 — Self-organization: system reconfigures its structure.
S3 — Instability: declining coherence.
S4 — Critical point: trajectory may bifurcate.
S5 — Systemic rupture: immediate intervention required.

Error format

{
  "error":       "rate_limit_exceeded",
  "detail":      "You have exceeded the request limit.",
  "request_id":  "01J9FZ...",
  "retry_after": 3600
}

Common error codes

400 invalid_request — Malformed body.
401 missing_api_key — Missing x-api-key header.
403 invalid_api_key — Invalid key or insufficient plan.
413 file_too_large — File exceeds plan limit.
429 rate_limit_exceeded — Exceeds allowed requests.
503 service_unavailable — Maintenance.

Support

Questions? Contact us including the request_id.