Skip to main content
Castingwords logo
  • Category: transcription
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: CASTINGWORDS
  • Version: 20261101_00

Tools

Slug: CASTINGWORDS_CANCEL_AUDIOFILETool to cancel an ordered audio file and issue a refund if applicable. Use when no transcription work has been done on the file (Pre-Processing, Audio Processing, Error states).

Input Parameters

string
If set to ‘true’, returns a fake approval for testing. Only valid when audiofile_id is 100 or 101.
integer
required
ID of the audio file to refund.

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: CASTINGWORDS_GET_PREPAY_BALANCETool to retrieve the current prepay balance for the account. Use when you need to check available funds before placing new transcription orders.

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: CASTINGWORDS_GET_TRANSCRIPTTool to retrieve the transcript for a given audiofile in the requested format (txt, doc, rtf, or html). Use after a transcription order has been completed.

Input Parameters

string
If set to ‘1’ or ‘true’, returns a fake transcript for testing purposes. Only valid with audiofile_id 100 or 101 and txt extension.
string ("txt" | "doc" | "rtf" | "html")
Output format extension for the transcript. Options: txt (default), doc, rtf, html.
integer
required
The ID of the audiofile to retrieve the transcript for.

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: CASTINGWORDS_GET_WEBHOOKTool to retrieve the currently registered webhook URL for account notifications. Use when you need to verify your webhook setup.

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: CASTINGWORDS_ORDER_TRANSCRIPTCreate a transcription order for audio/video files at publicly accessible URLs and return order and audiofile IDs; test orders are not transcribed. An accepted order may be held for billing, and the response does not expose the hold status.

Input Parameters

string
required
SKU code(s) specifying transcription tier and optional add-ons. Transcription tiers (pick one): TRANS14 (Budget, ~5 day), TRANS2 (1-Day rush), TRANS6 or TRANS7 (7-Day standard). Add-ons (optional, combine with tier): DIFFQ2 (Difficult Audio surcharge), TSTMP1 (Include timestamps), CAPTION1 (Generate captions), VERBATIM1 (Verbatim transcription including filler words). Use SKU_LIST action to get current pricing.
string
required
Publicly accessible URL or list of URLs of audio/video files to transcribe. The URL must be directly downloadable by CastingWords servers (not behind authentication). Supported formats: MP3 (preferred), WAV, and common video formats.
array
List of speaker names to help transcribers identify and label speakers in the transcript. Helpful for multi-speaker recordings.
boolean
If true, creates a test order that validates the URL but does not charge or produce a real transcript. Use for testing integrations. Defaults to false.
string
Optional instructions or context for transcribers. Use for special requests like technical terminology, speaker identification guidance, or handling unclear sections.

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: CASTINGWORDS_ORDER_UPGRADESTool to order an upgrade for a specific audio file. Use after transcription is complete to add items like timestamps or extra editing. Example: ‘Order timestamps for file 12345’.

Input Parameters

array
required
One or more SKUs to order: DIFFQ2 (Difficult Audio), TSTMP1 (Timestamps), EDIT01 (Extra Editing), UPGRD1 (TRANS14→TRANS6), UPGRD2 (TRANS14→TRANS2), UPGRD3 (TRANS6→TRANS2)
boolean
Set to true to run in test mode returning a fake success. Only valid for audiofile IDs 100 and 101.
integer
required
ID of the audio file to upgrade

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: CASTINGWORDS_REGISTER_WEBHOOKRegisters a webhook URL to receive CastingWords event notifications. When events occur (e.g., transcript completion, refund issued, difficult audio), CastingWords will POST to your registered URL with event details. Use CASTINGWORDS_GET_WEBHOOK to verify the current webhook, and CASTINGWORDS_TEST_WEBHOOK to test notifications.

Input Parameters

string
required
The HTTP or HTTPS endpoint URL where CastingWords will POST notifications when events occur (e.g., transcript completion, refunds). Must be a valid URL starting with http:// or https://.

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: CASTINGWORDS_SKU_LISTRetrieve available CastingWords service SKU codes and pricing information for use when placing orders. Prices may be per-minute or flat-rate, and some may be unavailable.

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: CASTINGWORDS_TEST_WEBHOOKTool to request a test webhook call for a specific event type. Use after registering a webhook URL to ensure webhook notifications are functioning properly.

Input Parameters

string ("TRANSCRIPT_COMPLETE" | "DIFFICULT_AUDIO" | "REFUND_ISSUED")
required
Type of webhook event to test. One of ‘TRANSCRIPT_COMPLETE’, ‘DIFFICULT_AUDIO’, or ‘REFUND_ISSUED’.

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