ConverterHQDevelopers
API v1

SDKs e downloads

Clientes oficiais para REST/cURL, Python, JavaScript, TypeScript, Go, Java, C#/.NET, C++, Rust, PHP, Ruby.

Cada SDK combina transporte gerado pelo OpenAPI com uma camada idiomática escrita à mão.

Linguagens oficiais

REST/cURL, Python, JavaScript, TypeScript, Go, Java, C#/.NET, C++, Rust, PHP, Ruby suportam conversões, Files, Jobs, multipart, erros tipados, webhooks e realtime.

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

Design dos SDKs

Métodos de alto nível ocultam polling, escolha de upload e download sem impedir acesso aos recursos REST avançados.

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

A CLI oferece conversão, upload de Files, gerenciamento de Jobs, descoberta de formatos e escuta local de webhooks com saída humana ou JSON.

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