SDK Reference

The Python SDK exposes a small, focused public surface. Everything imported from convilyn at the top level is part of the supported API.

The reference is English only because Python symbols, type hints, and exception names are themselves English. For tutorials and walkthroughs in other languages, start at the SDK Overview or Quickstart.

What's in the SDK

| Page | Contents | |---|---| | Clients | Convilyn (sync) and AsyncConvilyn (async) — the SDK entry points | | Exceptions | The full ConvilynError hierarchy — every exception the SDK can raise | | Types | Pydantic data models returned by the SDK (File, ConvertJob, GoalJob, ...) |

Quick map

from convilyn import (
    # Clients
    Convilyn,
    AsyncConvilyn,

    # Exceptions
    ConvilynError,            # base
    AuthError,
    APIError,
    RateLimitError,
    S3UploadError,
    JobFailedError,
    JobTimeoutError,
    GoalJobFailedError,
    GoalJobTimeoutError,
    WebSocketError,
    RetryExhaustedError,

    # Data models
    File,
    ConvertJob,
    GoalJob,
    GoalEvent,
    JobError,
    PendingSlot,
    ResultFile,

    # Retry policy primitives
    RetryPolicy,
    ExponentialBackoffRetry,
    NoRetry,
)

Versioning

The SDK follows semantic versioning. Anything in convilyn.__all__ is part of the supported public surface; anything starting with _ (e.g. convilyn._internal) is private and may change between releases.

Need something not listed here?

The CLI ships an api sub-command that calls any endpoint with the same auth, retry, and idempotency behaviour as the high-level methods. See the Quickstart §6 for examples.