GoodMem
ReferenceAPIREST APIGeneral

Run a single ping probe

Runs a single ping probe and returns the probe result.

POST
/v1/ping:once
x-api-key<token>

In: header

Single ping probe request

targetIdstring

Target resource ID (UUID)

Formatuuid
targetTypeHint?PingTargetType | null

Optional hint for the target resource type

Default"EMBEDDER"
payloadType?PingPayloadType | null

Desired payload type (defaults to provider-specific value)

Default"TEXT"
payload?string | null

Explicit UTF-8 payload to send with the probe (mutually exclusive with payloadSizeBytes)

Default"ping"
payloadSizeBytes?integer | null

Synthetic payload size in bytes (mutually exclusive with payload)

Default64
Formatint32
timeoutMs?integer | null

Per-probe timeout in milliseconds (0 uses server default)

Default5000
Formatint32

Response Body

curl -X POST "http://localhost:8080/v1/ping:once" \  -H "Content-Type: application/json" \  -d '{    "targetId": "550e8400-e29b-41d4-a716-446655440000",    "targetTypeHint": "EMBEDDER",    "payloadType": "TEXT",    "payload": "ping",    "payloadSizeBytes": 64,    "timeoutMs": 5000  }'
{
  "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
  },
  "metadata": {
    "request_id": "abc123"
  }
}
Empty
Empty
Empty
Empty
Empty
Empty
Empty