> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hihobbes.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve a session transcript
> Return ordered conversation turns for one session.
Requires `transcripts:read`.
Entries are ordered by `sequenceNumber`. A successful request consumes one of
the organization's 2,000 daily transcript reads. Invalid ids and `404` responses
do not consume quota.
Transcript text can contain prospect PII. Prefer derived session fields unless
the integration needs the original conversation.
## OpenAPI
````yaml api-reference/openapi.json GET /api/v1/sessions/{session_id}/transcript
openapi: 3.1.0
info:
title: Hobbes API
description: >
Use the Hobbes API to read your organization's analyzed demo sessions,
prospects, accounts, transcripts, and funnel metrics, and to create and
manage
personalized Custom Links.
**Authentication**: create an API key in Settings → API Keys, then send it
as `Authorization: Bearer ` (or `x-api-key: `). Keys are
org-scoped; responses only ever contain your organization's data.
**Scopes**: keys carry scopes (`sessions:read`, `people:read`,
`accounts:read`, `analytics:read`, `transcripts:read`, `custom_links:read`,
`custom_links:write`). `custom_links:write` also satisfies read access. Raw
transcript access is a separate opt-in scope with a daily quota. Existing
API
keys do not receive Custom Link scopes automatically.
**Rate limits**: keys allow 120 requests per minute by default. Responses
include `X-RateLimit-Limit` and `X-RateLimit-Remaining`; 429 responses
include
`Retry-After`. Transcript access has a separate quota of 2,000 reads per
organization per UTC day. Custom Link mutations are limited to 10 requests
per
minute per organization. Creation and thumbnail rendering also use weighted
hourly and daily organization quotas, so one request containing 500 links is
one HTTP request but consumes up to 500 creation and 500 render units.
**Support**: every response carries an `X-Request-ID` header. Include it
when
reporting an issue so we can find the exact request in our logs.
**Stability**: changes within v1 are additive only. Fields may be added to
responses; existing fields are never removed or renamed.
version: 1.0.0
servers:
- url: https://api-us.hihobbes.com
description: Production
security:
- bearer: []
- apiKeyHeader: []
tags:
- name: Sessions
description: Analyzed demo sessions and their transcripts.
- name: People
description: Prospect profiles aggregated across sessions.
- name: Accounts
description: Company-level engagement rollups by email domain.
- name: Metrics
description: Aggregate funnel performance over a trailing window.
- name: Custom Links
description: Create and manage personalized links.
- name: Custom Link Jobs
description: Poll, cancel, and retry asynchronous Custom Link work.
- name: Custom Link Campaigns
description: Organize Custom Links into campaigns.
paths:
/api/v1/sessions/{session_id}/transcript:
get:
tags:
- Sessions
summary: Retrieve a session transcript
description: >-
Return the ordered conversation transcript. Requires `transcripts:read`
and counts against the 2,000-read daily organization quota.
operationId: v1_get_session_transcript
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
description: Hobbes session UUID.
description: Hobbes session UUID.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TranscriptResponse'
headers:
X-Request-ID:
description: Unique request identifier to include in support requests.
schema:
type: string
example: req_01JABCDEF23456789
X-RateLimit-Limit:
description: Request limit for this key in the current 60-second window.
schema:
type: integer
example: 120
X-RateLimit-Remaining:
description: Requests remaining for this key in the current window.
schema:
type: integer
example: 119
'401':
description: API key required or invalid.
headers:
X-Request-ID:
description: Unique request identifier to include in support requests.
schema:
type: string
example: req_01JABCDEF23456789
content:
application/json:
schema:
type: object
required:
- detail
properties:
detail:
type: string
example: API key required or invalid.
'403':
description: API key does not include the required scope.
headers:
X-Request-ID:
description: Unique request identifier to include in support requests.
schema:
type: string
example: req_01JABCDEF23456789
content:
application/json:
schema:
type: object
required:
- detail
properties:
detail:
type: string
example: API key does not include the required scope.
'404':
description: Session not found or outside the key's organization.
headers:
X-Request-ID:
description: Unique request identifier to include in support requests.
schema:
type: string
example: req_01JABCDEF23456789
content:
application/json:
schema:
type: object
required:
- detail
properties:
detail:
type: string
example: Session not found or outside the key's organization.
'422':
description: A path, query, header, or request field failed validation.
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
headers:
X-Request-ID:
description: Unique request identifier to include in support requests.
schema:
type: string
example: req_01JABCDEF23456789
'429':
description: Rate limit or organization quota exceeded.
headers:
X-Request-ID:
description: Unique request identifier to include in support requests.
schema:
type: string
example: req_01JABCDEF23456789
X-RateLimit-Limit:
description: Request limit for this key in the current 60-second window.
schema:
type: integer
example: 120
X-RateLimit-Remaining:
description: Requests remaining for this key in the current window.
schema:
type: integer
example: 119
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
example: 30
X-RateLimit-Reset:
description: Unix timestamp when the limiting window resets.
schema:
type: integer
content:
application/json:
schema:
type: object
required:
- detail
properties:
detail:
type: string
example: Rate limit or organization quota exceeded.
components:
schemas:
TranscriptResponse:
properties:
sessionId:
type: string
title: Sessionid
description: Session UUID associated with the transcript.
examples:
- 018f3f6a-0d7b-7f56-bb2a-54c91e57a202
entries:
items:
$ref: '#/components/schemas/TranscriptEntry'
type: array
title: Entries
description: Ordered transcript turns.
total:
type: integer
title: Total
description: Number of transcript turns returned.
examples:
- 42
type: object
required:
- sessionId
- entries
- total
title: TranscriptResponse
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
TranscriptEntry:
properties:
speaker:
anyOf:
- type: string
- type: 'null'
title: Speaker
description: Normalized speaker label.
examples:
- prospect
text:
anyOf:
- type: string
- type: 'null'
title: Text
description: Transcript text for this turn.
examples:
- Can we send qualified sessions to our CRM?
timestamp:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Timestamp
description: Turn timestamp when available.
examples:
- '2026-07-10T18:46:02Z'
sequenceNumber:
anyOf:
- type: integer
- type: 'null'
title: Sequencenumber
description: Stable chronological turn number.
examples:
- 12
type: object
title: TranscriptEntry
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
bearer:
type: http
scheme: bearer
description: Hobbes API key with the `hb_live_` prefix.
apiKeyHeader:
type: apiKey
in: header
name: x-api-key
description: Alternative to the Bearer authorization header.
````