Skip to main content

Official Python SDK for LlamaGen Comic API and Animation API

Project description

llamagen-python

Official Python SDK for LlamaGen's Comic API and Animation API.

Homepage: https://llamagen.ai/comic-api

Install

pip install llamagen-python

Quick Start

import os
from llamagen import LlamaGenClient

llamagen = LlamaGenClient(api_key=os.environ["LLAMAGEN_API_KEY"])

created = llamagen.comic.create({
    "prompt": "A 4-panel comic about Leo finding a glowing key in a quiet library.",
    "style": "manga",
    "fixPanelNum": 4,
})

done = llamagen.comic.wait_for_completion(created["id"])
print(done["status"], done.get("comics"))

Client

llamagen = LlamaGenClient(
    api_key="YOUR_API_KEY",
    base_url="https://api.llamagen.ai/v1",
    timeout_ms=30000,
    max_retries=2,
    retry_delay_ms=500,
)

The SDK uses Python's standard library HTTP stack and does not require runtime dependencies.

Comic API

Use llamagen.comic to create comics, manga, webtoons, storyboards, consistent-character pages, and panel edits.

generation = llamagen.comic.create({
    "prompt": "The Little Prince meets the Fox in a luminous desert.",
    "style": "storybook manga",
    "size": "1024x1024",
    "pagination": {"totalPages": 2, "panelsPerPage": 4},
    "comicRoles": [
        {
            "name": "The Little Prince",
            "image": "https://example.com/prince.png",
            "clothing": "green coat and yellow scarf",
        }
    ],
    "attachments": [{"type": "image", "url": "https://example.com/reference.png"}],
    "language": "en",
    "upscale": "2K",
})

Comic methods:

  • llamagen.comic.create(params) calls POST /v1/comics/generations.
  • llamagen.comic.get(id, page=None, panel=None) calls GET /v1/comics/generations/{id}.
  • llamagen.comic.continue_write(id, params) extends an existing comic.
  • llamagen.comic.update_panel(id, params) regenerates one panel.
  • llamagen.comic.usage() calls GET /v1/comics/usage.
  • llamagen.comic.upload(file, filename=None) calls POST /v1/comics/upload.
  • llamagen.comic.wait_for_completion(id, **options) polls until a terminal status.
  • llamagen.comic.create_and_wait(params, **options) creates and polls.
  • llamagen.comic.create_batch(params_list, concurrency=3) submits many jobs.
  • llamagen.comic.wait_for_many(ids, concurrency=3) polls many jobs.

JavaScript-style aliases are also available: createComic, getComic, continueComic, regeneratePanel, updateComicPanel, waitForCompletion, createAndWait, and waitForMany.

Animation API

video = llamagen.animation.create({
    "prompt": "A heroic fox detective walks through neon rain, cinematic camera move.",
    "videoOptions": {
        "duration": 5,
        "resolution": "720p",
        "aspect_ratio": "16:9",
        "image": "https://example.com/first-frame.png",
        "last_frame_image": "https://example.com/last-frame.png",
        "reference_images": ["https://example.com/character.png"],
    },
})

finished = llamagen.animation.wait_for_completion(
    video["id"],
    interval_ms=5000,
    timeout_ms=300000,
)

Animation methods:

  • llamagen.animation.create(params) calls POST /v1/artworks/generations.
  • llamagen.animation.get(id) calls GET /v1/artworks/generations/{id}.
  • llamagen.animation.wait_for_completion(id, **options) polls video status.
  • llamagen.animation.create_and_wait(params, **options) creates and polls.

llamagen.animations is an alias for llamagen.animation.

Webhooks

from llamagen import construct_webhook_event

event = construct_webhook_event(
    payload=raw_body,
    headers=request_headers,
    secret=os.environ["LLAMAGEN_WEBHOOK_SECRET"],
)

The helper verifies X-Llama-Webhook-Timestamp and X-Llama-Webhook-Signature with HMAC SHA-256 and a default 5-minute tolerance.

Errors

from llamagen import LlamaGenAPIError, LlamaGenConnectionError, LlamaGenTimeoutError

try:
    usage = llamagen.comic.usage()
except LlamaGenAPIError as error:
    print(error.status, error.data)
except LlamaGenConnectionError as error:
    print("Network connection failed:", error)
except LlamaGenTimeoutError as error:
    print("Request timed out:", error)
  • LlamaGenAPIError: the API returned a non-2xx response, such as 401, 403, or 429.
  • LlamaGenConnectionError: the SDK could not connect to the API after retries.
  • LlamaGenTimeoutError: the request timed out after retries.

Publishing

Maintainers can follow the release guide in docs/RELEASE.md.

Local Dev

python -m unittest discover -s tests
python -m compileall src tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llamagen_python-0.1.3.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llamagen_python-0.1.3-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file llamagen_python-0.1.3.tar.gz.

File metadata

  • Download URL: llamagen_python-0.1.3.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for llamagen_python-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a04717ac56449a452acfd32db29b284bb2467d27aaca416d64b254f4c33386e7
MD5 bb7554dd3eb7b1a8e90141de569fac43
BLAKE2b-256 ce01cb275e178e6cf04469ef33c4277190e0a9a370f4e7a077eafec9ea539311

See more details on using hashes here.

File details

Details for the file llamagen_python-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for llamagen_python-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f66fd73382c8684c880553e5998ce6ca17ecc96bfea9434e49b79fa6010c75db
MD5 ef769ca51aeb48f371a37ba6cf9165f9
BLAKE2b-256 e598889f6e0a8e9707ff20de611aac5a16a7cb2c7324f889346e75b6c4a6da6e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page