FlexFiles Documentation
Product guides, tutorials, and operational reference
Developer API
Developers4 min read

API Reference

How to authenticate a request with an API key, the response shape every FlexFiles API endpoint uses, and a preview of the conversion endpoints currently in development.

Not yet available

Conversion endpoints are in active development and are not callable yet. The examples below show the planned request shape so integrators can prepare, but calling them today will return a 404. Generating and managing API keys from your account settings is live now — see API Keys: Generate, Use, and Revoke.

Authenticating a request

Every request to the FlexFiles public API sends the raw API key in a header. No session cookie or login step is needed.

X-Api-Key: ff_JcBtyxaB1h9kYnXDtL_sdo-Qn1iYqf1cHA59oS3k8N0
Planned conversion endpoint (preview)

Submitting a conversion is expected to look like this once the endpoint ships:

POST https://api.flexfiles.io/api/v1/conversions
X-Api-Key: ff_your_key_here
Content-Type: multipart/form-data

file=@document.pdf
action=pdf-to-word

Checking on a conversion is expected to look like this:

GET https://api.flexfiles.io/api/v1/conversions/{conversion_id}
X-Api-Key: ff_your_key_here
Response envelope

Every FlexFiles API response, including future conversion endpoints, uses the same envelope shape:

{
  "status": true,
  "statusCode": 200,
  "message": null,
  "data": { "...": "..." },
  "errors": null
}
Planned conversion actions (v1 scope)

The first version of the public conversion API is scoped to the four most-requested conversions. More will be added after launch based on demand.

PDF to Wordpdf-to-word
PDF to JPGpdf-to-jpg
Convert Imageconvert-image
Word to PDFword-to-pdf

Current status

  • API key generation, listing, and revocation are live — see API Keys: Generate, Use, and Revoke.
  • Public conversion endpoints are in development. The samples above show the planned shape so you can prepare an integration ahead of launch.
  • This page will be updated the moment conversion endpoints go live, with real, callable examples.

Error handling

FlexFiles API errors use the same envelope as successful responses, with status set to false, an HTTP-matching statusCode, and a human-readable message. A missing or revoked API key returns 401. Requesting a conversion type that isn't supported returns 422. Rate limits apply per key and return 429 when exceeded.

Common reference questions

Can I call the conversion endpoints right now?

Not yet. They're actively being built. Generating and managing API keys is already live, so you can prepare a key ahead of time.

Will the conversion API support more than four conversions eventually?

The initial release is scoped to PDF to Word, PDF to JPG, Convert Image, and Word to PDF. More conversions are expected to be added after launch based on demand.

Will there be a way to get notified when a conversion finishes, instead of polling?

The first version is polling-only: you check a conversion's status with a GET request. A push-based notification option may be considered for a later release.