Back to Details

scribe

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Zoom AI Services Scribe

Zoom AI Services Scribe

Background reference for Zoom AI Services Scribe across:
  • synchronous single-file transcription (
    POST /aiservices/scribe/transcribe
    )
  • asynchronous batch jobs (
    /aiservices/scribe/jobs*
    )
  • browser microphone pseudo-streaming via repeated short file uploads
  • webhook-driven batch status updates
  • Build-platform JWT generation and credential handling
Official docs:
Zoom AI Services Scribe的背景参考，涵盖以下方面：
  • 同步单文件转录 (
    POST /aiservices/scribe/transcribe
    )
  • 异步批处理作业 (
    /aiservices/scribe/jobs*
    )
  • 通过重复上传短文件实现的浏览器麦克风伪流
  • Webhook驱动的批处理状态更新
  • Build平台JWT生成与凭证处理
官方文档：

Routing Guardrail

路由规则

  • If the user needs uploaded or stored media transcribed into text, route here first.
  • If the user needs live meeting media without file-based upload/batch jobs, route to ../rtms/SKILL.md.
  • If the user needs Zoom REST API inventory for AI Services paths, chain ../rest-api/SKILL.md.
  • If the user needs webhook signature patterns or generic HMAC receiver hardening, optionally chain ../webhooks/SKILL.md.
  • 如果用户需要将上传或存储的媒体转录为文本，优先路由到此处。
  • 如果用户需要无需基于文件上传/批处理作业的实时会议媒体，路由到 ../rtms/SKILL.md。
  • 如果用户需要AI服务路径的Zoom REST API清单，链式调用 ../rest-api/SKILL.md。
  • 如果用户需要Webhook签名模式或通用HMAC接收器加固，可选择链式调用 ../webhooks/SKILL.md。

Quick Links

快速链接

  1. concepts/auth-and-processing-modes.md
  2. scenarios/high-level-scenarios.md
  3. examples/fast-mode-node.md
  4. examples/batch-webhook-pipeline.md
  5. references/api-reference.md
  6. references/environment-variables.md
  7. references/samples-validation.md
  8. references/versioning-and-drift.md
  9. troubleshooting/common-drift-and-breaks.md
  10. RUNBOOK.md
  1. concepts/auth-and-processing-modes.md
  2. scenarios/high-level-scenarios.md
  3. examples/fast-mode-node.md
  4. examples/batch-webhook-pipeline.md
  5. references/api-reference.md
  6. references/environment-variables.md
  7. references/samples-validation.md
  8. references/versioning-and-drift.md
  9. troubleshooting/common-drift-and-breaks.md
  10. RUNBOOK.md

Core Workflow

核心工作流

  1. Get Build-platform credentials and generate an HS256 JWT.
  2. Choose fast mode for one short file or batch mode for stored archives / large sets.
  3. Submit the transcription request.
  4. For batch jobs, poll job/file status or receive webhook notifications.
  5. Persist and post-process transcript JSON.
  1. 获取Build平台凭证并生成HS256 JWT。
  2. 单个短文件选择快速模式，存储归档/大量文件选择批处理模式。
  3. 提交转录请求。
  4. 对于批处理作业，轮询作业/文件状态或接收Webhook通知。
  5. 持久化并后处理转录JSON结果。

Hosted Fast-Mode Guardrail

托管快速模式注意事项

  • The formal fast-mode API limits are 
    100 MB
    and 
    2 hours
    , but hosted browser flows can still time out before the upstream response returns.
  • Current deployed-sample observations:
    • ~17.2 MB MP4 completed in about 
      26s
    • ~38.6 MB MP4 completed in about 
      26-37s
    • ~59.2 MB MP4 completed in about 
      32-34s
      on the backend
    • some ~59.2 MB browser requests still surfaced as frontend 
      504
      while backend logs later showed 
      200
  • Treat frontend 
    504
    plus backend 
    200
    as a browser/edge timeout race, not an automatic transcription failure.
  • For hosted UIs, prefer an async request/polling wrapper for fast mode instead of holding the browser open for the full upstream response.
  • For larger or less predictable media, prefer batch mode even when the file is still within the formal fast-mode size limit.
  • 官方快速模式API限制为
    100 MB
    和
    2小时
    ，但托管浏览器流可能在上游响应返回前就超时。
  • 当前已部署示例的观测数据：
    • 约17.2 MB的MP4文件大约在
      26秒
      内完成
    • 约38.6 MB的MP4文件大约在
      26-37秒
      内完成
    • 约59.2 MB的MP4文件后端大约在
      32-34秒
      内完成
    • 部分约59.2 MB的浏览器请求仍然返回前端
      504
      ，但后端日志后续显示
      200
  • 将前端
    504
    +后端
    200
    的情况视为浏览器/边缘超时竞争，不要直接判定为转录失败。
  • 对于托管UI，优先为快速模式使用异步请求/轮询封装，而不是让浏览器一直等待完整的上游响应。
  • 对于更大或不可预测的媒体，即使文件仍在官方快速模式大小限制内，也优先选择批处理模式。

Browser Microphone Pattern

浏览器麦克风实现模式

  • scribe
    does not expose a documented real-time streaming API surface.
  • If you want a browser microphone experience, use pseudo-streaming:
    1. capture microphone audio in short chunks
    2. upload each chunk through the async fast-mode wrapper
    3. poll for completion
    4. append chunk transcripts in sequence
  • Recommended starting cadence:
    • chunk size: 
      5 seconds
    • acceptable range: 
      5-10 seconds
    • in-flight chunk requests: 
      2-3
  • This is a practical UI pattern for incremental transcript updates, not a substitute for 
    rtms
    .
  • Treat this as a fallback demo pattern, not the preferred production architecture.
  • It adds repeated upload overhead, chunk-boundary drift, browser codec/container variability, and transcript stitching complexity.
  • If the user asks for actual live stream ingestion, low-latency continuous media, or server-push media transport, route to ../rtms/SKILL.md instead.
  • scribe
    没有公开的官方实时流API接口。
  • 如果你需要浏览器麦克风体验，使用伪流方案：
    1. 将麦克风音频捕获为短分片
    2. 通过异步快速模式封装上传每个分片
    3. 轮询完成状态
    4. 按顺序拼接分片转录结果
  • 推荐的初始参数：
    • 分片大小：
      5秒
    • 可接受范围：
      5-10秒
    • 处理中的分片请求数：
      2-3
  • 这是实现增量转录更新的实用UI模式，不能替代
    rtms
    。
  • 将其视为 fallback 演示模式，而不是首选的生产架构。
  • 它会带来重复上传开销、分片边界偏移、浏览器编解码器/容器差异以及转录拼接复杂度。
  • 如果用户需要真正的直播流摄入、低延迟连续媒体或服务器推送媒体传输，请路由到 ../rtms/SKILL.md。

Endpoint Surface

接口清单

ModeMethodPathUse
Fast
POST
/aiservices/scribe/transcribe
Synchronous transcription for one file
Batch
POST
/aiservices/scribe/jobs
Submit asynchronous batch job
Batch
GET
/aiservices/scribe/jobs
List jobs
Batch
GET
/aiservices/scribe/jobs/{jobId}
Inspect job summary/state
Batch
DELETE
/aiservices/scribe/jobs/{jobId}
Cancel queued/processing job
Batch
GET
/aiservices/scribe/jobs/{jobId}/files
Inspect per-file results
模式请求方法路径用途
快速模式
POST
/aiservices/scribe/transcribe
单文件同步转录
批处理
POST
/aiservices/scribe/jobs
提交异步批处理作业
批处理
GET
/aiservices/scribe/jobs
列出作业
批处理
GET
/aiservices/scribe/jobs/{jobId}
查询作业概要/状态
批处理
DELETE
/aiservices/scribe/jobs/{jobId}
取消队列中/处理中的作业
批处理
GET
/aiservices/scribe/jobs/{jobId}/files
查询单文件结果

High-Level Scenarios

常见场景

  • On-demand clip transcription after a user uploads one recording.
  • Batch transcription of stored S3 call archives.
  • Webhook-driven ETL pipeline that writes transcripts to your database/search index.
  • Re-transcription of Zoom-managed recordings after exporting them to your own storage.
  • Offline compliance or QA workflows that need timestamps, channel separation, and speaker hints.
  • 用户上传单个录制文件后的按需剪辑转录。
  • 存储在S3的通话归档文件的批量转录。
  • Webhook驱动的ETL管道，将转录结果写入数据库/搜索索引。
  • Zoom托管的录制文件导出到自有存储后的重新转录。
  • 需要时间戳、声道分离和说话人提示的离线合规或QA工作流。

Chaining

链式调用

  • Stored Zoom recordings -> ../rest-api/SKILL.md + 
    scribe
  • Webhook verification hardening -> ../webhooks/SKILL.md
  • Real-time live transcript/media -> ../rtms/SKILL.md
  • Cross-product routing -> ../general/SKILL.md
  • 存储的Zoom录制文件 -> ../rest-api/SKILL.md + 
    scribe
  • Webhook验证加固 -> ../webhooks/SKILL.md
  • 实时直播转录/媒体 -> ../rtms/SKILL.md
  • 跨产品路由 -> ../general/SKILL.md

Operations

运维

  • RUNBOOK.md - 5-minute preflight and debugging checklist.
  • RUNBOOK.md - 5分钟预检查和调试清单。