Conversion status

GET

/api/v1/convert/{fileId}

curl --request GET \
  --url https://api.gevell.com/api/v1/convert/example \
  --header 'X-API-Key: <X-API-Key>'

• Production

Poll no more than once every 12 seconds. 404 for a file that is not yours.

Authorizations

• apiKey

Parameters

Path Parameters

fileId

required

string

Responses

200

Status

Media typeapplication/json

object

success

boolean

data

object

fileId

string

status

string

Allowed values: uploaded processing validating fixing chunked_processing completed failed

progress

integer

phase

string

htmlReady

boolean

pdfStatus

string

Allowed values: queued processing completed failed unavailable none

pdfReady

boolean

conformanceReady

boolean

outputs

What to deliver. Default ["pdf","conformance"]. pdf and conformance come together; add html for the accessible HTML.

Array<string>

<= 3 items

Allowed values: html pdf conformance

done

True when the conversion has finished (completed with every requested output settled, or failed). Call the result route; on a failed conversion it answers 422.

boolean

error

string

errorCode

string

Example

{
  "data": {
    "status": "uploaded",
    "pdfStatus": "queued",
    "outputs": [
      "html"
    ]
  }
}

401

Missing or invalid API key

Media typeapplication/json

object

success

boolean

error

object

code

string

message

string

details

object

key

additional properties

any

Example

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_CREDITS"
  }
}

404

Not found

Media typeapplication/json

object

success

boolean

error

object

code

string

message

string

details

object

key

additional properties

any

Example

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_CREDITS"
  }
}

500

Unexpected error

Media typeapplication/json

object

success

boolean

error

object

code

string

message

string

details

object

key

additional properties

any

Example

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_CREDITS"
  }
}