API Reference

This article focuses on the endpoints most relevant to new telemetry and process datasheet implementations.

Base assumptions

Requests are sent over HTTPS.
JSON payloads use Content-Type: application/json.
Responses should be inspected for both HTTP status and JSON error details.

Primary ingest endpoint

Endpoint	Method	Purpose
/api/v1/ingest	POST	Primary process telemetry ingest route used to create or update datasheet-backed process information from JSON payloads.

Example request

fetch('/api/v1/ingest', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'X-Api-Key': ''
  },
  body: JSON.stringify(payload)
});

Authentication

Toro Pulse ingest is authenticated with a tenant-scoped X-Api-Key header. The server resolves the tenant from the API key before the payload is trusted. The payload Company value must also match the Toro Pulse organization configured for that tenant.

Expected request shape

The current build expects a telemetry envelope. The most important requirement is that the payload include a Telemetry object when using the ingestion flow built around automation telemetry.

{
  "Telemetry": {
    "Company": "Example Org",
    "Process": "Example Process",
    "SessionID": "GUID",
    "TimestampUtc": "2026-04-01T15:30:00Z"
  }
}

Common response patterns

Status	Meaning	Recommended action
200 / 201	Payload accepted and processed.	Record the response body and confirm the datasheet renders expected values.
400	Validation failure, malformed JSON, or missing required fields.	Inspect the error object and compare the request to the starter templates.
401 / 403	Unauthorized or forbidden.	Validate the tenant-scoped API key, confirm the payload organization matches the Toro Pulse organization, and verify the request is targeting the correct environment.
500	Unhandled application or schema error.	Check logs, database/schema alignment, and troubleshooting guidance.