Imperal SDK

Build extensions for Webbee 🐝 — the agent of Imperal Cloud, the world's first AI Cloud OS.

Write a small Python function. Webbee calls it when a user asks for it — in their own words. Ship it to the Marketplace and get paid.

PyPI Python License

Documentation · Quickstart · PyPI · imperal.io

What this is

Imperal Cloud is the world's first AI Cloud OS — a cloud you connect the contexts of your life into (mail, money, projects, servers, notes, anything) and then run entirely in your own native language. Webbee 🐝 is the AI agent that lives inside it and does the work for you, safely.

The Imperal SDK is how you give Webbee a new skill. You write a small, typed Python extension; Webbee picks it up and calls it whenever a user asks for what it does — in plain language. The platform handles the hard parts — authentication, billing, multi-tenancy, audit, recovery, LLM routing — so your code stays small.

pip install imperal-sdk

Python 3.11+ · Apache-2.0

Why build here

  • Webbee calls your function directly. Typed, structured calls — no LLM guessing your arguments, no silent write failures.
  • The platform does the plumbing. Auth, per-user isolation, billing, audit, retries and recovery, multi-tenant safety — handled for you.
  • You get paid. Publish to the Imperal Marketplace, price your extension, earn on every use.
  • Bring any LLM. Users connect their own model keys — Anthropic, OpenAI, Google, Ollama, any OpenAI-compatible API.

A 60-second extension

from imperal_sdk import Extension, ChatExtension, ActionResult
from pydantic import BaseModel, Field

ext = Extension(
    "hello-world",
    version="1.0.0",
    display_name="Hello World",
    description="Greets people by name with a friendly message.",
    icon="icon.svg",
    actions_explicit=True,
)

chat = ChatExtension(ext, tool_name="hello_world", description="Friendly greetings.")


class GreetParams(BaseModel):
    name: str = Field(..., description="Person to greet")


@chat.function("greet", description="Greet someone by name.", action_type="read")
async def greet(ctx, params: GreetParams) -> ActionResult:
    return ActionResult.success(
        data={"message": f"Hello, {params.name}! 🐝"},
        summary=f"Greeted {params.name}",
    )

That's a real, working extension. When a user types "say hi to Alex", Webbee calls greet(name="Alex").

→ Full walkthrough, from zero to published: docs.imperal.io

What you can build

  • Chat tools — typed @chat.functions Webbee calls straight from natural language.
  • Panels — UI surfaces rendered inside the Imperal Panel.
  • Skeletons — live data feeds that keep Webbee aware of a user's state.
  • Scheduled jobs & webhooks — act on a timer, or react to outside events.
  • Typed entities (SDL) — return sdl.Entity objects and the platform reads their meaning (id, title, kind, …) directly instead of guessing field names. Live in production.

Every published extension passes the federal contract — the validators that let Webbee call your code safely. The SDK checks it locally before you ship.

Test without a server

from imperal_sdk.testing import MockContext

async def test_greet():
    ctx = MockContext()
    result = await greet(ctx, GreetParams(name="Alex"))
    assert result.status == "success"

Documentation

The full API, the manifest schema, every validator, recipes, and the federal contract live at docs.imperal.io — that's the source of truth; this README is just the doorway.
Documentation docs.imperal.io
Quickstart docs.imperal.io/en/getting-started/quick-start
PyPI pypi.org/project/imperal-sdk
Changelog CHANGELOG.md
License Apache-2.0

Built by Imperal, Inc. — Webbee 🐝 is its agent.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (5.13.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for notVallium from gravatar.com notVallium

Credits

Author: Valentin Scerbacov, Imperal, Inc.

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.11

Provides Extra

contract db dev fastapi

Classifiers

Report project as malware

Download files

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

Source Distribution

imperal_sdk-5.9.18.tar.gz (752.7 kB view details)

Uploaded Source

Built Distribution

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

imperal_sdk-5.9.18-py3-none-any.whl (313.6 kB view details)

Uploaded Python 3

File details

Details for the file imperal_sdk-5.9.18.tar.gz.

File metadata

  • Download URL: imperal_sdk-5.9.18.tar.gz
  • Upload date:
  • Size: 752.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for imperal_sdk-5.9.18.tar.gz
Algorithm Hash digest
SHA256 1c18bad2d39b03dc44d2b5b18aad30af60873efd8e7a68c4f83b25452b318255
MD5 670fc30c18a6c6f283ef4196ea711994
BLAKE2b-256 934567cc7f45e1fb7f48bb8ff7589f3a932310095ae83b43c9e41e4aefe030f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for imperal_sdk-5.9.18.tar.gz:

Publisher: publish.yml on imperalcloud/imperal-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file imperal_sdk-5.9.18-py3-none-any.whl.

File metadata

  • Download URL: imperal_sdk-5.9.18-py3-none-any.whl
  • Upload date:
  • Size: 313.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for imperal_sdk-5.9.18-py3-none-any.whl
Algorithm Hash digest
SHA256 efa73f94f07de7eb8afc2bd1fb5ec2b890b908ced0e1647236390a2c1014b9d4
MD5 4f6f25267b1d13ed828e8580fce2a46d
BLAKE2b-256 9e106a90f70763a9b83920e191c82fbcc855dc6ed857ec71cff191799c42cd24

See more details on using hashes here.

Provenance

The following attestation bundles were made for imperal_sdk-5.9.18-py3-none-any.whl:

Publisher: publish.yml on imperalcloud/imperal-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

5.13.1

2 files

5.13.0

2 files

5.12.1

2 files

5.12.0

2 files

5.11.0

2 files

5.10.0

2 files

5.9.22

2 files

5.9.21

2 files

5.9.20

2 files

5.9.19

2 files

This release

5.9.18 This release

2 files

5.9.17

2 files

5.9.16

2 files

5.9.13

2 files

5.9.12

2 files

5.9.11

2 files

5.9.10

2 files

5.9.9

2 files

5.9.8

2 files

5.9.7

2 files

5.9.6

2 files

5.9.5

2 files

5.9.4

2 files

5.9.3

2 files

5.9.2

2 files

5.9.1

2 files

5.9.0

2 files

5.8.2

2 files

5.8.1

2 files

5.8.0

2 files

5.7.3

2 files

5.7.2

2 files

5.7.1

2 files

5.7.0

2 files

5.6.1

2 files

5.6.0

2 files

5.5.1

2 files

5.5.0

2 files

5.4.3

2 files

5.4.2

2 files

5.4.1

2 files

5.4.0

2 files

5.3.0

2 files

5.2.2

2 files

5.2.1

2 files

5.2.0

2 files

5.1.0

2 files

5.0.3

2 files

5.0.2

2 files

5.0.1

2 files

5.0.0

2 files

4.2.16

2 files

4.2.15

2 files

4.2.14

2 files

4.2.13

2 files

4.2.12

2 files

4.2.11

2 files

4.2.10

2 files

4.2.9

2 files

4.2.8

2 files

4.2.7

2 files

4.2.6

2 files

4.2.5

2 files

4.2.4

2 files

4.2.3

2 files

4.2.2

2 files

4.2.1

2 files

4.2.0

2 files

4.1.9

2 files

4.1.8

2 files

4.1.7

2 files

4.1.6

2 files

4.1.5

2 files

4.1.4

2 files

4.1.3

2 files

4.1.2

2 files

4.1.1

2 files

4.1.0

2 files

4.0.1

2 files

4.0.0

2 files

3.7.0

2 files

3.6.0

2 files

3.5.2

2 files

3.5.1

2 files

3.5.0

2 files

3.4.1

2 files

3.4.0

2 files

3.3.1

2 files

3.3.0

2 files

3.2.0

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.0.1

2 files

2.0.0

2 files

1.6.2

2 files

1.6.1

2 files

1.6.0

2 files

1.5.27

2 files

1.5.26

2 files

1.5.25

2 files

1.5.24

2 files

1.5.23

2 files

1.5.22

2 files

1.5.21

2 files

1.5.20

2 files

1.5.19

2 files

1.5.18

2 files

1.5.17

2 files

1.5.16

2 files

1.5.14

2 files

1.5.13

2 files

1.5.12

2 files

1.5.9

2 files

1.5.8

2 files

1.5.7

2 files

1.5.6

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.0

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page