/happy-scribe | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
happy_scribe_add_organization_membership | Add a membership |
happy_scribe_confirm_order | Confirm an order |
happy_scribe_create_export | Create an export |
happy_scribe_create_order | Create a transcription or subtitling order |
happy_scribe_create_translation_order | Create a translation order |
happy_scribe_delete_transcription | Delete a transcription |
happy_scribe_get_export | Retrieve an export |
happy_scribe_get_order | Retrieve an order |
happy_scribe_get_signed_upload_url | Get a signed URL for uploading a media file |
happy_scribe_get_transcription | Retrieve a transcription |
happy_scribe_list_glossaries | List glossaries |
happy_scribe_list_organization_memberships | List organization memberships |
happy_scribe_list_organizations | List organizations |
happy_scribe_list_style_guides | List style guides |
happy_scribe_list_transcriptions | List all transcriptions |
happy_scribe_remove_organization_membership | Remove a membership |
happy_scribe_update_organization_membership | Update a membership’s role |
happy_scribe_add_organization_membership
Add a membership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | Email address of the user to add |
organization_id | integer | Yes | — | ID of the organization |
role | string | Yes | — | Role to assign |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "Email address of the user to add"
},
"organization_id": {
"type": "integer",
"description": "ID of the organization"
},
"role": {
"type": "string",
"description": "Role to assign",
"enum": [
"admin",
"member"
]
}
},
"required": [
"PCID",
"email",
"organization_id",
"role"
]
}
happy_scribe_confirm_order
Confirm an order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Unique order identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Unique order identifier"
}
},
"required": [
"PCID",
"id"
]
}
happy_scribe_create_export
Create an export Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
export | object | Yes | — | The export value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"export": {
"type": "object",
"description": "The export value",
"properties": {
"format": {
"type": "string",
"description": "Export format",
"enum": [
"txt",
"docx",
"pdf",
"srt",
"vtt",
"stl",
"avid",
"html",
"premiere",
"maxqda",
"json",
"fcp"
]
},
"transcription_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "IDs of transcriptions to export"
},
"show_timestamps": {
"type": "boolean",
"description": "Include timestamps (txt, docx, pdf only)"
},
"timestamps_frequency": {
"type": "string",
"description": "Inline timecodes frequency",
"enum": [
"5s",
"10s",
"15s",
"20s",
"30s",
"60s"
]
},
"show_speakers": {
"type": "boolean",
"description": "Include speaker labels (txt, docx, pdf only)"
},
"show_comments": {
"type": "boolean",
"description": "Include comments (txt, docx, pdf only)"
},
"show_highlights": {
"type": "boolean",
"description": "Include highlights (docx, pdf only)"
},
"show_highlights_only": {
"type": "boolean",
"description": "Include only highlights (docx, pdf only)"
}
},
"required": [
"format",
"transcription_ids"
]
}
},
"required": [
"PCID",
"export"
]
}
happy_scribe_create_order
Create a transcription or subtitling order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
order | object | Yes | — | The order value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"order": {
"type": "object",
"description": "The order value",
"properties": {
"url": {
"type": "string",
"description": "URL of the media file to transcribe"
},
"language": {
"type": "string",
"description": "BCP-47 language code to transcribe to"
},
"organization_id": {
"type": "integer",
"description": "ID of the workspace to create the file in"
},
"service": {
"type": "string",
"description": "Service type",
"enum": [
"auto",
"pro"
]
},
"confirm": {
"type": "boolean",
"description": "When true, order auto-submits; when false, stays incomplete until confirmed"
},
"folder_id": {
"type": "string",
"description": "ID of the folder to create the order in"
},
"folder": {
"type": "string",
"description": "Path of the folder (e.g. path/to/my folder)"
},
"name": {
"type": "string",
"description": "Name of the resulting transcription (derived from source file if omitted)"
},
"boost": {
"type": "boolean",
"description": "When true, the order is boosted for faster turnaround (pro only)"
},
"is_subtitle": {
"type": "boolean",
"description": "Treat as subtitles"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags to add"
},
"webhook_url": {
"type": "string",
"description": "URL to receive webhook on order state changes"
},
"glossary_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Glossary IDs to apply (must belong to the organization)"
},
"style_guide_id": {
"type": "integer",
"description": "Style guide ID to apply (must belong to the organization)"
}
},
"required": [
"url",
"language",
"organization_id"
]
}
},
"required": [
"PCID",
"order"
]
}
happy_scribe_create_translation_order
Create a translation order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
order | object | Yes | — | The order value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"order": {
"type": "object",
"description": "The order value",
"properties": {
"source_transcription_id": {
"type": "string",
"description": "ID of the transcription to translate from"
},
"target_languages": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of target language codes"
},
"service": {
"type": "string",
"description": "Service type",
"enum": [
"auto",
"pro"
]
},
"confirm": {
"type": "boolean",
"description": "When true, auto-submit the order"
},
"boost": {
"type": "boolean",
"description": "Boost the order for faster turnaround"
},
"webhook_url": {
"type": "string",
"description": "URL for order state change webhooks"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags to add"
}
},
"required": [
"source_transcription_id",
"target_languages"
]
}
},
"required": [
"PCID",
"order"
]
}
happy_scribe_delete_transcription
Delete a transcription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Transcription ID |
permanent | boolean | No | — | When true the deletion is irreversible; otherwise the transcription goes to Trash |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Transcription ID"
},
"permanent": {
"type": "boolean",
"description": "When true the deletion is irreversible; otherwise the transcription goes to Trash"
}
},
"required": [
"PCID",
"id"
]
}
happy_scribe_get_export
Retrieve an export Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Export ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Export ID"
}
},
"required": [
"PCID",
"id"
]
}
happy_scribe_get_order
Retrieve an order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Unique order identifier |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Unique order identifier"
}
},
"required": [
"PCID",
"id"
]
}
happy_scribe_get_signed_upload_url
Get a signed URL for uploading a media file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filename | string | Yes | — | The filename and extension of the media file (e.g. my_media.mp3) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filename": {
"type": "string",
"description": "The filename and extension of the media file (e.g. my_media.mp3)"
}
},
"required": [
"PCID",
"filename"
]
}
happy_scribe_get_transcription
Retrieve a transcription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Transcription ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Transcription ID"
}
},
"required": [
"PCID",
"id"
]
}
happy_scribe_list_glossaries
List glossaries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | integer | Yes | — | ID of the organization |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "integer",
"description": "ID of the organization"
}
},
"required": [
"PCID",
"organization_id"
]
}
happy_scribe_list_organization_memberships
List organization memberships Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | integer | No | — | Restrict to a single organization |
role | string | No | — | Filter by exact role |
email | string | No | — | Case-insensitive partial match on email |
name | string | No | — | Case-insensitive partial match on full name |
page | integer | No | — | Page number |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "integer",
"description": "Restrict to a single organization"
},
"role": {
"type": "string",
"description": "Filter by exact role",
"enum": [
"owner",
"admin",
"member",
"guest"
]
},
"email": {
"type": "string",
"description": "Case-insensitive partial match on email"
},
"name": {
"type": "string",
"description": "Case-insensitive partial match on full name"
},
"page": {
"type": "integer",
"description": "Page number"
}
},
"required": [
"PCID"
]
}
happy_scribe_list_organizations
List organizationsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
happy_scribe_list_style_guides
List style guides Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | integer | Yes | — | ID of the organization |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "integer",
"description": "ID of the organization"
}
},
"required": [
"PCID",
"organization_id"
]
}
happy_scribe_list_transcriptions
List all transcriptions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | ID of the organization to get transcriptions from |
folder_id | string | No | — | Filter to transcriptions inside the specified folder or its subfolders |
page | integer | No | — | Request a specific page (starts at 0) |
tags | string[] | No | — | List of tags to filter by |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization to get transcriptions from"
},
"folder_id": {
"type": "string",
"description": "Filter to transcriptions inside the specified folder or its subfolders"
},
"page": {
"type": "integer",
"description": "Request a specific page (starts at 0)"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags to filter by"
}
},
"required": [
"PCID",
"organization_id"
]
}
happy_scribe_remove_organization_membership
Remove a membership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Membership ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Membership ID"
}
},
"required": [
"PCID",
"id"
]
}
happy_scribe_update_organization_membership
Update a membership’s role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Membership ID |
role | string | No | — | New role |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Membership ID"
},
"role": {
"type": "string",
"description": "New role",
"enum": [
"admin",
"member"
]
}
},
"required": [
"PCID",
"id"
]
}

