OpenAI Proxy API

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.

​

Setup

1. Obtain API Keys:
   • Get an API key from your WhyOps Dashboard.
   • Add your OpenAI API key in the Providers section of the WhyOps Dashboard.
2. Configure SDK:

import OpenAI from 'openai';

const openai = new OpenAI({
  apiKey: process.env.WHYOPS_API_KEY, // Your WhyOps API Key
  baseURL: 'https://proxy.whyops.com/v1', // The WhyOps Proxy URL
  defaultHeaders: {
    'X-Agent-Name': 'customer-support-agent' // Required: Identifies the agent
  }
});

// Proceed as normal
const completion = await openai.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'What is the status of my order?' }],
});

import os
from openai import OpenAI

client = OpenAI(
  api_key=os.environ.get("WHYOPS_API_KEY"),
  base_url="https://proxy.whyops.com/v1",
  default_headers={
    "X-Agent-Name": "customer-support-agent"
  }
)

completion = client.chat.completions.create(
  model="gpt-4o",
  messages=[
    {"role": "user", "content": "What is the status of my order?"}
  ]
)

​

Supported Endpoints

• /chat/completions: Standard chat completions, including streaming and tool calling.
• /responses: The newer Responses API format.
• /embeddings: Generating embeddings for text.
• /models: Listing available models (proxies to OpenAI to verify your credentials).

​

Required and optional headers

​

What the proxy adds to responses

• X-Trace-ID
• X-Thread-ID

​

Event pipeline created automatically

1. user_message or tool_result
2. llm_response
3. error if the upstream provider fails
4. embedding_request and embedding_response for /embeddings

​

How WhyOps handles OpenAI Data

1. Invisible Signatures: WhyOps will inject zero-width unicode characters into the content of the assistant’s response. When your agent sends the next message in the conversation, WhyOps strips these characters before forwarding the request to OpenAI.
2. Tool Call Tracing: For non-streaming requests, WhyOps injects a _whyops_trace_id argument into the JSON arguments of tool calls.
3. Streaming Parsing: If you set stream: true, WhyOps uses a custom SSE parser (OpenAIParser) to silently read the stream as it passes through to your application, ensuring no latency is added while still capturing complete telemetry.
4. Provider Resolution: WhyOps resolves the correct upstream provider credentials from your configured provider records based on requested model and environment.
5. Server-Timing: WhyOps adds Server-Timing headers including auth time and total request duration for easier latency debugging.

​

When to add manual events on top

• actual tool execution latency and outputs
• runtime retries not visible to the model
• framework state changes
• app-side failures after an LLM returns a tool call