Skip to main content
GET
/
v1.0.1
/
file
/
status
/
{job_id}
cURL
curl --request GET \
  --url https://api.readfile.io/v1.0.1/file/status/{job_id} \
  --header 'X-API-KEY: <api-key>'
{
  "job_id": "<string>",
  "status": "<string>",
  "strategy": "<string>",
  "file_name": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "result_url": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
job_id
string
required

The ID of the processing job

Response

Successfully retrieved job status

​
job_id
string
required

The identifier of your task on ReadFile.

​
status
string
required

The current state of your task on ReadFile.

​
strategy
string

The processing strategy used for the extraction.

​
file_name
string

The name of the file processed.

​
timestamp
string<date-time>

The time the job was initiated.

​
result_url
string

The url you can hit to retrieve the output of the extraction job.