Download URLs and conformance summary

GET

/api/v1/convert/{fileId}/result

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

• Production

Signed download URLs for what you asked for, plus the PDF/UA-1 conformance summary. 409 NOT_READY until the conversion (and, with pdf, the accessible PDF) is finished.

Authorizations

• apiKey

Parameters

Path Parameters

fileId

required

string

Responses

200

Result

Media typeapplication/json

object

success

boolean

data

object

fileId

string

fileName

string

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

html

Only when html was requested.

object

inlinePreview

string

truncated

boolean

totalSizeBytes

integer

downloadUrl

string format: uri

downloadExpiresAt

string format: date-time

pdf

Only when pdf / conformance was requested.

object

status

string

downloadUrl

string format: uri

downloadExpiresAt

string format: date-time

sizeBytes

integer

accessibilityScore

number

accessibilityScoreBasis

string

Allowed values: verapdf-checked heuristic

conformance

The PDF/UA-1 (veraPDF) summary. Null until it has been computed.

object

key

additional properties

any

reportUrl

string format: uri

Example

{
  "data": {
    "outputs": [
      "html"
    ],
    "pdf": {
      "accessibilityScoreBasis": "verapdf-checked"
    }
  }
}

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"
  }
}

409

NOT_READY

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"
  }
}

422

CONVERSION_FAILED or PDF_GENERATION_FAILED

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"
  }
}