Returns
Returns aTestConnectionResult object containing:
success(bool): Whether the test request succeeded.status_code(int): The HTTP status code returned by the endpoint.latency(float): Round-trip latency in milliseconds.response(any): The raw response body from the endpoint.error(string | None): Error message if the request failed.extracted_output(dict | None): Values extracted viaoutput_mapping, if provided.extraction_error(string | None): Error message if extraction failed.
Modes
This method can be called in two ways: With an existing connection ID — the stored connection is used as a base and any provided fields act as overrides:Parameters
ID of an existing endpoint connection to test. When provided, stored connection data is used as the base and remaining fields act as overrides.
The endpoint URL to test. For multi-step session lifecycles, supports a
{{ session_id }} placeholder (requires an INITIALIZATION endpoint).HTTP method. Valid values:
GET, POST, PUT, PATCH, DELETE.Input template with Jinja2 placeholders. See Input Template.
Authentication type. Valid values:
NONE, BEARER, API_KEY, BASIC.Authentication token.
Username for
BASIC authentication.Password for
BASIC authentication.Custom headers. Supports credential placeholders (e.g.,
{{ bearer_token }}, {{ api_key }}). See Custom Headers.Output mapping using JSONPath expressions. See Output Mapping.
Endpoint connection type. Valid values:
INITIALIZATION, CONVERSATION, FINALIZATION.
CONVERSATION is required for all products. INITIALIZATION and FINALIZATION are only needed
for complex session management.Request timeout in seconds.
All fields except
id default to PydanticUndefined (from pydantic_core).
Omit a field (or pass PydanticUndefined) to exclude it from the test request.
Pass None to explicitly send null — useful to override a stored value when testing with an existing connection ID.
Pass a value to include it.