ConverterHQDevelopers
Documentation

SDKs & downloads

Download source clients for cURL, Python, JavaScript, TypeScript, Go, Java, C#/.NET, C++, Rust, PHP and Ruby.

Official SDK source artifacts share the same public API contract and add an idiomatic convenience layer for their runtime. Registry publication is tracked separately; a source-supported SDK is not advertised as registry-installable until publication is verified.

Official languages and source downloads

All eleven documented integration surfaces are available here: raw REST/cURL plus official source SDKs for Python, JavaScript, TypeScript, Go, Java, C#/.NET, C++, Rust, PHP and Ruby. JavaScript and TypeScript share the Node SDK but have separate examples and downloads. Registry publication is shown separately from source support.

cURL

REST
Source package

Canonical raw HTTP starter. No runtime dependency.

Package
HTTP API v1
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-curl-starter.tar.gz
cd sdks/curl
./quickstart.sh report.docx

Python

Python 3.10+
Source package

Official source SDK with CLI and webhook verification.

Package
converterhq
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-python-sdk.tar.gz
pip install ./sdks/python

JavaScript

Node.js
Source package

JavaScript and TypeScript share the official Node SDK.

Package
@converterhq/sdk
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-javascript-sdk.tar.gz
npm install ./sdks/typescript

TypeScript

Node.js + types
Source package

Typed Node client generated against the same API v1 contract.

Package
@converterhq/sdk
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-typescript-sdk.tar.gz
npm install ./sdks/typescript

Go

Go module
Source package

Context-aware client, direct uploads and webhook verification.

Package
github.com/converterhq/converterhq-go
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-go-sdk.tar.gz
go mod edit -replace github.com/converterhq/converterhq-go=./sdks/go

Java

JDK / Maven
Source package

Source SDK packaged as a Maven project while registry publication is pending.

Package
io.converterhq:converterhq-java
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-java-sdk.tar.gz
mvn -f sdks/java/pom.xml install

C# / .NET

.NET
Source package

Async .NET client with webhook helpers.

Package
ConverterHQ
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-csharp-sdk.tar.gz
dotnet build sdks/dotnet/ConverterHQ/ConverterHQ.csproj

C++

CMake
Source package

Source-first CMake package; no registry dependency required.

Package
ConverterHQ CMake package
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-cpp-sdk.tar.gz
cmake -S sdks/cpp -B build && cmake --build build

Rust

Cargo
Source package

Async Rust client with direct upload and webhook support.

Package
converterhq
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-rust-sdk.tar.gz
cargo test --manifest-path sdks/rust/Cargo.toml

PHP

Composer
Source package

Composer-ready source artifact while Packagist publication is pending.

Package
converterhq/converterhq-php
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-php-sdk.tar.gz
composer install --working-dir=sdks/php

Ruby

RubyGems
Source package

Gem source with conversion and webhook clients.

Package
converterhq
Registry
Publication pending verification
Install from downloaded source
tar -xzf converterhq-ruby-sdk.tar.gz
gem build sdks/ruby/converterhq.gemspec

SDK design

from converterhq import ConverterHQ

# Reads CONVERTERHQ_API_KEY. hq_test_* keys automatically use the sandbox.
client = ConverterHQ()
result = client.convert(
    "report.docx",
    from_format="docx",
    to="pdf",
    wait=20,
)
result.save("report.pdf")

CLI

CLI
converterhq convert report.docx --to pdf
converterhq jobs wait job_...
converterhq formats outputs docx
converterhq webhook listen