API documentation

GET /transcription_flows/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/transcription_flows/new

Build Transcription Flow with defaults.

Return a new, unsaved transcription flow pre-filled with defaults.

Params

Param name	Description
transcription_flow_group_id Optional Blank value allowed	Transcription Flow Group Must be a String
name Optional Blank value allowed	Name Must be a String
recording_types Optional Blank value allowed	Recording Types Must be an array of strings. EG: `["abc123", "xzy023"]`
description Optional Blank value allowed	Description Must be a String
record_token_filter_id Optional Blank value allowed	Record Token Filter Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional Blank value allowed	Token Value Ids Must be a decimal number.
transcription_keyword_group_id Optional Blank value allowed	The Transcription Keyword Group scanned for in this flow’s transcripts, if any. Must be a valid foreign key reference to an Transcription Keyword Group. Refer to: /api/docs/1.0/transcription_keyword_groups
schedule_action_group_id Optional Blank value allowed	Run this Schedule Action Group against the call after its transcript is ready. Must be a valid foreign key reference to an Schedule Action Group. Refer to: /api/docs/1.0/schedule_action_groups
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/transcription_flows/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "transcription_flow": {
    "id": null,
    "type": "TranscriptionFlow",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/transcription_flows/new",
    "routes_edit_path": "/transcription_flows/new",
    "external_record_id": null,
    "company_id": 10001,
    "transcription_flow_group_id": null,
    "sortable_order": null,
    "name": "Transcribe Recordings",
    "recording_types": [
      "call",
      "consumer_and_agent",
      "consumer_and_buyer"
    ],
    "description": null,
    "transcription_keyword_group_id": null,
    "schedule_action_group_id": null,
    "redact_pii": true,
    "transcription_base_rate": "+$0.05/min",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "transcription_flow"
  }
}