Learn about the render endpoint for previewing chat inputs before sending them to the model
Preview Processing
Template Rendering
Document Retrieval
Tool Configuration
Debugging
recall
parameter).Message Object Structure
This object represents a message in the chat system, detailing the structure and types of data it can hold.
Parameter | Type | Description | Default |
---|---|---|---|
model | str | The model to use for validation (though no actual model call is made). | None |
agent | UUID | Agent ID of the agent to use for this interaction. (Only applicable for multi-agent sessions) | None |
recall | bool | Whether previous memories and docs should be recalled or not. | True |
response_format | str | Response format specification (used for validation only). | None |
temperature | float | Not used in rendering but validated for format. | None |
top_p | float | Not used in rendering but validated for format. | 1.0 |
max_tokens | int | Not used in rendering but validated for format. | None |
stop | list[str] | Not used in rendering but validated for format. | [] |
RenderResponse
object with the following structure:
messages
: The fully processed messages, including rendered templates and system messages.docs
: List of document references that would be used for this request, intended for citation purposes.tools
: The formatted tools that would be available to the model.