AutoGineer
Generated banner for Probe SDK
Generated logo for Probe SDK

Probe SDK

OpenAIOfficialCreated by ZoomDistributed by OpenAI

  • Skill
  • Tool integration
  • Software development
  • MIT
  • No issues found
Download ZIP

From the author

Use when using Probe SDK.
— the description by Zoom

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The Probe SDK provides a structured approach to validating user environments before joining a meeting or video session. It enables developers to perform preflight checks on browser capabilities, hardware devices (camera, microphone, speaker), and network connectivity. By implementing these diagnostics, applications can identify potential issues early, provide actionable feedback to users, and capture telemetry for troubleshooting, ensuring a smoother experience when the actual session begins.

What it does

  • Performs pre-join readiness checks for browser, device, and network compatibility.
  • Supports targeted diagnostics for audio and video hardware.
  • Enables comprehensive network diagnostic testing to assess connection quality.
  • Facilitates the creation of structured diagnostic reports for support and troubleshooting.
  • Allows for the implementation of custom readiness gates to block or warn users based on test results.
  • Provides lifecycle management for initializing, running, and cleaning up diagnostic resources.

When to use it

  • When building a pre-join diagnostic page for Meeting or Video SDK applications.
  • When you need to verify device permissions and hardware availability before starting a session.
  • When implementing a kiosk or controlled environment that requires device certification.
  • When you need to capture structured diagnostic data to assist in customer support workflows.
  • When gating access to advanced media features based on browser capability.

Advantages

  • Lightweight implementation that does not require OAuth credentials.
  • Improves user experience by proactively identifying and resolving environment issues.
  • Reduces support overhead by providing structured diagnostic reports.
  • Flexible integration allows for custom readiness logic and UI feedback.
  • Ensures compatibility by validating browser and device environments before session entry.

Usage examples

“How do I run a basic audio and video diagnostic check?”
The agent will guide you through initializing the Prober, requesting media permissions, and executing the diagnoseAudio and diagnoseVideo methods to verify hardware readiness.
“Can I use this to check network quality before a user joins?”
The agent will explain how to use the startToDiagnose method to run a comprehensive network diagnostic and stream the results to your UI for real-time feedback.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/openai/probe-sdk/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip probe-sdk.zip -d .agents/skills

Documentation by Zoom

Zoom Probe SDK

Use this skill when the app needs readiness checks before a user joins a meeting or video session.

Workflow

  1. Define the preflight gate: browser support, camera, microphone, speaker, network, CPU, or diagnostic report.

  2. Run diagnostics before the Meeting SDK or Video SDK join flow.

  3. Decide whether failed checks should block join, warn the user, or capture support telemetry.

  4. Keep probe results separate from meeting/session tokens and avoid sending unnecessary device details downstream.

  5. Debug by isolating browser permissions, device enumeration, HTTPS requirements, firewall behavior, and unsupported environments.

References

Files

RUNBOOK.md

Probe SDK 5-Minute Preflight Runbook

Use this before deep debugging.

Skill Doc Standard Note

  • Skill entrypoint is SKILL.md.

  • This runbook is an operational convention (recommended), not a required skill file.

  • API/option naming can drift by version; validate against current Probe SDK reference.

1) Confirm Integration Surface

  • Confirm this is a web diagnostics use case, not meeting/session join runtime.

  • Confirm whether you need only device checks, only network checks, or full diagnostics.

  • Confirm renderer target strategy (video-tag or canvas-based renderer).

2) Confirm Required Inputs

  • No Zoom Marketplace credentials are required for core Probe SDK diagnostics.

  • Device IDs are required for explicit audio input/output and camera diagnostics.

  • For comprehensive network diagnostics, verify optional JS/WASM URL override strategy.

3) Confirm Lifecycle Order

  1. requestMediaDevicePermission().

  2. requestMediaDevices().

  3. diagnoseAudio(...) / diagnoseVideo(...).

  4. startToDiagnose(jsUrl, wasmUrl, config, statsListener).

  5. stopToDiagnose* and cleanup() on exit.

4) Confirm Event/State Handling

  • Keep stream lifecycle explicit (releaseMediaStream).

  • Keep stats callback lightweight and avoid blocking UI thread.

  • Persist final report snapshot before cleanup.

5) Confirm Cleanup + Upgrade Posture

  • Always stop active diagnostics before page unload/navigation.

  • Re-check renderer option naming and report field names on upgrades.

  • Re-check browser compatibility assumptions against current docs.

6) Quick Probes

  • Permissions prompt appears and resolves expectedly.

  • Devices list includes expected microphone/speaker/camera.

  • Video diagnostic renders to selected target.

  • Network diagnostic emits stats and final report.

7) Fast Decision Tree

  • No media diagnostics -> permissions denied or insecure context.

  • Video diagnostics fail -> renderer/target mismatch or unsupported renderer type.

  • Network diagnostic incomplete -> timeout/domain/config mismatch.

  • Report schema mismatch -> version drift between docs and installed package.

8) Source Checkpoints

Official docs
Raw docs in repo

  • tools/zoom-crawler/raw-docs/developers.zoom.us/docs/probe-sdk/

  • tools/zoom-crawler/raw-docs/marketplacefront.zoom.us/sdk/probe/

Requirements and compatibility

Written for: OpenAI Codex

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Zoom
Publisher
OpenAI (Official)
Distributed by
OpenAI
Source
openai/plugins · plugins/zoom/skills/probe-sdk · commit d420d13
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from plugins/zoom/LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Zoom or OpenAI.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download probe-sdk.zip