POST
/
format
curl --request POST \
  --url https://api.documind.xyz/format \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "file": "<string>",
  "format": {}
}'
{
  "id": "<string>",
  "createdAt": "<string>",
  "status": "<string>",
  "pages": 123,
  "fileName": "<string>",
  "type": "<string>",
  "formats": {}
}

​
Body

​
file
string
required

The file url

​
format
enum
required

The format to convert the document to. Options are: text, markdown. More soon.

​
Response

​
id
string

The unique id of the formatting job.

​
createdAt
string

Date and time when the job was created.

​
status
string

Status of the job.

​
pages
number

Number of pages in the document processed.

​
fileName
string

The file URL.

​
type
string
default:"formatting"

The type of job.

​
formats
object

Result of the formatting job.