API Activity

Overview

API Activity provides real-time monitoring of your TofuPilot API usage. Track request metrics, response times, and identify failed calls to optimize your integrations.

Monitor API Activity

Track API usage with real-time monitoring. View request metrics, response times, and identify failed calls.

View Key Metrics

Access API Activity from the navigation menu:

• Total Calls: Total API requests made
• Success Rate: Percentage of successful requests
• Avg Response: Average response time in milliseconds
• Deprecated: Count of deprecated API calls

View Request List

Browse all API requests ordered by timestamp. Each request shows endpoint, method, status, and response time.

View Request Trace

Click any request for detailed information:

• Payload: Complete request body
• Method: HTTP method and response status
• Timing: Start time and total duration
• Version: Client version used
• Trace: Request type and messages

View Trace Timeline

Analyze internal processing steps with timing breakdown. Switch between absolute timestamps and relative timing from request start.

Filter Requests

Narrow results using filters:

• Search: Filter by endpoint path or message text
• Method: Show specific HTTP methods (GET, POST, PUT, DELETE)
• Status: Filter by success or error status

API Reference

For programmatic access to TofuPilot services, see our API Reference documentation.

Install Client

Install the TofuPilot client for your environment:

pip install tofupilot openhtf six

pip install tofupilot

dotnet add package TofuPilot

Required Parameters

All API requests require authentication:

• OpenHTF: Pass api_key to TofuPilot constructor
• Python: Pass api_key to TofuPilot constructor or set TOFUPILOT_API_KEY env var
• C#: Pass apiKey to TofuPilot constructor or set TOFUPILOT_API_KEY env var
• REST: Include Authorization: Bearer <api_key> header

from tofupilot.openhtf import TofuPilot

with TofuPilot(test, api_key="your-api-key"):
  test.execute(lambda: "SN001")

from tofupilot.v2 import TofuPilot

# Reads TOFUPILOT_API_KEY from environment, or pass directly
client = TofuPilot(api_key="your-api-key")

using TofuPilot;

// Reads TOFUPILOT_API_KEY from environment, or pass directly
var client = new TofuPilot(apiKey: "your-api-key");

curl -H "Authorization: Bearer your-api-key" \
https://www.tofupilot.app/api/v2/runs