Skip to main content
POST
/
details
curl --request POST \
  --url https://api.heify.com/details \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "transcription_id": "1a2b3c4d-e5f6-7890-1234-567890abcdef"
}
'
{
  "transcription_id": "1a2b3c4d-e5f6-7890-1234-567890abcdef",
  "status": "COMPLETED",
  "configuration_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "configuration_tag": "Sales Call Analysis",
  "duration": 360,
  "group": "Q4-2023",
  "name": "Quarterly Review Call",
  "details": {
    "language": "en",
    "num_speakers": 2,
    "conversation": {
      "segments": [
        {
          "text": "Hello",
          "speaker": "SPEAKER_00"
        }
      ]
    },
    "summary": {
      "summary": "Call summary..."
    },
    "fields": {
      "fields": [
        {
          "name": "ROI",
          "value": "15%"
        }
      ]
    },
    "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

Request body for retrieving transcription details. Provide a transcription_id for a specific transcription, or an empty object {} to retrieve all transcriptions for the client.

​
transcription_id
string<uuid>

The unique identifier of the transcription to retrieve. If not provided, all transcriptions will be returned.

Response

200 - application/json

Successfully retrieved transcription details or a list of transcriptions.

Full details for a completed transcription.

​
transcription_id
string<uuid>
required

Unique identifier for the transcription.

​
status
enum<string>
required

The current status of the transcription job.

Available options:
COMPLETED
​
details
object
required

Full transcription results, available only if status is COMPLETED.

​
configuration_id
string<uuid> | null

ID of the configuration used for this transcription.

​
configuration_tag
string | null

Tag of the configuration used for this transcription.

​
duration
number | null

Media duration in seconds.

​
group
enum<string> | null

Categorization of the transcription, e.g., 'PENDING_REVIEW', 'UNDER_REVIEW', 'ARCHIVED'.

Available options:
PENDING_REVIEW,
UNDER_REVIEW,
ARCHIVED,
​
name
string | null

Custom name for the transcription.