Detail API

Check the details of the text extraction process.

Endpoint	/whisper-detail
URL	https://llmwhisperer-api.us-central.unstract.com/api/v2/whisper-detail
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-detail?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 details. 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

{
    "completed_at": "Mon, 10 Feb 2025 10:40:58 GMT",
    "mode": "form",
    "processed_pages": 1, # Proccesed numbe of pages
    "processing_started_at": "Mon, 10 Feb 2025 10:40:53 GMT",
    "processing_time_in_seconds": 120.88,
    "requested_pages": 1, # Requested no of pages to be processed.
    "tag": "<tag supplied in whisper request>",
    "total_pages": 4, #No of pages in the document uploaded
    "upload_file_size_in_kb": 618.488,
    "whisper_hash": "<whisper_hash>"
}

Example 400 Response

{
    "message": "Record not found"
}