This section is a pure reference — exhaustive signatures, parameters, return values, and semantics for every public API across every Bitfab SDK. No narrative, no “how to use”, no walkthroughs. For tutorials and getting started, see the individual SDK guides: TypeScript, Python, Ruby, Go.Documentation Index
Fetch the complete documentation index at: https://docs.bitfab.ai/llms.txt
Use this file to discover all available pages before exploring further.
Pages
- TypeScript SDK Reference —
bitfabnpm package - Python SDK Reference —
bitfab-pyPyPI package - Ruby SDK Reference —
bitfabRubyGem - Go SDK Reference —
github.com/Project-White-Rabbit/bitfab-gomodule - Span Types — common
SpanTypeenum - HTTP Endpoints — trace ingestion and lookup endpoints the SDKs call
Framework Integrations
Per-framework signatures (handlers, processors, wrappers) are documented in the Frameworks section. Language-specific signatures are mirrored in each SDK reference’s Framework Integrations subsection.| Framework | TypeScript reference | Python reference | Ruby | Go |
|---|---|---|---|---|
| LangGraph / LangChain | getLangGraphCallbackHandler | get_langgraph_callback_handler | — | — |
| OpenAI Agents SDK | getOpenAiTracingProcessor | get_openai_tracing_processor | — | — |
| BAML | wrapBAML | wrap_baml | — | — |
| Claude Agent SDK | getClaudeAgentHandler | get_claude_agent_handler | — | — |
Invariants Across SDKs
Behavior that is guaranteed to match across all SDKs:| Invariant | Behavior |
|---|---|
| Empty / missing API key | Tracing disabled, warning logged, wrapped functions still execute, no spans sent, no errors thrown |
enabled: false | Same as above — wrapped functions pass through unwrapped |
| Span dispatch | Fire-and-forget. Errors in span transport never propagate to host code |
| Nested spans | Child spans inherit traceId; parent-child relationships tracked via context |
| Trace ID | UUID v4. Generated at root span, inherited by descendants |
| Span ID | UUID v4. Unique per span |
| Root span | The outermost span in a call tree. Emits trace completion signal when it ends |
| Errors in user code | Captured on the span (error field) then re-raised/re-thrown |
Default serviceUrl | https://bitfab.ai |
Default span type | "custom" |
addContext | Each call appends one entry. Multiple calls accumulate |
setPrompt | Last write wins. Calling outside a span is a no-op |
setSessionId | Stored as a DB column on the trace. Filterable in dashboard |
setMetadata | Merges with existing metadata. Later values win per-key |