Affinity logo

transcripts

Operations about transcripts

Get all Transcripts

Paginate through all transcripts and return basic metadata only. Use the single transcript endpoint to fetch the entire transcript data. Will only return transcripts that the current authenticated user has permission to see.

You can filter transcripts using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties.

Property Name Description Type Allowed Operators Examples
id Filter transcripts by id int32 = id=1
createdAt Filter transcripts by when it was created datetime >, <, >=, <= createdAt<2025-02-04T10:48:24Z
SecuritybearerAuth
Request
query Parameters
totalCount
boolean
Default: false

Include total count of the collection in the pagination response

cursor
string

Cursor for the next or previous page

limit
integer <int32> [ 0 .. 100 ]
Default: 20

Number of items to include in the page

filter
string

Filter options

Responses
200

OK

Response Headers
X-Ratelimit-Limit-User
integer

Number of requests allowed per minute for the user

X-Ratelimit-Limit-User-Remaining
integer

Number of requests remaining for the user

X-Ratelimit-Limit-User-Reset
integer

Time in seconds before the limit resets for the user

X-Ratelimit-Limit-Org
integer

Number of requests allowed per month for the account

X-Ratelimit-Limit-Org-Remaining
integer

Number of requests remaining for the account

X-Ratelimit-Limit-Org-Reset
integer

Time in seconds before the limit resets for the account

Response Schema: application/json
required
Array of objects (transcripts.BaseTranscript) <= 100 items

A page of Transcript results

Array (<= 100 items)
id
required
integer <int32> [ 1 .. 2147483647 ]

The transcript's unique identifier

required
notes.AiNotetakerRootNote (object) or notes.AiNotetakerReplyNote (object)

Note associated with the transcript

createdAt
required
string <date-time>

The date and time the transcript was created

languageCode
required
string

The language code of the transcript

Enum: "de" "en" "es" "fr" "id" "it" "ja" "ko" "nl" "pt" "ru" "sv" "uk" "zh"
required
object (PaginationWithTotalCount)
totalCount
integer <int64> [ 0 .. 9007199254740991 ]

The total count of the collection. Only included if requested via the totalCount query string parameter.

prevUrl
string or null <uri>

URL for the previous page

nextUrl
string or null <uri>

URL for the next page

400

Bad Request

default

Errors

get/v2/transcripts
Request samples 
Response samples 
application/json
Example response for transcripts.


{
  • "data": [
    ],
  • "pagination": {}
}
Get a single Transcript
Get a transcript with a given id with the first 100 fragments of the transcript. Use the /fragments endpoint to fetch all fragments of the transcript.


SecuritybearerAuth 
Request 
path Parameters
transcriptId
required
integer <int32>   [ 1 .. 2147483647 ] 
The id of the Transcript


 
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
required
object (transcripts.FragmentsPreview) 
A preview for dialogue fragments on a transcript


 
Array of objects (transcripts.Fragment)   <= 100 items 
Preview of dialogue fragments on a transcript


 
totalCount
integer <int64>   [ 0 .. 9007199254740991 ] 
The total count of the collection parameter.


 
id
required
integer <int32>   [ 1 .. 2147483647 ] 
The transcript's unique identifier


 
required
notes.AiNotetakerRootNote (object) or notes.AiNotetakerReplyNote (object)
Note associated with the transcript


 
One of:
A Root Note object created by the AI Notetaker


type
required
string
The type of the note


 
 Value:  "ai-notetaker"
object (notes.MeetingInteraction) 
The meeting this AI Notetaker was invited to.


 
repliesCount
integer <int32>   [ 0 .. 2147483647 ] 
The number of replies to this note. This is only included if the repliesCount parameter is passed in the includes in the request and the note is not a reply itself.


 
object (notes.PermissionSettings) 
The permission settings of a note


 
object (notes.OpportunitiesPreview) 
A preview for attached Opportunities on a Note


 
object (notes.PersonsPreview) 
A preview for attached Persons on a Note


 
object (notes.CompaniesPreview) 
A preview for attached Companies on a Note


 
id
required
integer <int32>   [ 1 .. 2147483647 ] 
The id of the note


 
required
object (notes.Content) 
A note content


 
required
object (PersonData) 
 
required
Array of any (notes.Mention)   <= 100 items 
The mentions in the note


 
createdAt
required
string <date-time> 
The date and time the note was created


 
updatedAt
required
string or null <date-time> 
The date and time the note was last updated


 
createdAt
required
string <date-time> 
The date and time the transcript was created


 
languageCode
required
string
The language code of the transcript


 Enum: "de" "en" "es" "fr" "id" "it" "ja" "ko" "nl" "pt" "ru" "sv" "uk" "zh"  
400
Bad Request


404
Not Found


default
Errors


get/v2/transcripts/{transcriptId}
Request samples 
Response samples 
application/json
Example response for a transcript.


{
  • "id": 1,
  • "fragmentsPreview": {
    },
  • "note": {
    },
  • "languageCode": "en",
  • "createdAt": "2023-01-01T00:00:00Z"
}
Get fragments of a transcript
Get fragments of a transcript given a transcript id.


SecuritybearerAuth 
Request 
path Parameters
transcriptId
required
integer <int32>   [ 1 .. 2147483647 ] 
The id of the Transcript


 
query Parameters
cursor
string
Cursor for the next or previous page


 
limit
integer <int32>   [ 0 .. 100 ] 
 Default:  20
Number of items to include in the page


 
totalCount
boolean
 Default:  false
Include total count of the collection in the pagination response


 
Responses 
200
OK


 Response Headers 
X-Ratelimit-Limit-User
integer
Number of requests allowed per minute for the user


 
X-Ratelimit-Limit-User-Remaining
integer
Number of requests remaining for the user


 
X-Ratelimit-Limit-User-Reset
integer
Time in seconds before the limit resets for the user


 
X-Ratelimit-Limit-Org
integer
Number of requests allowed per month for the account


 
X-Ratelimit-Limit-Org-Remaining
integer
Number of requests remaining for the account


 
X-Ratelimit-Limit-Org-Reset
integer
Time in seconds before the limit resets for the account


 
Response Schema: application/json
required
Array of objects (transcripts.Fragment)   <= 100 items 
A page of Fragments for a transcript


 
 Array (<= 100 items)
content
required
string
The dialogue fragment of the transcript


 
speaker
required
string
The speaker of the dialogue fragment


 
startTimestamp
required
string
The starting timestamp of the dialogue fragment relative to the beginning of the transcript


 
endTimestamp
required
string
The ending timestamp of the dialogue fragment relative to the beginning of the transcript


 
required
object (PaginationWithTotalCount) 
 
totalCount
integer <int64>   [ 0 .. 9007199254740991 ] 
The total count of the collection. Only included if requested via the totalCount query string parameter.


 
prevUrl
string or null <uri> 
URL for the previous page


 
nextUrl
string or null <uri> 
URL for the next page


 
400
Bad Request


404
Not Found


default
Errors


get/v2/transcripts/{transcriptId}/fragments
Request samples 
Response samples 
application/json
Example response for a paginated fragments response given a transcript id.


{
  • "data": [
    ],
  • "pagination": {}
}