Official client libraries for integrating OrbConvert into your applications.
Official SDKs are coming soon
The Python, JavaScript/TypeScript, and Go SDKs are on our roadmap. The code samples below show the planned API surface so you can architect your integration now. In the meantime, use the REST API directly — it's a simple three-step flow.
All SDKs wrap the same REST endpoints. Until the SDKs ship, call the API directly with three requests — upload, convert, poll:
# Step 1: Upload the file
curl -X POST https://api.orbconvert.com/api/uploads \
-H "x-api-key: ch_live_YOUR_API_KEY" \
-F "file=@document.pdf"
# Response: { "fileId": "file_abc123", ... }
# Step 2: Start conversion
curl -X POST https://api.orbconvert.com/api/conversions \
-H "x-api-key: ch_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "fileId": "file_abc123", "toFormat": "docx" }'
# Response: { "conversionId": "conv_xyz789", "status": "pending" }
# Step 3: Poll for status
curl https://api.orbconvert.com/api/conversions/conv_xyz789 \
-H "x-api-key: ch_live_YOUR_API_KEY"
# Response: { "status": "completed", "outputUrl": "https://api.orbconvert.com/api/files/file_def456/download?token=..." }See the Getting Started guide and API Reference for full details.
orbconvert (not yet published)# Planned API design (not yet available)
import orbconvert
client = orbconvert.Client(api_key="ch_live_YOUR_API_KEY")
# Upload + convert in one call
result = client.convert("document.pdf", to_format="docx")
result.download("output.docx")
# Batch conversion
batch = client.batch([
("image1.png", "jpg"),
("image2.png", "jpg"),
])
batch.wait()
for result in batch.results:
print(f"Download: {result.download_url}")orbconvert (not yet published)// Planned API design (not yet available)
import { OrbConvert } from 'orbconvert'
const client = new OrbConvert({ apiKey: 'ch_live_YOUR_API_KEY' })
const result = await client.convert('document.pdf', { to: 'docx' })
await result.download('output.docx')github.com/orbconvert/orbconvert-go (not yet published)// Planned API design (not yet available)
package main
import (
"fmt"
"github.com/orbconvert/orbconvert-go"
)
func main() {
client := orbconvert.NewClient("ch_live_YOUR_API_KEY")
result, err := client.Convert("document.pdf", orbconvert.To("docx"))
if err != nil { panic(err) }
err = result.Download("output.docx")
if err != nil { panic(err) }
fmt.Println("Conversion complete!")
}Was this page helpful?