Skip to main content
POST
/
v1.0.1
/
file
/
read
cURL
curl --request POST \
  --url https://api.readfile.io/v1.0.1/file/read \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-KEY: <api-key>' \
  --form file='@example-file'
{
  "job_id": "<string>",
  "status": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
strategy
enum<string>
default:default

The processing strategy to use for text extraction. For more, see here

Available options:
default,
vision,
sota

Body

multipart/form-data
​
file
file
required

The file to be processed. Can be any of [.pdf, .docx, .png].

Response

Accepted response

​
job_id
string
required

The identifier of your task on ReadFile. You can use this to track the status, and download the results.

​
status
string
required

The current state of your task on ReadFile. This will read 'processing' once the task is being worked on.