API documentation

GET /transcription_flows

Authorization Required

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

List Transcription Flow records.

List the call transcription flows configured for your account.

Params

Param name	Description
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id company_id transcription_flow_group_id sortable_order name recording_types description transcription_keyword_group_id schedule_action_group_id redact_pii redact_pii_audio redact_pii_sub redact_pii_types enable_summary enable_sentiment enable_topics enable_entities enable_highlights enable_language_detection ai_feature_rates transcription_base_rate record_token_filter_id record_token_filter_data_count record_token_filter_data Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "transcription_flows": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "TranscriptionFlow",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "routes_edit_path": "/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "company_id": 10001,
      "transcription_flow_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
      "sortable_order": -1,
      "name": "Transcribe Recordings",
      "recording_types": [
        "call",
        "consumer_and_agent",
        "consumer_and_buyer"
      ],
      "description": null,
      "transcription_keyword_group_id": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
      "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": []
    },
    {
      "id": "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
      "type": "TranscriptionFlow",
      "uuid": "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/transcription_flows/8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
      "routes_edit_path": "/transcription_flows/8a10bcf5-8767-4aa3-a10b-5458e72d5bf9/edit",
      "external_record_id": null,
      "company_id": 10001,
      "transcription_flow_group_id": "1d4df925-d435-4b33-a461-efb6c324405e",
      "sortable_order": -1,
      "name": "Transcribe Recordings",
      "recording_types": [
        "call",
        "consumer_and_agent",
        "consumer_and_buyer"
      ],
      "description": null,
      "transcription_keyword_group_id": "122f4808-84b2-45c9-a424-db76e14e0eed",
      "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_flows",
    "page": 1,
    "total_pages": 20,
    "per_page": 2,
    "total_count": 40,
    "next_cursor": 10002
  }
}

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"
  }
}

POST /transcription_flows

Authorization Required

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

Create Transcription Flow.

Create a transcription flow that defines which call recording types get transcribed and which analysis runs on them, such as PII redaction, summaries, sentiment, topics, entities, and highlights. Flows belong to a transcription_flow_group and can be scoped to matching calls with a record_token_filter.

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 -X POST 'https://[your-subdomain].trackdrive.com/api/v1/transcription_flows/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "transcription_flow_group_id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
  "name": "Example Transcription Flow",
  "description": "Transcribes calls and flags compliance keywords.",
  "recording_types": [
    "call"
  ]
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "transcription_flow": {
    "id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "type": "TranscriptionFlow",
    "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/transcription_flows/a09e6bca-255b-4217-af73-cb9601c80217",
    "routes_edit_path": "/transcription_flows/a09e6bca-255b-4217-af73-cb9601c80217/edit",
    "external_record_id": null,
    "company_id": 10001,
    "transcription_flow_group_id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "sortable_order": -2,
    "name": "Example Transcription Flow",
    "recording_types": [
      "call"
    ],
    "description": "Transcribes calls and flags compliance keywords.",
    "transcription_keyword_group_id": null,
    "schedule_action_group_id": null,
    "redact_pii": null,
    "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"
  }
}

GET /transcription_flows/:id

Authorization Required

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

Get Transcription Flow by id.

Retrieve a single transcription flow by id.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "transcription_flow": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "TranscriptionFlow",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "transcription_flow_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "sortable_order": -1,
    "name": "Transcribe Recordings",
    "recording_types": [
      "call",
      "consumer_and_agent",
      "consumer_and_buyer"
    ],
    "description": null,
    "transcription_keyword_group_id": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
    "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"
  }
}

PUT /transcription_flows/:id

Authorization Required

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

Update Transcription Flow by id.

Change a transcription flow's recording types, analysis options, or the token filter that scopes which calls it applies to.

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 -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Transcribes calls and flags compliance keywords (updated)."
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "transcription_flow": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "TranscriptionFlow",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "transcription_flow_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "sortable_order": -3,
    "name": "Example Transcription Flow",
    "recording_types": [
      "call"
    ],
    "description": "Transcribes calls and flags compliance keywords (updated).",
    "transcription_keyword_group_id": null,
    "schedule_action_group_id": null,
    "redact_pii": null,
    "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"
  }
}

DELETE /transcription_flows/:id

Authorization Required

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

Destroy Transcription Flow by id.

Permanently delete a transcription flow.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "transcription_flow": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "TranscriptionFlow",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": "/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/transcription_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "transcription_flow_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "sortable_order": -3,
    "name": "Example Transcription Flow",
    "recording_types": [
      "call"
    ],
    "description": "Transcribes calls and flags compliance keywords.",
    "transcription_keyword_group_id": null,
    "schedule_action_group_id": null,
    "redact_pii": null,
    "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"
  }
}

Params

Must be any combination of:

Params

Params

Params