Indox Docs

Indox Client Guide

Copy page

This is the primary guide for working with the Indox Python client and the Indox APIs (Auth, Docs/Media).

Install

Code
 
pip install indox-client

• Python 3.9+
• An Indox API key to convert anything to anything!

Configure

Set env vars (or pass directly):

• INDOX_API_KEY (required)
• INDOX_DOCS_URL (default https://indox.org/docs)
• INDOX_MEDIA_URL (default https://indox.org/media)
• Optional: timeout when creating the client (single number or tuple (connect, read)).

Quick Start

Code
 
from indox_client.client import IndoxClient

client = IndoxClient.from_env()  # reads env vars above

# or explicit
client = IndoxClient(
    api_key="YOUR_API_KEY",
    docs_base_url="https://indox.org/docs",
    media_base_url="https://indox.org/media",
)

Common Tasks

Assume client = IndoxClient.from_env().

Convert a document (upload)

Code
 
res = client.docs.convert_file(
    file_path="./files/report.docx",
    target_formats=["pdf"],
    destination="aws",
)

Convert a document (URL or S3 key)

Code
 
res = client.docs.convert_url(
    file_url="https://example.com/report.docx",  # or s3_key="bucket/path/report.docx"
    target_formats=["pdf"],
    destination="aws",
)

Convert an image

Code
 
res = client.media.convert_image(
    file_path="./images/photo.png",
    target_formats=["jpg", "webp"],
)

Convert a video

Code
 
res = client.media.convert_video(
    file_path="./videos/input.mov",
    target_formats=["mp4"],
)

Wait for completion

Code
 
status = client.media.wait_for_conversion(
    res["id"], timeout_seconds=120, poll_interval=1,
)

Download a converted file

Code
 
saved_path = client.media.download_media(
    conversion_id=res["id"],
    output_path="./output/photo_converted.jpg",
    fmt="jpg",  # optional
)
print("Saved to", saved_path)

Close the client

Code
 
client.close()

Errors

• IndoxClientError: network/request issues
• IndoxHTTPError: non-success HTTP; includes status, payload, and request_id (log this for support)

Example:

Code
 
from indox_client.exceptions import IndoxClientError, IndoxHTTPError

try:
    client.media.convert_image(file_path="missing.png", target_formats=["jpg"])
except IndoxHTTPError as err:
    print("HTTP:", err.status, err)
    if getattr(err, "request_id", None):
        print("Request ID:", err.request_id)
except IndoxClientError as err:
    print("Client:", err)

API References

• Auth API spec: /api/indox-auth (sidebar)
• Service behavior & endpoints: see Indox Services in the docs sidebar.

To expose more API specs, add files to apis/ and update zudoku.config.tsx.

Storage & Downloads

• Downloads are served via masked routes; direct storage URLs are not exposed.
• Storage usage/limits are returned by Auth (/me or token introspection); enforce in your app if needed.

Troubleshooting

• 401/403: Check INDOX_API_KEY, base URLs, token scope.
• Timeouts: bump timeout; verify file size and endpoint.
• Offline build: set ZUDOKU_DISABLE_UPDATE_CHECK=1.