> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pandaprobe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# TypeScript SDK

> Public imports, classes, functions, options, and data contracts for the TypeScript package

The `pandaprobe` package includes tracing, native platform access, and opt-in Reflect. This reference lists the public imports and their complete source-declared signatures, options, and fields. For a first integration, start with [Trace](https://docs.pandaprobe.com/tracing/get-started/quickstart.md) or [Reflect](https://docs.pandaprobe.com/reflect/quickstart.md).

```bash theme={null}
npm install pandaprobe
# or
yarn add pandaprobe
# or
pnpm add pandaprobe
```

The core package supports Node.js 18+ and ESM/CommonJS. Optional framework and native Reflect dependencies may require a newer runtime; the native Reflect examples use Node.js 22+. Import only documented package subpaths.

## Find an API

| Area | Reference |
| - | - |
| [Client](https://docs.pandaprobe.com/reference/typescript/client.md) | Initialize tracing, submit traces and scores, and manage export lifecycle |
| [Configuration](https://docs.pandaprobe.com/reference/typescript/configuration.md) | Tracing credentials, environment settings, and resolved client options |
| [Tracing and context](https://docs.pandaprobe.com/reference/typescript/tracing.md) | Decorators, trace and span contexts, session propagation, and trace capture |
| [Trace data](https://docs.pandaprobe.com/reference/typescript/data.md) | Trace, span, score, and message contracts |
| [Provider wrappers](https://docs.pandaprobe.com/reference/typescript/wrappers.md) | Instrument provider clients while preserving their native calls and results |
| [Framework integrations](https://docs.pandaprobe.com/reference/typescript/integrations.md) | Callbacks, adapters, and native agent tracing hooks |
| [Platform client](https://docs.pandaprobe.com/reference/typescript/platform-client.md) | Read persisted traces and create or poll evaluation runs |
| [Platform models](https://docs.pandaprobe.com/reference/typescript/platform-models.md) | Typed trace evidence, evaluation runs, metrics, and scores |
| [Platform errors](https://docs.pandaprobe.com/reference/typescript/platform-errors.md) | Distinguish failed requests, deadlines, insufficient evidence, and uncertain creation |
| [Reflect runtime](https://docs.pandaprobe.com/reference/typescript/reflect-runtime.md) | Run the agent, evaluate evidence, continue reflection, and inspect outcomes |
| [Reflect configuration](https://docs.pandaprobe.com/reference/typescript/reflect-config.md) | Workspace, evaluation, shell, context, and validation options |
| [Execution and invocation](https://docs.pandaprobe.com/reference/typescript/reflect-execution.md) | Execution boundaries, attribution, active memory, and host callbacks |
| [Replay and validation](https://docs.pandaprobe.com/reference/typescript/reflect-validation.md) | Independent outcomes, paired replay, controlled trials, and acceptance |
| [Rules and results](https://docs.pandaprobe.com/reference/typescript/reflect-models.md) | Persistent rules, proposals, notices, reports, and validation records |

## Reading the contracts

Signatures and field tables are generated from the SDK source. Defaults are shown where declared; an instance property without a declared default is not necessarily a constructor input. Framework callbacks are shown for completeness and are normally called by the framework. Helper types used by an API are identified when they are not separately exported.

This reference covers package APIs and their supporting contracts, not private transport workers, workspace mutation internals, or third-party SDK methods. Source links identify the exact code snapshot used to generate each entry. See the HTTP API reference for the complete server endpoint surface.

## Public import index

| Import path | Export | Details |
| - | - | - |
| `pandaprobe` | `Client` | [Client](https://docs.pandaprobe.com/reference/typescript/client.md#client) |
| `pandaprobe` | `ConfigOptions` | [ConfigOptions](https://docs.pandaprobe.com/reference/typescript/configuration.md#configoptions) |
| `pandaprobe` | `ScoreData` | [ScoreData](https://docs.pandaprobe.com/reference/typescript/data.md#scoredata) |
| `pandaprobe` | `ScoreDataType` | [ScoreDataType](https://docs.pandaprobe.com/reference/typescript/data.md#scoredatatype) |
| `pandaprobe` | `SdkConfig` | [SdkConfig](https://docs.pandaprobe.com/reference/typescript/configuration.md#sdkconfig) |
| `pandaprobe` | `SpanContext` | [SpanContext](https://docs.pandaprobe.com/reference/typescript/tracing.md#spancontext) |
| `pandaprobe` | `SpanContextOptions` | [SpanContextOptions](https://docs.pandaprobe.com/reference/typescript/tracing.md#spancontextoptions) |
| `pandaprobe` | `SpanData` | [SpanData](https://docs.pandaprobe.com/reference/typescript/data.md#spandata) |
| `pandaprobe` | `SpanDecoratorOptions` | [SpanDecoratorOptions](https://docs.pandaprobe.com/reference/typescript/tracing.md#spandecoratoroptions) |
| `pandaprobe` | `SpanKind` | [SpanKind](https://docs.pandaprobe.com/reference/typescript/data.md#spankind) |
| `pandaprobe` | `SpanStatusCode` | [SpanStatusCode](https://docs.pandaprobe.com/reference/typescript/data.md#spanstatuscode) |
| `pandaprobe` | `TraceCapture` | [TraceCapture](https://docs.pandaprobe.com/reference/typescript/tracing.md#tracecapture) |
| `pandaprobe` | `TraceCaptureOptions` | [TraceCaptureOptions](https://docs.pandaprobe.com/reference/typescript/tracing.md#tracecaptureoptions) |
| `pandaprobe` | `TraceContext` | [TraceContext](https://docs.pandaprobe.com/reference/typescript/tracing.md#tracecontext) |
| `pandaprobe` | `TraceContextOptions` | [TraceContextOptions](https://docs.pandaprobe.com/reference/typescript/tracing.md#tracecontextoptions) |
| `pandaprobe` | `TraceData` | [TraceData](https://docs.pandaprobe.com/reference/typescript/data.md#tracedata) |
| `pandaprobe` | `TraceDecoratorOptions` | [TraceDecoratorOptions](https://docs.pandaprobe.com/reference/typescript/tracing.md#tracedecoratoroptions) |
| `pandaprobe` | `TraceStatus` | [TraceStatus](https://docs.pandaprobe.com/reference/typescript/data.md#tracestatus) |
| `pandaprobe` | `VERSION` | [VERSION](https://docs.pandaprobe.com/reference/typescript/client.md#version) |
| `pandaprobe` | `WithSpanOptions` | [WithSpanOptions](https://docs.pandaprobe.com/reference/typescript/tracing.md#withspanoptions) |
| `pandaprobe` | `WithTraceOptions` | [WithTraceOptions](https://docs.pandaprobe.com/reference/typescript/tracing.md#withtraceoptions) |
| `pandaprobe` | `flush` | [flush](https://docs.pandaprobe.com/reference/typescript/client.md#flush) |
| `pandaprobe` | `getClient` | [getClient](https://docs.pandaprobe.com/reference/typescript/client.md#getclient) |
| `pandaprobe` | `getCurrentTrace` | [getCurrentTrace](https://docs.pandaprobe.com/reference/typescript/tracing.md#getcurrenttrace) |
| `pandaprobe` | `getSpanStack` | [getSpanStack](https://docs.pandaprobe.com/reference/typescript/tracing.md#getspanstack) |
| `pandaprobe` | `init` | [init](https://docs.pandaprobe.com/reference/typescript/client.md#init) |
| `pandaprobe` | `score` | [score](https://docs.pandaprobe.com/reference/typescript/client.md#score) |
| `pandaprobe` | `session` | [session](https://docs.pandaprobe.com/reference/typescript/tracing.md#session) |
| `pandaprobe` | `setSession` | [setSession](https://docs.pandaprobe.com/reference/typescript/tracing.md#setsession) |
| `pandaprobe` | `setUser` | [setUser](https://docs.pandaprobe.com/reference/typescript/tracing.md#setuser) |
| `pandaprobe` | `shutdown` | [shutdown](https://docs.pandaprobe.com/reference/typescript/client.md#shutdown) |
| `pandaprobe` | `span` | [span](https://docs.pandaprobe.com/reference/typescript/tracing.md#span) |
| `pandaprobe` | `startTrace` | [startTrace](https://docs.pandaprobe.com/reference/typescript/tracing.md#starttrace) |
| `pandaprobe` | `trace` | [trace](https://docs.pandaprobe.com/reference/typescript/tracing.md#trace) |
| `pandaprobe` | `user` | [user](https://docs.pandaprobe.com/reference/typescript/tracing.md#user) |
| `pandaprobe` | `withSpan` | [withSpan](https://docs.pandaprobe.com/reference/typescript/tracing.md#withspan) |
| `pandaprobe` | `withTrace` | [withTrace](https://docs.pandaprobe.com/reference/typescript/tracing.md#withtrace) |
| `pandaprobe/api` | `ApiDeadlineExceeded` | [ApiDeadlineExceeded](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#apideadlineexceeded) |
| `pandaprobe/api` | `ApiError` | [ApiError](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#apierror) |
| `pandaprobe/api` | `ApiModel` | [ApiModel](https://docs.pandaprobe.com/reference/typescript/platform-models.md#apimodel) |
| `pandaprobe/api` | `AuthenticationError` | [AuthenticationError](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#authenticationerror) |
| `pandaprobe/api` | `CreationOutcomeUnknown` | [CreationOutcomeUnknown](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#creationoutcomeunknown) |
| `pandaprobe/api` | `EvaluationFailed` | [EvaluationFailed](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#evaluationfailed) |
| `pandaprobe/api` | `EvaluationRequest` | [EvaluationRequest](https://docs.pandaprobe.com/reference/typescript/platform-models.md#evaluationrequest) |
| `pandaprobe/api` | `EvaluationResult` | [EvaluationResult](https://docs.pandaprobe.com/reference/typescript/platform-models.md#evaluationresult) |
| `pandaprobe/api` | `EvaluationRun` | [EvaluationRun](https://docs.pandaprobe.com/reference/typescript/platform-models.md#evaluationrun) |
| `pandaprobe/api` | `Evaluations` | [Evaluations](https://docs.pandaprobe.com/reference/typescript/platform-client.md#evaluations) |
| `pandaprobe/api` | `InsufficientEvidence` | [InsufficientEvidence](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#insufficientevidence) |
| `pandaprobe/api` | `InvalidResponseError` | [InvalidResponseError](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#invalidresponseerror) |
| `pandaprobe/api` | `Metric` | [Metric](https://docs.pandaprobe.com/reference/typescript/platform-models.md#metric) |
| `pandaprobe/api` | `NotFoundError` | [NotFoundError](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#notfounderror) |
| `pandaprobe/api` | `PlatformClient` | [PlatformClient](https://docs.pandaprobe.com/reference/typescript/platform-client.md#platformclient) |
| `pandaprobe/api` | `PlatformError` | [PlatformError](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#platformerror) |
| `pandaprobe/api` | `PlatformOptions` | [PlatformOptions](https://docs.pandaprobe.com/reference/typescript/platform-client.md#platformoptions) |
| `pandaprobe/api` | `RateLimitError` | [RateLimitError](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#ratelimiterror) |
| `pandaprobe/api` | `RequestOptions` | [RequestOptions](https://docs.pandaprobe.com/reference/typescript/platform-client.md#requestoptions) |
| `pandaprobe/api` | `Score` | [Score](https://docs.pandaprobe.com/reference/typescript/platform-models.md#score) |
| `pandaprobe/api` | `Span` | [Span](https://docs.pandaprobe.com/reference/typescript/platform-models.md#span) |
| `pandaprobe/api` | `Trace` | [Trace](https://docs.pandaprobe.com/reference/typescript/platform-models.md#trace) |
| `pandaprobe/api` | `TracePage` | [TracePage](https://docs.pandaprobe.com/reference/typescript/platform-models.md#tracepage) |
| `pandaprobe/api` | `TraceSummary` | [TraceSummary](https://docs.pandaprobe.com/reference/typescript/platform-models.md#tracesummary) |
| `pandaprobe/api` | `Traces` | [Traces](https://docs.pandaprobe.com/reference/typescript/platform-client.md#traces) |
| `pandaprobe/api` | `TransportError` | [TransportError](https://docs.pandaprobe.com/reference/typescript/platform-errors.md#transporterror) |
| `pandaprobe/api` | `numericValue` | [numericValue](https://docs.pandaprobe.com/reference/typescript/platform-models.md#numericvalue) |
| `pandaprobe/integrations/claude-agent-sdk` | `AdapterOptions` | [AdapterOptions](https://docs.pandaprobe.com/reference/typescript/integrations.md#adapteroptions) |
| `pandaprobe/integrations/claude-agent-sdk` | `ClaudeAgentSDKAdapter` | [ClaudeAgentSDKAdapter](https://docs.pandaprobe.com/reference/typescript/integrations.md#claudeagentsdkadapter) |
| `pandaprobe/integrations/claude-agent-sdk` | `wrapClaudeAgentQuery` | [wrapClaudeAgentQuery](https://docs.pandaprobe.com/reference/typescript/integrations.md#wrapclaudeagentquery) |
| `pandaprobe/integrations/deepagents` | `AdapterOptions` | [AdapterOptions](https://docs.pandaprobe.com/reference/typescript/integrations.md#adapteroptions) |
| `pandaprobe/integrations/deepagents` | `DeepAgentsCallbackHandler` | [DeepAgentsCallbackHandler](https://docs.pandaprobe.com/reference/typescript/integrations.md#deepagentscallbackhandler) |
| `pandaprobe/integrations/langchain` | `AdapterOptions` | [AdapterOptions](https://docs.pandaprobe.com/reference/typescript/integrations.md#adapteroptions) |
| `pandaprobe/integrations/langchain` | `LangChainCallbackHandler` | [LangChainCallbackHandler](https://docs.pandaprobe.com/reference/typescript/integrations.md#langchaincallbackhandler) |
| `pandaprobe/integrations/langgraph` | `AdapterOptions` | [AdapterOptions](https://docs.pandaprobe.com/reference/typescript/integrations.md#adapteroptions) |
| `pandaprobe/integrations/langgraph` | `LangGraphCallbackHandler` | [LangGraphCallbackHandler](https://docs.pandaprobe.com/reference/typescript/integrations.md#langgraphcallbackhandler) |
| `pandaprobe/integrations/openai-agents` | `AdapterOptions` | [AdapterOptions](https://docs.pandaprobe.com/reference/typescript/integrations.md#adapteroptions) |
| `pandaprobe/integrations/openai-agents` | `OpenAIAgentsAdapter` | [OpenAIAgentsAdapter](https://docs.pandaprobe.com/reference/typescript/integrations.md#openaiagentsadapter) |
| `pandaprobe/integrations/openai-agents` | `TraceProcessor` | [TraceProcessor](https://docs.pandaprobe.com/reference/typescript/integrations.md#traceprocessor) |
| `pandaprobe/integrations/vercel-ai` | `VercelAgentOptions` | [VercelAgentOptions](https://docs.pandaprobe.com/reference/typescript/integrations.md#vercelagentoptions) |
| `pandaprobe/integrations/vercel-ai` | `VercelMiddlewareOptions` | [VercelMiddlewareOptions](https://docs.pandaprobe.com/reference/typescript/integrations.md#vercelmiddlewareoptions) |
| `pandaprobe/integrations/vercel-ai` | `pandaProbeMiddleware` | [pandaProbeMiddleware](https://docs.pandaprobe.com/reference/typescript/integrations.md#pandaprobemiddleware) |
| `pandaprobe/integrations/vercel-ai` | `wrapVercelAgent` | [wrapVercelAgent](https://docs.pandaprobe.com/reference/typescript/integrations.md#wrapvercelagent) |
| `pandaprobe/reflect` | `Agent` | [Agent](https://docs.pandaprobe.com/reference/typescript/reflect-runtime.md#agent) |
| `pandaprobe/reflect` | `AgentOptions` | [AgentOptions](https://docs.pandaprobe.com/reference/typescript/reflect-runtime.md#agentoptions) |
| `pandaprobe/reflect` | `EvaluationOutcome` | [EvaluationOutcome](https://docs.pandaprobe.com/reference/typescript/reflect-models.md#evaluationoutcome) |
| `pandaprobe/reflect` | `Execution` | [Execution](https://docs.pandaprobe.com/reference/typescript/reflect-execution.md#execution) |
| `pandaprobe/reflect` | `ExecutionOptions` | [ExecutionOptions](https://docs.pandaprobe.com/reference/typescript/reflect-execution.md#executionoptions) |
| `pandaprobe/reflect` | `ExecutionReport` | [ExecutionReport](https://docs.pandaprobe.com/reference/typescript/reflect-models.md#executionreport) |
| `pandaprobe/reflect` | `Framework` | [Framework](https://docs.pandaprobe.com/reference/typescript/reflect-runtime.md#framework) |
| `pandaprobe/reflect` | `Invocation` | [Invocation](https://docs.pandaprobe.com/reference/typescript/reflect-execution.md#invocation) |
| `pandaprobe/reflect` | `NativeAgent` | [NativeAgent](https://docs.pandaprobe.com/reference/typescript/reflect-runtime.md#nativeagent) |
| `pandaprobe/reflect` | `Outcome` | [Outcome](https://docs.pandaprobe.com/reference/typescript/reflect-validation.md#outcome) |
| `pandaprobe/reflect` | `Phase` | [Phase](https://docs.pandaprobe.com/reference/typescript/reflect-execution.md#phase) |
| `pandaprobe/reflect` | `ProposalOutcome` | [ProposalOutcome](https://docs.pandaprobe.com/reference/typescript/reflect-models.md#proposaloutcome) |
| `pandaprobe/reflect` | `Reflect` | [Reflect](https://docs.pandaprobe.com/reference/typescript/reflect-runtime.md#reflect) |
| `pandaprobe/reflect` | `ReflectConfig` | [ReflectConfig](https://docs.pandaprobe.com/reference/typescript/reflect-config.md#reflectconfig) |
| `pandaprobe/reflect` | `ReflectInit` | [ReflectInit](https://docs.pandaprobe.com/reference/typescript/reflect-runtime.md#reflectinit) |
| `pandaprobe/reflect` | `ReflectOptions` | [ReflectOptions](https://docs.pandaprobe.com/reference/typescript/reflect-config.md#reflectoptions) |
| `pandaprobe/reflect` | `Replay` | [Replay](https://docs.pandaprobe.com/reference/typescript/reflect-validation.md#replay) |
| `pandaprobe/reflect` | `ReplayCase` | [ReplayCase](https://docs.pandaprobe.com/reference/typescript/reflect-validation.md#replaycase) |
| `pandaprobe/reflect` | `ReplayRequest` | [ReplayRequest](https://docs.pandaprobe.com/reference/typescript/reflect-validation.md#replayrequest) |
| `pandaprobe/reflect` | `ResolvedReflectConfig` | [ResolvedReflectConfig](https://docs.pandaprobe.com/reference/typescript/reflect-config.md#resolvedreflectconfig) |
| `pandaprobe/reflect` | `Rule` | [Rule](https://docs.pandaprobe.com/reference/typescript/reflect-models.md#rule) |
| `pandaprobe/reflect` | `RuleProposal` | [RuleProposal](https://docs.pandaprobe.com/reference/typescript/reflect-models.md#ruleproposal) |
| `pandaprobe/reflect` | `TrialArm` | [TrialArm](https://docs.pandaprobe.com/reference/typescript/reflect-models.md#trialarm) |
| `pandaprobe/reflect` | `TrialCase` | [TrialCase](https://docs.pandaprobe.com/reference/typescript/reflect-models.md#trialcase) |
| `pandaprobe/reflect` | `ValidationVerdict` | [ValidationVerdict](https://docs.pandaprobe.com/reference/typescript/reflect-models.md#validationverdict) |
| `pandaprobe/wrappers/anthropic` | `wrapAnthropic` | [wrapAnthropic](https://docs.pandaprobe.com/reference/typescript/wrappers.md#wrapanthropic) |
| `pandaprobe/wrappers/bedrock` | `wrapBedrock` | [wrapBedrock](https://docs.pandaprobe.com/reference/typescript/wrappers.md#wrapbedrock) |
| `pandaprobe/wrappers/gemini` | `wrapGemini` | [wrapGemini](https://docs.pandaprobe.com/reference/typescript/wrappers.md#wrapgemini) |
| `pandaprobe/wrappers/mistral` | `wrapMistral` | [wrapMistral](https://docs.pandaprobe.com/reference/typescript/wrappers.md#wrapmistral) |
| `pandaprobe/wrappers/openai` | `wrapOpenAI` | [wrapOpenAI](https://docs.pandaprobe.com/reference/typescript/wrappers.md#wrapopenai) |

[Source snapshot](https://github.com/chirpz-ai/pandaprobe-sdk/tree/92d8c37fba00e87ac6f0104cd293990aa5d5e621/libraries/typescript).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.