indox-client 0.2.2

Python SDK for the Indox media and document conversion services.

indox-client

Python SDK for the Indox media and document conversion services.

Installation

pip install indox-client

Quick Start

from indox_client import IndoxClient

# Initialize with API key
client = IndoxClient(api_key="your-api-key")

# Or use environment variables
# export INDOX_API_KEY=your-api-key
client = IndoxClient.from_env()

# Convert a document
result = client.docs.convert_file(
    file_path="document.pdf",
    target_formats=["docx", "txt"]
)

# Wait for completion
completed = client.docs.wait_for_completion(result["conversion_id"])

# Download the result
client.docs.download(
    conversion_id=result["conversion_id"],
    output_path="output.docx",
    fmt="docx"
)

Features

• Document Conversion: Convert between PDF, DOCX, TXT, and more
• Font Conversion: Convert between TTF, OTF, WOFF, WOFF2, and other font formats
• Media Conversion: Convert images and videos between formats
• Async Support: Long-polling for conversion status
• Multiple Sources: Upload files, URLs, or S3 keys

Usage

Font Conversion

# Convert font formats
result = client.docs.convert_and_download(
    file_path="font.ttf",
    target_format="woff2",
    output_path="font.woff2"
)

# Check supported font formats
formats = client.docs.supported_formats()
print(f"Available formats: {formats['total_formats']}")

# Validate conversion before processing
validation = client.docs.validate(
    file_path="font.ttf",
    target_format="otf"
)
if validation["valid"]:
    print(f"Conversion possible with {validation['engine']} engine")

Media Conversion

# Convert image
result = client.media.convert_image(
    file_path="image.png",
    target_formats=["webp", "jpg"]
)

# Convert video
result = client.media.convert_video(
    file_path="video.mp4",
    target_formats=["webm"]
)

# Check supported formats
image_formats = client.media.image_formats()
video_formats = client.media.video_formats()

Context Manager

with IndoxClient.from_env() as client:
    result = client.docs.convert_file(
        file_path="document.pdf",
        target_formats=["docx"]
    )

Configuration

Environment Variable	Description
INDOX_API_KEY	Your API key
INDOX_DOCS_URL	Docs service URL (default: https://docs.indox.org/)
INDOX_MEDIA_URL	Media service URL (default: https://docs.indox.org/)

Error Handling

from indox_client import IndoxClient, IndoxHTTPError, IndoxClientError

try:
    result = client.docs.convert_file(
        file_path="document.pdf",
        target_formats=["docx"]
    )
except IndoxHTTPError as e:
    print(f"HTTP {e.status_code}: {e}")
    print(f"Request ID: {e.request_id}")
except IndoxClientError as e:
    print(f"Client error: {e}")

License

Proprietary - see LICENSE for details.

Additional Documentation

• Font Conversion Guide - Comprehensive guide for font format conversion
• Font API Testing Notebook - Interactive notebook for testing all font conversion endpoints