Skip to main content

Retrieve API

Retrieve the extracted text executed through the whisper API. This can be used to retrieve the text of the conversion process when the conversion is done in async mode.

Endpoint/whisper-retrieve
URLhttps://llmwhisperer-api.unstract.com/v1/whisper-retrieve
MethodGET
Headersunstract-key: <YOUR API KEY>

Parameters

ParameterTypeDefaultRequiredDescription
whisper-hashstringYesThe whisper hash returned while starting the whisper process.

Example Curl Request

curl -X GET --location 'https://llmwhisperer-api.unstract.com/v1/whisper-retrieve?whisper-hash=XXXXXXXXXXXXXXXXXXX' \
-H 'unstract-key: <Your API Key>'
info

To include the headers in the response use curl -i in the request.

Response

HTTP StatusContent-TypeHeadersDescription
200text/plainText dump of the extraction
400application/jsonError while retrieveing. Refer below for JSON format

Example 400 Response

{
"message": "<Error Message>"
}

Possible Error Messages

  • Whisper not found
  • Whisper not ready
  • Whisper already delivered

Note: The extracted text can be retrieved only once. Make sure to store the text in your system if you need to access it multiple times. This is for security and privacy reasons.