Retrieve document status
Retrieve the current processing status, progress, and error details for an Ahoy Data Intelligence document.
API documentation: https://www.ahoyams.com/marketplace/cbe0812f-2def-46ec-a73c-788f97ff2c2a#description/introduction
Application
- Ahoy Data Intelligence
Inputs (what you have)
| Name | Description | Data Type | Required? | Example |
|---|---|---|---|---|
| Document ID | Document whose status should be retrieved | Text (Short) | Yes | doc_456 |
Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data Library section. These variables in the Data Library section are the outputs of previous Wrk Actions in the Wrkflow.
Outputs (what you get)
| Name | Description | Data Type | Required? | Example |
|---|---|---|---|---|
| Document ID | Document identifier | Text (Short) | Yes | doc_456 |
| Filename | Stored filename | Text (Short) | Yes | SOP.pdf |
| Content type | Stored content type | Text (Short) | Yes | application/pdf |
| Processing status | Current Ahoy processing status, returned exactly as reported by the provider | Text (Short) | Yes | pending |
| Chunk count | Current extracted chunk count | Number | Yes | 42 |
| Uploaded at | Upload timestamp | Text (Short) | Yes | |
| Processed at | Processing completion timestamp when available | Text (Short) | No | |
| Processing error | Failure during processing, when present | Text (Long) | No | |
| Processing step | Current processing step, when present | Text (Short) | No | |
| Processing progress | Stringified JSON object returned by Ahoy | Text (Long) | No | |
| Processing metrics | Stringified JSON object returned by Ahoy | Text (Long) | No | |
| Error category | Provider error category when present | Text (Short) | No | |
| Failure reason | Terminal failure before processing started. Ahoy currently documents expired_no_upload for bulk-upload reservations | Text (Long) | No |
Outcomes
| Name | Description |
|---|---|
| Success | This status is selected if the job has successfully completed. |
Requirements
- N/A