HubSpot: Retrieve transcript
HubSpot transcriptions.getTranscript: arguments, response, policy and SDK examples.
← Transcriptions operations · Get started
Operation hubspot.transcriptions_get_transcript
Provider route: GET /crm/extensions/calling/2026-09/transcripts/{transcriptId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["transcriptions"]["getTranscript"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.transcriptions.getTranscript(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.transcriptions.get_transcript(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.transcriptId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve transcript — response body |
Referenced models: Retrieve transcript — response body
Schemas
Section titled “Schemas”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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.transcriptions_get_transcript. Catalog operation: transcriptions_get_transcript. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["crm.extensions_calling_transcripts.read"]