Skip to main content
This page describes how to use custom output rendering to visualize outputs from experiments using your own custom HTML pages. You’ll learn how to:

​
Overview

By default, LangSmith displays outputs in a standard JSON format. With custom output rendering, you can replace this default view with your own HTML page that receives the output data via the postMessage API and renders it however you choose. This is particularly useful for:
  • Domain-specific formatting: Display medical records, legal documents, or other specialized data types in their native format.
  • Custom visualizations: Create charts, graphs, or diagrams from numeric or structured output data.
Custom rendering is configured per-dataset.

​
Prerequisites

  • A LangSmith dataset
  • A web page that can receive postMessage events (can be hosted anywhere or run locally)
  • Basic knowledge of HTML/JavaScript and the postMessage API

​
Configure custom output rendering

​
In the LangSmith UI

To configure custom output rendering for a dataset: Dataset page with three-dot menu showing Custom Output Rendering option
  1. Navigate to your dataset in the Datasets & Experiments page.
  2. Click ⋮ (three-dot menu) in the top right corner.
  3. Select Custom Output Rendering.
  4. Toggle Enable custom output rendering.
  5. Enter the webpage URL in the URL field.
  6. Click Save.
Custom Output Rendering modal with fields filled in

​
Via the API

You can also configure custom rendering programmatically by updating the dataset metadata: 
from langsmith import Client

client = Client()

# Update dataset metadata with iframe config
client.update_dataset(
    dataset_id="your-dataset-id",
    metadata={
        "iframe_config": {
            "enabled": True,
            "url": "https://your-domain.com/output-renderer.html"
        }
    }
)

​
Build a custom renderer

​
Understand the message format

Your HTML page will receive output data via the postMessage API. LangSmith sends messages with the following structure: 
{
  type: "output" | "reference",
  data: {
    // The outputs (actual output or reference output)
    // Structure varies based on your application
  },
  metadata: {
    inputs: {
      // The inputs that generated this output
      // Structure varies based on your application
    }
  }
}
  • type: Indicates whether this is an actual output ("output") or a reference output ("reference").
  • data: The output data itself.
  • metadata.inputs: The input data that generated this output, provided for context.
Message delivery timing: LangSmith uses an exponential backoff retry mechanism to ensure your page receives the data even if it loads slowly. Messages are sent up to 6 times with increasing delays (100ms, 200ms, 400ms, 800ms, 1600ms, 3200ms).

​
Example implementation

This example listens for incoming postMessage events and displays them on the page. Each message is numbered and formatted as JSON, making it easy to inspect the data structure LangSmith sends to your renderer. 
<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
    <title>PostMessage Echo</title>
    <link rel="stylesheet" href="https://unpkg.com/sakura.css/css/sakura.css" />
  </head>
  <body>
    <h1>PostMessage Messages</h1>
    <div id="messages"></div>
    <script>
      let count = 0;
      window.addEventListener("message", (event) => {
        count++;
        const header = document.createElement("h3");
        header.appendChild(document.createTextNode(`Message ${count}`));
        const code = document.createElement("code");
        code.appendChild(
          document.createTextNode(JSON.stringify(event.data, null, 2))
        );
        const pre = document.createElement("pre");
        pre.appendChild(code);
        document.getElementById("messages").appendChild(header);
        document.getElementById("messages").appendChild(pre);
      });
    </script>
  </body>
</html>

​
Where custom rendering appears

When enabled, your custom rendering will replace the default output view in:
  • Experiment comparison view: When comparing outputs across multiple experiments:
Experiment comparison view showing custom rendering
  • Run detail panes: When viewing runs that are associated with a dataset:
Run detail pane showing custom rendering
  • Annotation queues: When experiments are added to annotation queues for review:
Annotation queue showing custom rendering
Edit the source of this page on GitHub.
Connect these docs programmatically to Claude, VSCode, and more via MCP for real-time answers.