Skip to Content

RPC_CALL and RPC_RESPONSE

Client → server: RPC_CALL

{ "type": "RPC_CALL", "requestId": "string", "fnKey": "ClassName.methodName", "args": [] }
  • args is a positional array; length must match the catalog entry’s params.length.
  • File parameters use JSON-safe placeholders — see File uploads.

Server → client: RpcResponse

Typed in code as RpcResponse. Important fields:

FieldDescription
typeAlways 'RPC_RESPONSE'.
requestIdEcho from the call.
fnKeyEcho from the call.
status'ok' or 'error'.
resultJSON-safe payload on success; null on error.
returnTypeDeclared or inferred return type string; 'error' when failed.
returnShapeStructural shape string on success; null on error.
labelActive Return label, synthetic error label, or timeout/serialization label.
durationHuman-readable timing string.
errorRpcErrorDetail or null.
artifactsOptional array of RpcArtifactRef (protocol v7+).

RpcArtifactRef

Extensible object with required kind and optional uploadUrl, objectKey, expiresAt, plus additional keys for host-specific metadata.

See also