anthropics--knowledge-work-plugins/partner-built/zoom-plugin/skills/scribe/references/api-reference.md

Zoom AI Services Scribe API Reference

Canonical sources:

• OpenAPI JSON: https://developers.zoom.us/api-hub/ai-services/methods/endpoints.json
• Docs overview: https://developers.zoom.us/docs/ai-services/scribe/
• Base URL: https://api.zoom.us/v2

Endpoint Inventory

Method	Endpoint	Summary	Operation ID
POST	/aiservices/scribe/transcribe	Scribe (Synchronous)	createFastAsr
POST	/aiservices/scribe/jobs	Submit Batch Scribe Job	submitBatchAsr
GET	/aiservices/scribe/jobs	List Batch Jobs	listBatchJobs
GET	/aiservices/scribe/jobs/{jobId}	Get Batch Job Status	getBatchJobStatus
DELETE	/aiservices/scribe/jobs/{jobId}	Cancel Batch Job	cancelBatchJob
GET	/aiservices/scribe/jobs/{jobId}/files	List Batch Job Files	listBatchJobFiles

Request Shapes

POST /aiservices/scribe/transcribe

Required top-level fields:

• file
• config

Common config fields:

• language
• word_time_offsets
• channel_separation
• timestamps
• output_format
• profanity_filter
• diarization

Response keys:

• request_id
• duration_sec
• model
• result

POST /aiservices/scribe/jobs

Required top-level fields:

• input
• output
• config

Input subfields:

• mode (SINGLE, PREFIX, MANIFEST)
• source (S3 in current spec)
• uri
• manifest
• filters.include_globs
• filters.exclude_globs
• auth.aws.access_key_id
• auth.aws.secret_access_key
• auth.aws.session_token

Output subfields:

• destination
• uri
• layout (SINGLE, PREFIX, ADJACENT)
• auth.aws.*

Config subfields:

• language
• word_time_offsets
• channel_separation
• diarization
• profanity_filter
• output_format
• segmentation_mode

Optional:

• reference_id
• notifications.webhook_url
• notifications.secret

Response keys:

• job_id
• state
• submitted_at

GET /aiservices/scribe/jobs

Query params:

• state
• page_size
• next_page_token

Response keys:

• jobs
• next_page_token

GET /aiservices/scribe/jobs/{jobId}

Path params:

• jobId

Response keys:

• job_id
• state
• submitted_at
• summary

GET /aiservices/scribe/jobs/{jobId}/files

Path params:

• jobId

Query params:

• page_size
• next_page_token

Response keys:

• files
• next_page_token

Current Limits and Constraints Observed in Sources

• Batch manifest max: 1000 file URIs.
• include_globs max items: 10.
• exclude_globs max items: 10.
• Audio/media formats called out in docs: WAV, MP3, M4A, MP4.
• Batch job rate limit label in the OpenAPI description: LIGHT.