v3

latestSwagger 2.02026-08-067506752.0 MB

transcript

Create a transcript

post/v1/org/{orgId}/transcript

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

calendarEntryIdstring

optional calendar entry ID

externalCalendarEntryIdstring

optional external calendar event id from the recording system (e.g. the Google Calendar event id)

externalIdstring required

external ID of the recording

externalUrlstring

URL to view/watch the recording on the external system

recordingSystemstring required

system type used to record

startAtstring required

timestamp of the start time (inclusive)

untilAtstring required

timestamp of the ending time (exclusive)

tagsstring[]

tags on the transcript, such as customer name

languagestring

ISO 639-1 (two-letter) language code of the meeting

labelstring required

meeting title

descriptionstring

very short description of the meeting discussion (1-3 sentences)

summarystring

detailed summary of the meeting discussion (a few paragraphs)

sensitivity level of the transcript

Example request

{
  "calendarEntryId": "588f7ee98f138b19220041a7",
  "externalUrl": "https://app.gong.io/call?id=7815638069569786872",
  "recordingSystem": "gong",
  "startAt": "2017-01-24T13:57:52Z",
  "untilAt": "2017-01-24T14:57:52Z",
  "attendees": [
    {
      "personId": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7"
    }
  ],
  "language": "en",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ]
}

Response

transcript created

idstring required

globally unique id

orgIdstring required

parent organization id

calendarEntryIdstring

optional calendar entry ID

externalCalendarEntryIdstring

optional external calendar event id from the recording system (e.g. the Google Calendar event id)

externalIdstring required

external ID of the recording

externalUrlstring

URL to view/watch the recording on the external system

recordingSystemstring required

system type used to record

startAtstring required

timestamp of the start time (inclusive)

untilAtstring required

timestamp of the ending time (exclusive)

tagsstring[]

tags on the transcript, such as customer name

languagestring

ISO 639-1 (two-letter) language code of the meeting

labelstring required

meeting title

descriptionstring

very short description of the meeting discussion (1-3 sentences)

summarystring

detailed summary of the meeting discussion (a few paragraphs)

hasTranscriptContentboolean required

whether transcript content (the JSONL utterance file) has been stored for this transcript; the content's storage location is derived from the transcript id, so no path is stored

sensitivity level of the transcript

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "665f3aabe88164e4ef6c3a22",
  "orgId": "665f3ad1e47a82bf1d3d180b",
  "calendarEntryId": "588f7ee98f138b19220041a7",
  "externalUrl": "https://app.gong.io/call?id=7815638069569786872",
  "recordingSystem": "gong",
  "startAt": "2017-01-24T13:57:52Z",
  "untilAt": "2017-01-24T14:57:52Z",
  "attendees": [
    {
      "personId": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7"
    }
  ],
  "language": "en",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAt": "2017-01-24T13:57:52Z"
}