Convilyn docs

SDK overview

Convilyn ships an official Python SDK and CLI. Convert files, run AI workflows, and ship in five lines of Python or a single shell command.

Install

pip install convilyn
export CONVILYN_API_KEY=cvl_...

Convert a file in five lines

from convilyn import Convilyn

client = Convilyn()  # reads CONVILYN_API_KEY from env
file = client.files.upload("report.docx")
job = client.convert.create_and_wait(file=file, target_format="pdf")
client.convert.download_to(job, to="report.pdf")

Or as a single shell command:

convilyn convert report.docx --to pdf

What's in the box

  • Python SDK — Convilyn (sync) and AsyncConvilyn (async) with resource-style accessors: client.files, client.convert. Additional resource modules ship in subsequent releases.
  • CLI with three sub-commands installed by the package:
    • convilyn convert <file> --to <format> — upload, convert, download
    • convilyn doctor — environment and connectivity diagnostics
    • convilyn api <METHOD> <PATH> — gh-style escape hatch for any endpoint the SDK hasn't wrapped yet
  • Production-grade resilience built in — retry on 5xx / 429 / 408 with exponential backoff and jitter, Idempotency-Key auto-stamped on mutating verbs, Retry-After honoured.
  • Automation-friendly — every command supports --json for machine-readable output, --dry-run for safe previews, and pinned exit codes (0 / 1 / 2 / 3 / 130) so scripts and automations can branch on the result without parsing free text.

Requirements

  • Python 3.10 or later
  • A Convilyn API key (cvl_... format) — get one from your dashboard

Where to go next

  • Quickstart — install to first conversion in under 5 minutes
  • Credits — how credits and pricing work
  • Usage Guide — when to use Turbo Lane vs Goal Lane