Status

Retrieves the file processing status and download link for the processed file, if available.

Request
GET $self_url

where $self_url is the URL displayed in the links.self field in the response body of a successful Authorize request. See Authorize for details.

Request Header
Header Field Value
apikey

Required. Valid API key. See Authorization for details.

Request Example

 

curl -H "APIKEY: YOUR_APIKEY" $self_url
            

import requests, json, time
r = requests.get(auth_response["links"]["self"], headers={"APIKEY": apikey})
status_response = json.loads(r.text)

Response

The response is JSON and contains information about the processing status of the file, file properties, and links. If the file is still processing, only the links.self field is displayed in the links section. If processing fails, the error field is displayed in the response body.

Response Body
Name Type Description
uid string Unique request ID
status string Request status. Options are:
  • new: Authorize request successful, no file uploaded.
  • waiting: Authorize request successful. Upload complete. File awaiting processing.
  • processing: File is being processed.
  • failed: Processing failed.
  • finished: File processed successfully and available to download.
  • archived: Processed file is no longer available for download.
created string Date and timestamp the file was uploaded to the server.
source_name string Original file name of the uploaded file.
source_size integer Original size in bytes of the uploaded file.
error string Error message if the file did not process successfully. Options are:
  • timeout_new: The links.self URL expired.
  • timeout_waiting: The file was in the waiting stage for too long.
  • timeout_processing: The file was in the processing stage for too long.
  • processing_failed: The file processing failed unexpectedly.
links array URLs for various actions. Possible keys are:
  • self: Link to call information about the uploaded file.
  • upload: Link to which the file must be uploaded. See Upload for details.
    Note: This field is only displayed while the status field is new.
  • download: Link to download the processed file. See Download for details.
    Note: This field is only displayed when the status field is finished.
name string File name for the output file.
type string Output file type.
size integer Output file size in bytes.

Response Examples

 

HTTP 200, OK
{
    "uid":         "abbc7c94-h11y-4r27-92fg-czd3362f464a",
    "created":     "2020-02-01T14:19:10.713Z",
    "status":      "new",
    "source_name": "",
    "source_size": 0,
    "links": {
        "self":   "https://filewall.io/api/get/abbc7c94-h11y-4r27-92fg-czd3362f464a",
        "upload": "https://filewall.io/api/upload/abcd_very_long_example"
    }
}


HTTP 200, OK
{
    "uid":         "abbc7c94-h11y-4r27-92fg-czd3362f464a",
    "created":     "2020-02-01T14:19:10.713Z",
    "status":      "processing",
    "source_name": "example.doc",
    "source_size":  296419,
    "links": {
        "self":     "https://filewall.io/api/get/abbc7c94-h11y-4r27-92fg-czd3362f464a",
    },
}


HTTP 200, OK
{
    "uid":         "abbc7c94-h11y-4r27-92fg-czd3362f464a",
    "created":     "2020-02-01T14:19:10.713Z",
    "status":      "finished",
    "source_name": "example.doc",
    "source_size":  296419,
    "links": {
        "self":     "https://filewall.io/api/get/abbc7c94-h11y-4r27-92fg-czd3362f464a",
        "download": "https://filewall.io/api/download/abcd_very_long_example"
    },
    "name": "example.pdf",
    "type": "PDF",
    "size":  285435
}


HTTP 200, OK
{
    "uid":         "abbc7c94-h11y-4r27-92fg-czd3362f464a",
    "created":     "2020-02-01T14:19:10.713Z",
    "status":      "failed",
    "source_name": "example.doc",
    "source_size":  296419,
    "links": {
        "self":     "https://filewall.io/api/get/abbc7c94-h11y-4r27-92fg-czd3362f464a",
    },
    "error": "processing_failed",
}

Menu 3

Eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.

Response Codes
Code Value Description Response Body Value
200 Ok Download successful.
400 Bad Request The file was not sent with the request. invalid_request

Any thoughts? Did we miss something? Drop us a note!