Skip to main content
Happy Scribe logo
  • Category: transcription
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 20
  • Triggers: 0
  • Slug: HAPPY_SCRIBE
  • Version: 20261101_00

Tools

Slug: HAPPY_SCRIBE_CREATE_SUBTITLECreates a transcription job from a publicly accessible media URL, configured for subtitles by default. Supports automatic, professional, and alignment services, and the subtitle setting can be disabled.

Input Parameters

object
required
Transcription creation parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_CREATE_TRANSLATION_TASKCreates an AI-powered translation task to translate an existing transcription into another language. Use this after a transcription is complete (state=‘automatic_done’) to translate it. The task runs asynchronously - use Retrieve Translation Task to check progress and get results. Note: Not all language pairs are supported (e.g., German to English may fail).

Input Parameters

string
required
Two-letter ISO 639-1 language code to translate into (e.g., ‘es’ for Spanish, ‘de’ for German, ‘fr’ for French). Not all source-target language pairs are supported.
string
required
ID of the transcription to translate. The transcription must exist and be in ‘automatic_done’ state. Get this from List Transcriptions or Create Transcription actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_DELETE_TRANSCRIPTIONTool to delete a transcription job. Use when you have a transcription ID and want to remove it, optionally permanently. Use after confirming the transcription ID.

Input Parameters

string
required
Unique identifier of the transcription to delete (32-character hexadecimal string)
boolean
If true, permanently deletes the transcription; otherwise moves it to Trash (default false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_DELETE_WEBHOOKDeletes a webhook by its ID. The action reports success if the webhook is deleted or is not found; use Get Webhooks to find available webhook IDs.

Input Parameters

string
required
Unique identifier of the webhook to delete. Obtain the webhook ID from the Get Webhooks action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_GET_ACCOUNT_DETAILSRequests Happy Scribe account information, optionally scoped to a specified organization.

Input Parameters

string
Organization ID to scope the account information; if omitted, returns default account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_GET_LANGUAGE_LISTReturns a static reference list of language codes and recorded human transcription service availability. Optionally filter the list by whether human service is recorded as available; the reference is not exhaustive.

Input Parameters

boolean
If True, return only languages with human transcription service available. If False, return only languages without human service. If not specified, returns all languages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_GET_RATE_LIMITReturns the documented default transcription-creation rate limit of 200 requests per hour. The returned remaining count and reset time are fixed placeholders, not live account usage or the actual rate-limit window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_GET_SIGNED_UPLOAD_URLTool to get a signed URL for uploading a file to Happy Scribe’s S3 storage. Use before creating a transcription or order to obtain a secure upload URL for your media file.

Input Parameters

string
required
The filename of the file to upload. Should include the file extension (e.g., ‘audio.mp3’, ‘video.mp4’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_CONFIRM_ORDERTool to confirm a pending order. Use after creating an order with confirm=false when you’re ready to submit it for processing.

Input Parameters

string
required
Unique identifier of the order to confirm (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_CREATE_TRANSLATION_ORDERTool to create a translation order from an existing transcription. Use when you have a completed transcription and want translations into one or more languages. By default, the order remains incomplete unless confirm=true.

Input Parameters

object
required
Wrapper object containing the translation order parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_EXPORT_TRANSCRIPTIONCreates an export job for transcription content in supported document, subtitle, video-editing, and other formats. The job is asynchronous; use the returned export ID to check its status and download link, with formatting options varying by format.

Input Parameters

string ("txt" | "docx" | "pdf" | "srt" | "vtt" | "stl" | "avid" | "html" | "premiere" | "maxqda" | "json" | "fcp")
required
Export format: txt/docx/pdf (documents), srt/vtt/stl (subtitles), avid/premiere/fcp (video editing), html (web), json (structured data), maxqda (research)
boolean
Include editor comments in the export. Only applies to txt, docx, and pdf formats.
boolean
Include speaker names/labels in the export. Only applies to txt, docx, and pdf formats.
boolean
Include highlighted text sections in the export. Only applies to docx and pdf formats.
boolean
Include inline timestamps in the export. Only applies to txt, docx, and pdf formats.
array
required
One or more transcription IDs to export (obtain from List Transcriptions action). Multiple IDs will be combined into a single export file.
boolean
Export only the highlighted sections, excluding non-highlighted content. Only applies to docx and pdf formats.
string ("5s" | "10s" | "15s" | "20s" | "30s" | "60s")
How often to insert timestamps (e.g., ’30s’ = every 30 seconds). Requires show_timestamps=true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_GET_API_VERSIONIdentifies the Happy Scribe API version associated with the connection. Update information is included when available.

Input Parameters

string
Optional organization ID used when probing list endpoints
string
Preferred endpoint to probe for version: ‘version’, ‘transcriptions’, or ‘auto’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_GET_ERROR_CODESReturns a static reference list of selected Happy Scribe HTTP error codes and their meanings. The list does not include HTTP 409 Conflict.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_GET_SUPPORTED_FORMATSReturns input and output file format lists to help plan transcription or subtitle work. A non-exhaustive reference list is used when necessary; that list can be filtered by audio or video input and output category, with an optional per-list limit.

Input Parameters

integer
Optional limit on the number of formats returned for each list
string
Optional note used for testing (supports special characters and emoji)
boolean
Include audio input formats (e.g., ‘mp3’, ‘wav’)
boolean
Include video input formats (e.g., ‘mp4’, ‘mov’)
string
Which output formats to include: ‘subtitles’, ‘transcripts’, or ‘all’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_GET_TRANSCRIPTIONTool to retrieve details and status of a specific transcription job. Use after creating or listing transcription jobs to inspect a particular job’s metadata.

Input Parameters

string
required
Unique identifier of the transcription job to retrieve. This is a 32-character hexadecimal string obtained from creating a transcription or listing transcriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_GET_WEBHOOKSTool to retrieve webhooks configured for your account. Note: Happy Scribe’s public API does not have a dedicated webhooks listing endpoint. Webhooks are specified via webhook_url when creating orders. This action attempts common endpoints and returns an empty list if unavailable.

Input Parameters

string
Organization ID to scope the webhooks query. Optional since the endpoint may not exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_RETRIEVE_EXPORTTool to retrieve information about a specific export. Use when you need to check export status and get download link.

Input Parameters

string
required
Unique identifier of the export to retrieve. This is typically a UUID returned when creating an export via the Export Transcription action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_HS_RETRIEVE_TRANSLATION_TASKRetrieves the status and details of a translation task by its ID. Use this after creating a translation task with HAPPY_SCRIBE_CREATE_TRANSLATION_TASK to check progress (state: initial, working, failed, done) and obtain the translated transcription ID when complete. Note: This endpoint is deprecated; consider using HAPPY_SCRIBE_RETRIEVE_ORDER for new integrations.

Input Parameters

string
required
Unique identifier of the translation task to retrieve. Obtain this ID from the response of creating a translation task via HAPPY_SCRIBE_CREATE_TRANSLATION_TASK.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_LIST_TRANSCRIPTIONSRetrieves a paginated list of transcription jobs for a Happy Scribe organization. Returns transcription metadata including ID, name, processing state, language, and duration. Supports filtering by folder and tags, with pagination for large result sets. Note: This returns metadata only; use the Export Transcription action to get actual transcript content.

Input Parameters

integer
Zero-based page index for pagination. Each page returns up to 25 results. Use the ‘_links.next.url’ from the response to get subsequent pages.
array
Filter transcriptions by one or more tags. Only transcriptions matching ALL specified tags are returned.
string
Filter results to a specific folder and its subfolders. The folder ID can be obtained from the folder URL in the Happy Scribe web app.
string
required
The workspace/organization ID to list transcriptions from. Required. Can be found in the Happy Scribe web app under ‘My Workspace > Personal Settings > API’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HAPPY_SCRIBE_RETRIEVE_ORDERRetrieve details of a Happy Scribe order by its ID. Returns order state, pricing, operations, and inputs. Use this to check order status, verify pricing details, or get information about translation/transcription operations. The order ID is obtained from create order responses (e.g., Create Translation Order).

Input Parameters

string
required
Unique identifier (UUID) of the order to retrieve. Obtain this from a create order response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not