SDK (Python)

This is a reference-style overview of a demo Python SDK.

Installation

pip install iron-messages

Client initialization

from iron_messages import Client

client = Client(api_key="...", base_url="https://sandbox.api.iron.example")

Methods

client.publish(type: str, data: dict, idempotency_key: str | None = None) -> Message

Publishes a message.

Example:

msg = client.publish(
  type="hello",
  data={"name": "world"},
  idempotency_key="hello-1",
)
print(msg.id)

client.poll(max: int = 1, visibility_timeout_seconds: int = 30) -> list[Message]

Returns up to max messages.

client.ack(message_id: str) -> None

Acknowledges a message.

---

Next: Getting Started · Reference · Changelog · Support