External Links

Attach links to test results so you can quickly jump to related traces, logs, or dashboards when investigating failures.

When Voxli runs tests via GitHub it will automatically add a link to the GitHub run on each test.

Adding Links

You can add external links when creating a test result, or update them later.

# Add external links when creating a test result
result = requests.post(
    f"{base_url}/test-results/",
    headers={"Authorization": f"Bearer {api_key}"},
    json={
        "test": test_id,
        "run": run_id,
        "agent": agent_id,
        "externalLinks": [
            {"name": "Trace", "url": "https://your-tracing-tool.com/trace/abc123"},
            {"name": "Logs", "url": "https://your-logging-tool.com/logs?session=abc123"},
        ]
    }
)

# Or add them later by updating the test result
requests.patch(
    f"{base_url}/test-results/{result_id}",
    headers={"Authorization": f"Bearer {api_key}"},
    json={
        "externalLinks": [
            {"name": "Trace", "url": "https://your-tracing-tool.com/trace/abc123"},
            {"name": "Logs", "url": "https://your-logging-tool.com/logs?session=abc123"},
        ]
    }
)