HubSpot: Transcriptions schemas

← Transcriptions operations · All schemas

Create Transcript — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
engagementId	integer	Required within parent	The unique identifier for the engagement associated with this transcript. It is an integer in int64 format. Format: int64
transcriptCreateUtterances	array	Required within parent	An array of utterances that make up the transcript. Each utterance is represented by a TranscriptCreateUtterance object.
transcriptCreateUtterances[]	Model	Each item	Expand Create Transcript — request body — body transcript Create Utterances item

Referenced models: Create Transcript — request body — body transcript Create Utterances item

Create Transcript — request body — body transcript Create Utterances item

Field	Type	Presence	Description and constraints
$	object	Root
endTimeMillis	integer	Required within parent	The end time of the utterance in milliseconds, represented as an integer. Format: int64
languageCode	string	Optional	The language code of the utterance, represented as a string.
speaker	Model	Required within parent	Expand Retrieve transcript — response body — transcript Utterances item speaker
startTimeMillis	integer	Required within parent	The start time of the utterance in milliseconds, represented as an integer. Format: int64
text	string	Required within parent	The content of the utterance as a string.

Referenced models: Retrieve transcript — response body — transcript Utterances item speaker

Create Transcript — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the created transcript, represented as a string.

Retrieve transcript — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The date and time when this transcript was created, in ISO 8601 date-time format. Format: date-time
engagementId	JSON	Required within parent
engagementId (anyOf 1)	integer	Alternative	The unique identifier for the engagement associated with this transcript. It is an integer in int64 format. Format: int64
engagementId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	The unique identifier for this transcript, represented as a string.
transcriptSource	string	Required within parent	Indicates the origin of the transcript, which can be either 'HUBSPOT_GENERATED' or 'INTEGRATOR_GENERATED'. Known values: HUBSPOT_GENERATED, INTEGRATOR_GENERATED
transcriptUtterances	array	Required within parent	An array of utterances that make up the transcript. Each utterance contains details such as text, timing, and speaker information.
transcriptUtterances[]	Model	Each item	Expand Retrieve transcript — response body — transcript Utterances item
updatedAt	string	Required within parent	The date and time when this transcript was last updated, in ISO 8601 date-time format. Format: date-time

Referenced models: Retrieve transcript — response body — transcript Utterances item

Retrieve transcript — response body — transcript Utterances item

Field	Type	Presence	Description and constraints
$	object	Root
endTimeMillis	JSON	Required within parent
endTimeMillis (anyOf 1)	integer	Alternative	The end time of the utterance, given as a Unix timestamp in milliseconds. It marks when the utterance ended. Format: int64
endTimeMillis (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	A unique identifier for the utterance, represented as a string.
languageCode	string	Optional	The language code of the utterance, represented as a string. This indicates the language in which the text was spoken.
speaker	Model	Optional	Expand Retrieve transcript — response body — transcript Utterances item speaker
startTimeMillis	JSON	Required within parent
startTimeMillis (anyOf 1)	integer	Alternative	The start time of the utterance, given as a Unix timestamp in milliseconds. It marks when the utterance began. Format: int64
startTimeMillis (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
text	string	Required within parent	The spoken text of the utterance. It is a string representing the actual words spoken.

Referenced models: Retrieve transcript — response body — transcript Utterances item speaker

Retrieve transcript — response body — transcript Utterances item speaker

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Optional	The email address of the speaker, represented as a string.
id	string	Required within parent	A unique identifier for the speaker, represented as a string.
name	string	Required within parent	The name of the speaker, represented as a string.