Skip to main content
POST
/
update-transcription-group
curl --request POST \
  --url https://api.heify.com/update-transcription-group \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "transcription_id": "1a2b3c4d-e5f6-7890-1234-567890abcdef",
  "group": "PENDING_REVIEW"
}'
{
  "message": "Transcription group updated successfully.",
  "transcription": {
    "transcription_id": "1a2b3c4d-e5f6-7890-1234-567890abcdef",
    "status": "COMPLETED",
    "configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "configuration_tag": "Sales Call Analysis",
    "duration": 360,
    "group": "PENDING_REVIEW",
    "name": "Quarterly Review Call",
    "details": {
      "language": "en",
      "num_speakers": 2,
      "conversation": {
        "segments": [
          {
            "text": "...",
            "speaker": "..."
          }
        ]
      },
      "summary": {
        "summary": "..."
      },
      "fields": {
        "fields": [
          {
            "name": "...",
            "value": "..."
          }
        ]
      },
      "created_at": "2023-10-27T10:00:00Z",
      "completed_at": "2023-10-27T10:10:00Z"
    }
  }
}
For a detailed explanation of the Transcription and its parameters, please consult the Transcription Object.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
transcription_id
string<uuid>
required

The unique identifier of the transcription to update.

​
group
string
required

The new group for the transcription. Valid values are 'PENDING_REVIEW', 'UNDER_REVIEW', 'ARCHIVED'. To remove the transcription from a group, provide an empty string ("").

Example:

"PENDING_REVIEW"

Response

200 - application/json

The transcription group was updated successfully. The full, updated transcription object is returned.

​
message
string
Example:

"Transcription group updated successfully."

​
transcription
object

Response containing details for a single transcription, structure varies by status. Full details for a completed transcription.

  • GetSingleTranscriptionResponse
  • GetSingleTranscriptionResponse
  • GetSingleTranscriptionResponse