Skip to main content

Avatars

User and brand avatar management.

Access it as client.avatars on a Strongly client, or the same path on AsyncStrongly with await. All methods exist on both with identical signatures.

Quick start​

from strongly import Strongly

client = Strongly()

# List (auto-paginates as you iterate)
for avatar in client.avatars.list():
    print(avatar.id)

# Create
created = client.avatars.create(
    name="...",
)
print(created.id)

# Read it back
fetched = client.avatars.retrieve(created.id)

# Delete (returns None; raises on failure)
client.avatars.delete(created.id)

Methods​

Core​

list​

list(**params) -> List[Avatar]

List the caller's avatars.

create​

create(*, name: str, description: Optional[str] = None, type: Optional[str] = None, image_url: Optional[str] = None, config: Optional[Mapping[str, Any]] = None) -> Avatar

Create an avatar.

retrieve​

retrieve(avatar_id: str) -> Avatar

Retrieve a single avatar by id.

update​

update(avatar_id: str, *, name: Optional[str] = None, description: Optional[str] = None, image_url: Optional[str] = None, config: Optional[Mapping[str, Any]] = None) -> Avatar

Update an avatar and return the updated record.

delete​

delete(avatar_id: str) -> None

Delete an avatar. Raises on failure; returns nothing.

Other​

preview​

preview(avatar_id: str, *, options: Optional[Mapping[str, Any]] = None) -> Dict[str, Any]

Render a preview of the avatar.

Args: options: Optional free-form preview/render options forwarded to the rendering backend.