Skip to main content

Documentation Index

Fetch the complete documentation index at: https://whyops.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use the trace builder when you want the graph to include application-side runtime work that the provider proxy cannot observe directly.

Quickstart

Start with installation, agent initialization, and your first proxied OpenAI or Anthropic call.

Proxy Helpers

Review the proxy key flow before adding runtime events on top of proxied traffic.

Advanced Patterns

Move there after this page for hybrid flows, self-hosting, and common mistakes.

​
Manual events mode

Use the exact same trace_id here that you pass in X-Trace-ID on proxied OpenAI or Anthropic calls when you want tool events and model events to stay on the same thread. 
trace = sdk.trace("session-123")

trace.user_message_sync(
    [{"role": "user", "content": "Reset my password."}],
    external_user_id="user_12345",
)

span_id = trace.tool_call_request_sync(
    "search_orders",
    [{"name": "search_orders", "arguments": {"orderId": "123"}}],
    latency_ms=11,
)

trace.tool_call_response_sync(
    "search_orders",
    span_id,
    [{"name": "search_orders", "arguments": {"orderId": "123"}}],
    {"status": "shipped"},
    latency_ms=88,
)

trace.llm_response_sync(
    "openai/gpt-4o-mini",
    "openai",
    "Your order has shipped.",
    finish_reason="stop",
    latency_ms=390,
    usage={"promptTokens": 42, "completionTokens": 16, "totalTokens": 58},
)

​
Linking events to users

Use external_user_id to associate events with your application user IDs: 
trace.user_message_sync(
    [{"role": "user", "content": "Reset my password."}],
    external_user_id="user_12345",
)
The external_user_id is stored on every event and trace, allowing you to filter and analyze traces by your own user identifiers.

​
Prompt caching usage

await trace.llm_response(
    "anthropic/claude-sonnet-4-5",
    "anthropic",
    "Done.",
    usage={
        "promptTokens": 1200,
        "completionTokens": 240,
        "totalTokens": 9940,
        "cacheReadTokens": 8200,
        "cacheCreationTokens": 300,
    },
    latency_ms=860,
)
Use cacheReadTokens and cacheCreationTokens when your runtime exposes cache-aware usage so the trace cost breakdown stays accurate.

​
Method map

Sync methodAsync methodPurpose
user_message_sync()user_message()Log assembled user or system-facing messages
llm_response_sync()llm_response()Log model output, finish reason, usage, and latency
llm_thinking_sync()llm_thinking()Log explicit reasoning blocks
embedding_request_sync()embedding_request()Log embedding inputs
embedding_response_sync()embedding_response()Log embedding result summary
tool_call_request_sync()tool_call_request()Start a tool call span and return span_id
tool_call_response_sync()tool_call_response()Close the tool call span
tool_result_sync()tool_result()Record tool output returned to the model
error_sync()error()Record runtime or provider failures

​
Hybrid pattern

trace_id = "checkout-8841"
client = sdk.openai(OpenAI(api_key="YOUR_WHYOPS_API_KEY"))
client.default_headers = {
    **(client.default_headers or {}),
    "X-Trace-ID": trace_id,
    "X-Thread-ID": trace_id,
}
trace = sdk.trace(trace_id)

span_id = trace.tool_call_request_sync(
    "charge_card",
    [{"name": "charge_card", "arguments": {"amount": 4999, "currency": "usd"}}],
)

result = charge_card()

trace.tool_call_response_sync(
    "charge_card",
    span_id,
    [{"name": "charge_card", "arguments": {"amount": 4999, "currency": "usd"}}],
    result,
)
Use this when you want automatic provider capture from the proxy and explicit application-side timing for tools, jobs, queues, and failures.