VocalDocscontracts 1.65.0

ToolTestResult

The answer of a Tool test (1.49.0): one real, signed request through the egress guard, with its status and measurements. The test writes an Audit event and no Call event.

An object with 13 fields.

Fields

FieldTypeRequiredDescription
attemptsintegeryesRequests sent: 1, up to 3 with the retries of an idempotent Tool, or 0 when refused before sending.
elapsed_msintegeryesFrom the first resolution to the result, a measurement of this request.
error_codeToolErrorCode or nullyesNull when status is ok.
http_statusinteger or nullyesThe status of the last response, or null when none arrived.
object"tool_test_result"yes
redirectsintegeryesRedirects followed.
response_bytesinteger or nullyesThe body bytes read, at most the response cap; null when no response arrived.
resultany or nullyesThe result as the model would receive it: the parsed body truncated to 8 KiB, or null on a failure. Content of the customer's own endpoint, returned to the caller of the test only.
signedbooleanyesTrue when the request carried Vocal-Signature under the Organization's tool signing secret.
statusToolCallStatusyes
tested_atTimestampyes
tool_idToolIdyes
tool_revisionintegeryesThe revision that was tested.

Used by

The operations whose parameters, request body or responses name this shape directly.