Skip to content

Commit a96ac79

Browse files
yaniv-golangithub-actions[bot]
yaniv-golan
authored and
github-actions[bot]
committed
chore: sync Affinity API docs
1 parent c185eaa commit a96ac79

File tree

2 files changed

+500
-1
lines changed

2 files changed

+500
-1
lines changed

‎docs/v2/affinity_api_docs.md‎

Lines changed: 342 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This markdown version of the Affinity API v2 documentation was generated automat
2424

2525
> **Note:** The live site renders dynamic multi-language request/response samples in-browser. Because those snippets are generated at runtime and are not embedded in the OpenAPI payload, they cannot be mirrored here. Refer to https://developer.affinity.co/ for the full interactive samples.
2626

27-
**Documentation Version:** This copy is based on the official documentation as it appeared on **December 16, 2025 at 18:11:26 UTC** (Last updated: 12/16/2025 18:11:26 UTC).
27+
**Documentation Version:** This copy is based on the official documentation as it appeared on **December 18, 2025 at 18:07:57 UTC** (Last updated: 12/18/2025 18:07:57 UTC).
2828
**Snapshot:** Captured HTML `developer_affinity_co.html` (archived with the sync artifacts for QA).
2929

3030
> **⚠️ Use at Your Own Risk**
@@ -326,6 +326,11 @@ This markdown version of the Affinity API v2 documentation was generated automat
326326
- [Path Parameters](#path-parameters-30)
327327
- [Example Request](#example-request-49)
328328
- [Responses](#responses-49)
329+
- [Get fragments of a transcript](#get-fragments-of-a-transcript)
330+
- [Path Parameters](#path-parameters-31)
331+
- [Query Parameters](#query-parameters-36)
332+
- [Example Request](#example-request-50)
333+
- [Responses](#responses-50)
329334
- [Schema Reference](#schema-reference)
330335
- [Attendee](#attendee)
331336
- [AttendeesPreview](#attendeespreview)
@@ -470,6 +475,7 @@ This markdown version of the Affinity API v2 documentation was generated automat
470475
- [notes.UserReplyNote](#notesuserreplynote)
471476
- [transcripts.BaseTranscript](#transcriptsbasetranscript)
472477
- [transcripts.Fragment](#transcriptsfragment)
478+
- [transcripts.FragmentPaged](#transcriptsfragmentpaged)
473479
- [transcripts.FragmentsPreview](#transcriptsfragmentspreview)
474480
- [transcripts.Transcript](#transcriptstranscript)
475481
- [transcripts.TranscriptPaged](#transcriptstranscriptpaged)
@@ -20180,6 +20186,312 @@ Errors
2018020186
| `X-Ratelimit-Limit-Org-Remaining` | `integer` | Number of requests remaining for the account |
2018120187
| `X-Ratelimit-Limit-Org-Reset` | `integer` | Time in seconds before the limit resets for the account |
2018220188

20189+
### Get fragments of a transcript
20190+
`GET /v2/transcripts/{transcriptId}/fragments`
20191+
20192+
- **Tag:** transcripts · **OperationId:** v2_transcripts_transcriptId_fragments__GET · **Stability:** `beta` · **Auth:** bearerAuth
20193+
20194+
Get fragments of a transcript given a transcript id.
20195+
20196+
#### Path Parameters
20197+
| Name | Type | Required | Description |
20198+
| --- | --- | --- | --- |
20199+
| `transcriptId` | `integer<int32>` | Yes | The id of the Transcript |
20200+
20201+
#### Query Parameters
20202+
| Name | Type | Required | Description |
20203+
| --- | --- | --- | --- |
20204+
| `cursor` | `string` | No | Cursor for the next or previous page |
20205+
| `limit` | `integer<int32>` | No | Number of items to include in the page |
20206+
| `totalCount` | `boolean` | No | Include total count of the collection in the pagination response |
20207+
20208+
#### Example Request
20209+
20210+
```bash
20211+
curl --request GET 'https://api.affinity.co/v2/transcripts/{transcriptId}/fragments' \
20212+
--header 'Authorization: Bearer YOUR_API_KEY'
20213+
```
20214+
20215+
#### Responses
20216+
20217+
##### 200 — application/json
20218+
20219+
OK
20220+
20221+
**Response schema (`application/json`):**
20222+
###### Schema: transcripts.FragmentPaged
20223+
*Type:* object
20224+
transcripts.FragmentPaged model
20225+
**Properties**
20226+
| Field | Type | Required | Description |
20227+
| --- | --- | --- | --- |
20228+
| `data` | `array<object> (≤ 100 items)` | Yes | A page of Fragments for a transcript |
20229+
| `pagination` | `object` | Yes | |
20230+
20231+
**`data` details** — See [transcripts.Fragment](#transcriptsfragment)
20232+
20233+
**Items**
20234+
20235+
**Properties**
20236+
| Field | Type | Required | Description |
20237+
| --- | --- | --- | --- |
20238+
| `content` | `string` | Yes | The dialogue fragment of the transcript |
20239+
| `speaker` | `string` | Yes | The speaker of the dialogue fragment |
20240+
| `startTimestamp` | `string` | Yes | The starting timestamp of the dialogue fragment relative to the beginning of the transcript |
20241+
| `endTimestamp` | `string` | Yes | The ending timestamp of the dialogue fragment relative to the beginning of the transcript |
20242+
20243+
**`pagination` details** — See [PaginationWithTotalCount](#paginationwithtotalcount)
20244+
20245+
**Properties**
20246+
| Field | Type | Required | Description |
20247+
| --- | --- | --- | --- |
20248+
| `totalCount` | `integer<int64>` | No | The total count of the collection. Only included if requested via the totalCount query string parameter. (Constraints: ≥ 0; ≤ 9007199254740991) |
20249+
| `prevUrl` | `string/null<uri>` | No | URL for the previous page |
20250+
| `nextUrl` | `string/null<uri>` | No | URL for the next page |
20251+
20252+
Example: success
20253+
20254+
```json
20255+
{
20256+
"data": [
20257+
{
20258+
"content": "I want the most intelligent hamster you've got.",
20259+
"endTimestamp": "00:00:04",
20260+
"speaker": "Lisa Simpson",
20261+
"startTimestamp": "00:00:01"
20262+
},
20263+
{
20264+
"content": "Okay. Uh-- this little guy writes mysteries under the name of J.D. MacGregor.",
20265+
"endTimestamp": "00:00:11",
20266+
"speaker": "Sarcastic Clerk",
20267+
"startTimestamp": "00:00:05"
20268+
},
20269+
{
20270+
"content": "How can a hamster write mysteries?",
20271+
"endTimestamp": "00:00:13",
20272+
"speaker": "Lisa Simpson",
20273+
"startTimestamp": "00:00:12"
20274+
},
20275+
{
20276+
"content": "Well he gets the ending first then he works backward.",
20277+
"endTimestamp": "00:00:19",
20278+
"speaker": "Sarcastic Clerk",
20279+
"startTimestamp": "00:00:15"
20280+
}
20281+
],
20282+
"pagination": {
20283+
"nextUrl": "https://api.affinity.co/v2/transcripts/1/fragments?cursor=ICAgICAgIGFmdGVyOjo6NA",
20284+
"prevUrl": "https://api.affinity.co/v2/transcripts/1/fragments?cursor=ICAgICAgYmVmb3JlOjo6Nw",
20285+
"totalCount": 4
20286+
}
20287+
}
20288+
```
20289+
20290+
**Response Headers**
20291+
| Header | Type | Description |
20292+
| --- | --- | --- |
20293+
| `X-Ratelimit-Limit-User` | `integer` | Number of requests allowed per minute for the user |
20294+
| `X-Ratelimit-Limit-User-Remaining` | `integer` | Number of requests remaining for the user |
20295+
| `X-Ratelimit-Limit-User-Reset` | `integer` | Time in seconds before the limit resets for the user |
20296+
| `X-Ratelimit-Limit-Org` | `integer` | Number of requests allowed per month for the account |
20297+
| `X-Ratelimit-Limit-Org-Remaining` | `integer` | Number of requests remaining for the account |
20298+
| `X-Ratelimit-Limit-Org-Reset` | `integer` | Time in seconds before the limit resets for the account |
20299+
20300+
##### 400 — application/json
20301+
20302+
Bad Request
20303+
20304+
**Response schema (`application/json`):**
20305+
###### Schema: responses.400
20306+
*Type:* object
20307+
**Properties**
20308+
| Field | Type | Required | Description |
20309+
| --- | --- | --- | --- |
20310+
| `errors` | `array<oneOf>` | Yes | |
20311+
20312+
**`errors` details**
20313+
20314+
**Items**
20315+
20316+
**Variant:** BadRequestError
20317+
**Properties**
20318+
| Field | Type | Required | Description |
20319+
| --- | --- | --- | --- |
20320+
| `code` | `string` | Yes | Error code |
20321+
| `message` | `string` | Yes | Error message |
20322+
**Variant:** ValidationError
20323+
**Properties**
20324+
| Field | Type | Required | Description |
20325+
| --- | --- | --- | --- |
20326+
| `code` | `string` | Yes | Error code |
20327+
| `message` | `string` | Yes | Error message |
20328+
| `param` | `string` | Yes | Param the error refers to |
20329+
20330+
**Response Headers**
20331+
| Header | Type | Description |
20332+
| --- | --- | --- |
20333+
| `X-Ratelimit-Limit-User` | `integer` | Number of requests allowed per minute for the user |
20334+
| `X-Ratelimit-Limit-User-Remaining` | `integer` | Number of requests remaining for the user |
20335+
| `X-Ratelimit-Limit-User-Reset` | `integer` | Time in seconds before the limit resets for the user |
20336+
| `X-Ratelimit-Limit-Org` | `integer` | Number of requests allowed per month for the account |
20337+
| `X-Ratelimit-Limit-Org-Remaining` | `integer` | Number of requests remaining for the account |
20338+
| `X-Ratelimit-Limit-Org-Reset` | `integer` | Time in seconds before the limit resets for the account |
20339+
20340+
##### 404 — application/json
20341+
20342+
Not Found
20343+
20344+
**Response schema (`application/json`):**
20345+
###### Schema: NotFoundErrors
20346+
*Type:* object
20347+
**Properties**
20348+
| Field | Type | Required | Description |
20349+
| --- | --- | --- | --- |
20350+
| `errors` | `array<object>` | Yes | NotFoundError errors |
20351+
20352+
**`errors` details** — See [NotFoundError](#notfounderror)
20353+
20354+
**Items**
20355+
20356+
**Properties**
20357+
| Field | Type | Required | Description |
20358+
| --- | --- | --- | --- |
20359+
| `code` | `string` | Yes | Error code |
20360+
| `message` | `string` | Yes | Error message |
20361+
20362+
Example
20363+
20364+
```json
20365+
{
20366+
"errors": [
20367+
{
20368+
"code": "not-found",
20369+
"message": "🚨 Error! Sound the alarm! 🚨"
20370+
},
20371+
{
20372+
"code": "not-found",
20373+
"message": "🚨 Error! Sound the alarm! 🚨"
20374+
}
20375+
]
20376+
}
20377+
```
20378+
20379+
**Response Headers**
20380+
| Header | Type | Description |
20381+
| --- | --- | --- |
20382+
| `X-Ratelimit-Limit-User` | `integer` | Number of requests allowed per minute for the user |
20383+
| `X-Ratelimit-Limit-User-Remaining` | `integer` | Number of requests remaining for the user |
20384+
| `X-Ratelimit-Limit-User-Reset` | `integer` | Time in seconds before the limit resets for the user |
20385+
| `X-Ratelimit-Limit-Org` | `integer` | Number of requests allowed per month for the account |
20386+
| `X-Ratelimit-Limit-Org-Remaining` | `integer` | Number of requests remaining for the account |
20387+
| `X-Ratelimit-Limit-Org-Reset` | `integer` | Time in seconds before the limit resets for the account |
20388+
20389+
##### DEFAULT — application/json
20390+
20391+
Errors
20392+
20393+
**Response schema (`application/json`):**
20394+
###### Schema: Errors
20395+
*Type:* object
20396+
**Properties**
20397+
| Field | Type | Required | Description |
20398+
| --- | --- | --- | --- |
20399+
| `errors` | `array<oneOf>` | Yes | Errors |
20400+
20401+
**`errors` details** — See [Error](#error)
20402+
20403+
**Items**
20404+
20405+
**Variant:** AuthenticationError
20406+
**Properties**
20407+
| Field | Type | Required | Description |
20408+
| --- | --- | --- | --- |
20409+
| `code` | `string` | Yes | Error code |
20410+
| `message` | `string` | Yes | Error message |
20411+
**Variant:** AuthorizationError
20412+
**Properties**
20413+
| Field | Type | Required | Description |
20414+
| --- | --- | --- | --- |
20415+
| `code` | `string` | Yes | Error code |
20416+
| `message` | `string` | Yes | Error message |
20417+
**Variant:** BadRequestError
20418+
**Properties**
20419+
| Field | Type | Required | Description |
20420+
| --- | --- | --- | --- |
20421+
| `code` | `string` | Yes | Error code |
20422+
| `message` | `string` | Yes | Error message |
20423+
**Variant:** ConflictError
20424+
**Properties**
20425+
| Field | Type | Required | Description |
20426+
| --- | --- | --- | --- |
20427+
| `code` | `string` | Yes | Error code |
20428+
| `message` | `string` | Yes | Error message |
20429+
**Variant:** MethodNotAllowedError
20430+
**Properties**
20431+
| Field | Type | Required | Description |
20432+
| --- | --- | --- | --- |
20433+
| `code` | `string` | Yes | Error code |
20434+
| `message` | `string` | Yes | Error message |
20435+
**Variant:** NotAcceptableError
20436+
**Properties**
20437+
| Field | Type | Required | Description |
20438+
| --- | --- | --- | --- |
20439+
| `code` | `string` | Yes | Error code |
20440+
| `message` | `string` | Yes | Error message |
20441+
**Variant:** NotFoundError
20442+
**Properties**
20443+
| Field | Type | Required | Description |
20444+
| --- | --- | --- | --- |
20445+
| `code` | `string` | Yes | Error code |
20446+
| `message` | `string` | Yes | Error message |
20447+
**Variant:** NotImplementedError
20448+
**Properties**
20449+
| Field | Type | Required | Description |
20450+
| --- | --- | --- | --- |
20451+
| `code` | `string` | Yes | Error code |
20452+
| `message` | `string` | Yes | Error message |
20453+
**Variant:** RateLimitError
20454+
**Properties**
20455+
| Field | Type | Required | Description |
20456+
| --- | --- | --- | --- |
20457+
| `code` | `string` | Yes | Error code |
20458+
| `message` | `string` | Yes | Error message |
20459+
**Variant:** ServerError
20460+
**Properties**
20461+
| Field | Type | Required | Description |
20462+
| --- | --- | --- | --- |
20463+
| `code` | `string` | Yes | Error code |
20464+
| `message` | `string` | Yes | Error message |
20465+
**Variant:** UnprocessableEntityError
20466+
**Properties**
20467+
| Field | Type | Required | Description |
20468+
| --- | --- | --- | --- |
20469+
| `code` | `string` | Yes | Error code |
20470+
| `message` | `string` | Yes | Error message |
20471+
**Variant:** UnsupportedMediaTypeError
20472+
**Properties**
20473+
| Field | Type | Required | Description |
20474+
| --- | --- | --- | --- |
20475+
| `code` | `string` | Yes | Error code |
20476+
| `message` | `string` | Yes | Error message |
20477+
**Variant:** ValidationError
20478+
**Properties**
20479+
| Field | Type | Required | Description |
20480+
| --- | --- | --- | --- |
20481+
| `code` | `string` | Yes | Error code |
20482+
| `message` | `string` | Yes | Error message |
20483+
| `param` | `string` | Yes | Param the error refers to |
20484+
20485+
**Response Headers**
20486+
| Header | Type | Description |
20487+
| --- | --- | --- |
20488+
| `X-Ratelimit-Limit-User` | `integer` | Number of requests allowed per minute for the user |
20489+
| `X-Ratelimit-Limit-User-Remaining` | `integer` | Number of requests remaining for the user |
20490+
| `X-Ratelimit-Limit-User-Reset` | `integer` | Time in seconds before the limit resets for the user |
20491+
| `X-Ratelimit-Limit-Org` | `integer` | Number of requests allowed per month for the account |
20492+
| `X-Ratelimit-Limit-Org-Remaining` | `integer` | Number of requests remaining for the account |
20493+
| `X-Ratelimit-Limit-Org-Reset` | `integer` | Time in seconds before the limit resets for the account |
20494+
2018320495
## Schema Reference
2018420496
### Attendee
2018520497
**Properties**
@@ -25071,6 +25383,35 @@ A person mentioned in a note.
2507125383
| `speaker` | `string` | Yes | The speaker of the dialogue fragment |
2507225384
| `startTimestamp` | `string` | Yes | The starting timestamp of the dialogue fragment relative to the beginning of the transcript |
2507325385
| `endTimestamp` | `string` | Yes | The ending timestamp of the dialogue fragment relative to the beginning of the transcript |
25386+
### transcripts.FragmentPaged
25387+
transcripts.FragmentPaged model
25388+
transcripts.FragmentPaged model
25389+
**Properties**
25390+
| Field | Type | Required | Description |
25391+
| --- | --- | --- | --- |
25392+
| `data` | `array<object> (≤ 100 items)` | Yes | A page of Fragments for a transcript |
25393+
| `pagination` | `object` | Yes | |
25394+
25395+
**`data` details** — See [transcripts.Fragment](#transcriptsfragment)
25396+
25397+
**Items**
25398+
25399+
**Properties**
25400+
| Field | Type | Required | Description |
25401+
| --- | --- | --- | --- |
25402+
| `content` | `string` | Yes | The dialogue fragment of the transcript |
25403+
| `speaker` | `string` | Yes | The speaker of the dialogue fragment |
25404+
| `startTimestamp` | `string` | Yes | The starting timestamp of the dialogue fragment relative to the beginning of the transcript |
25405+
| `endTimestamp` | `string` | Yes | The ending timestamp of the dialogue fragment relative to the beginning of the transcript |
25406+
25407+
**`pagination` details** — See [PaginationWithTotalCount](#paginationwithtotalcount)
25408+
25409+
**Properties**
25410+
| Field | Type | Required | Description |
25411+
| --- | --- | --- | --- |
25412+
| `totalCount` | `integer<int64>` | No | The total count of the collection. Only included if requested via the totalCount query string parameter. (Constraints: ≥ 0; ≤ 9007199254740991) |
25413+
| `prevUrl` | `string/null<uri>` | No | URL for the previous page |
25414+
| `nextUrl` | `string/null<uri>` | No | URL for the next page |
2507425415
### transcripts.FragmentsPreview
2507525416
A preview for dialogue fragments on a transcript
2507625417
A preview for dialogue fragments on a transcript

0 commit comments

Comments
 (0)