Get chat audio

Fetches the audio of a previous Chat. For more details, see our guide on audio reconstruction here.

Path parameters

idstringRequiredformat: "uuid"
Identifier for a chat. Formatted as a UUID.

Headers

X-Hume-Api-KeystringRequired

Response

Success
idstring
Identifier for the chat. Formatted as a UUID.
user_idstring
Identifier for the user that owns this chat. Formatted as a UUID.
statusenum

Indicates the current state of the audio reconstruction job. There are five possible statuses:

  • QUEUED: The reconstruction job is waiting to be processed.

  • IN_PROGRESS: The reconstruction is currently being processed.

  • COMPLETE: The audio reconstruction is finished and ready for download.

  • ERROR: An error occurred during the reconstruction process.

  • CANCELED: The reconstruction job has been canceled.

Allowed values:
filenamestringOptional
Name of the chat audio reconstruction file.
modified_atlongOptional
The timestamp of the most recent status change for this audio reconstruction, formatted milliseconds since the Unix epoch.
signed_audio_urlstringOptional
Signed URL used to download the chat audio reconstruction file.
signed_url_expiration_timestamp_millislongOptional
The timestamp when the signed URL will expire, formatted as a Unix epoch milliseconds.