Stream ping probe results
Opens a streaming ping session and returns per-probe results plus a terminal summary. Supports SSE (text/event-stream) and NDJSON (application/x-ndjson) formats.
In: header
Header Parameters
Response format: 'text/event-stream' for Server-Sent Events or 'application/x-ndjson' for newline-delimited JSON
Ping stream configuration
Target resource ID (UUID)
uuidOptional hint for the target resource type
"EMBEDDER"Number of probes to run (0 uses server default)
4int32Delay between probes in milliseconds (0 uses server default)
1000int32Per-probe timeout in milliseconds (0 uses server default)
5000int32Desired payload type (defaults to provider-specific value)
"TEXT"Explicit UTF-8 payload to send with each probe (mutually exclusive with payloadSizeBytes)
"ping"Synthetic payload size in bytes (mutually exclusive with payload)
64int32Maximum concurrent probes (defaults to 1)
1int32Add jitter to probe scheduling
falseOptional labels to attach to the ping session
{"origin":"console"}properties <= 20Empty Object
Response Body
curl -X POST "http://localhost:8080/v1/ping:stream" \ -H "Accept: application/x-ndjson" \ -H "Content-Type: application/json" \ -d '{ "targetId": "550e8400-e29b-41d4-a716-446655440000", "targetTypeHint": "EMBEDDER", "count": 4, "intervalMs": 1000, "timeoutMs": 5000, "payloadType": "TEXT", "payload": "ping", "payloadSizeBytes": 64, "maxInFlight": 1, "jitter": false, "labels": { "origin": "console" } }'{
"result": {
"endpoint": {
"targetType": "EMBEDDER",
"targetId": "550e8400-e29b-41d4-a716-446655440000",
"resolvedEndpoint": "https://api.openai.com/v1/embeddings",
"provider": "OPENAI",
"modelIdentifier": "text-embedding-3-small"
},
"seq": 1,
"bytesSent": 64,
"bytesReceived": 64,
"ok": true,
"httpStatus": 200,
"errorMessage": "Probe exceeded timeout of 5000 ms",
"rttMs": 123.4,
"timing": {
"clientSendTimeUnixNanos": 1712082300123456800,
"serverReceivedTimeUnixNanos": 1712082301123456800,
"serverSendTimeUnixNanos": 1712082302123456800,
"clientReceiveTimeUnixNanos": 1712082303123456800
}
}
}