Status API

Check the status of the text extraction process. This can be used to check the status of the conversion process when the conversion is done in async mode.

Endpoint	/whisper-status
URL	https://llmwhisperer-api.us-central.unstract.com/api/v2/whisper-status
Method	GET
Headers	unstract-key: <YOUR API KEY>

Parameters

Parameter	Type	Default	Required	Description
whisper_hash	string		Yes	The whisper hash returned while starting the whisper process.

Example Curl Request

curl -X GET --location 'https://llmwhisperer-api.us-central.unstract.com/api/v2/whisper-status?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 Status	Content-Type	Headers	Description
200	application/json		The API will return a JSON with the status. Refer below for JSON format
400	application/json		The API will return a JSON with the error message. Refer below for JSON format

Example 200 Response

{
    "detail": [
        {
            "execution_time_in_seconds": 4,
            "message": "extraction_success",
            "page_no": 1
        },
        {
            "execution_time_in_seconds": 4,
            "message": "extraction_success",
            "page_no": 2
        }
    ],
    "message": "<human readble message>",
    "status": "processed"
}

Example 400 Response

{
    "message": "Whisper job not found for the provided whisper hash"
}

Possible Statuses

200 OK

• accepted: The document has been accepted and has been added to the processing queue.
• processing: The document is still being processed. Check back later.
• processed: The document has been processed and the text is ready to be retrieved.
• error: The document processing has failed. Check the error message for more details.
• retrieved: The text has been retrieved.