Skip to content

indox Developer Documentation

Welcome. This is the public documentation for the indox file-conversion platform.

If you are an external developer integrating with indox, you are in the right place. If you are an internal contributor looking for plans, decisions, or dashboards — see design/ in the repository (not published here).

What is indox

indox converts files — documents, images, audio, video, fonts — through a uniform REST API. Conversions are asynchronous:

  1. POST /<service>/api/v1/convert/ → 202 { conversion_id }
  2. Poll GET /conversion/{id}/ → terminal state
  3. GET /{id}/download/ → presigned URL

Services

Service Base path Formats
Documents /docs/api/v1/ PDF, DOCX, ODT, RTF, HTML, MD, EPUB, …
Media /media/api/v1/ images, audio, video
Fonts /fonts/api/v1/ TTF, OTF, WOFF, WOFF2, and 15 more
Billing /billing/api/v1/ plans, usage, credits
Auth /auth/api/v1/ login, refresh, OIDC, social

Getting started

  • Quickstart — your first conversion in 5 minutes
  • Concepts — auth, conversions, polling, credits
  • Limits — free quota, paid tiers, file size caps
  • Errors — error codes and what they mean

Reference