Skip to navigation
HeyReach APIVoice

GetStaticClip

View as Markdown

Read back a static voice clip by the clipId UploadStaticClip returned: its duration, its transcript and why a transcript is absent. Metadata only; the audio is not available through the API.

Errors

  • 403 NO_ACTIVE_SUBSCRIPTION or VOICE_NOTES_NOT_ENABLED.
  • 404 STATIC_CLIP_NOT_FOUND: no clip with this id in the workspace (an unknown id and another workspace’s clip alike).

Path parameters

clipIdintegerRequired

Headers

X-API-KEYstringOptional

API key header using this scheme. Example: “X-API-KEY: {API_KEY}”

Response

OK
clipIdinteger
durationMsinteger
transcriptStatusenum
Allowed values:
contentTypestring
creationTimedatetime
transcriptstring or nullOptional

Best-effort transcript. Null is normal and never means the clip is unusable.

transcriptFailureReasonstring or nullOptional

Set only when transcriptStatus is FAILED.

Errors

403
Get Static Clip Voice Request Forbidden Error
404
Get Static Clip Voice Request Not Found Error