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.unstract.com/v1/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.unstract.com/v1/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 |
Example 200 Response
{
"status": "processing"
}
Possible Statuses
processing: The document is still being processed. Check back later.processed: The document has been processed and the text is ready to be retrieved.delivered: The text has been retrieved. Note that the text is deleted once it is retrieved.unknown: The whisper hash is not valid. Check the hash and try again.