Skip to main content

Vibe SDK

High-level Python interface for running Vibe agents.

The SDK gives you:

  • Agent and stateful async/sync sessions
  • Pydantic-based tool authoring
  • Built-in filesystem tools
  • Client-handled tools for UI- or host-dependent actions, such as asking the user a question
  • Skills: reusable instruction sets advertised in the prompt and loaded on demand

For architecture and design references, see ARCHITECTURE.md and documentation/INDEX.md.

Advanced raw task-protocol examples live in examples/advanced_task_protocol_examples. They are not the primary public SDK API, but they are useful end-to-end probes for local, HTTP, and workflow execution.

Quick Start

from mistralai.vibe.sdk import Agent, AgentConfig
from mistralai.vibe.sdk.execution_record.patching.json_patch import apply_patches
from mistralai.vibe.sdk.execution_record.state import TaskState
from mistralai.vibe.sdk.transports.events import TaskResultEvent, TaskStateUpdateEvent

agent = Agent(
    config=AgentConfig(
        model="mistral-large-latest",
        system_prompt="You are a concise assistant.",
    )
)

async with agent.session() as session:
    state = TaskState(input="Hello")
    async for event in session.run("Hello"):
        if isinstance(event, TaskStateUpdateEvent):
            state = apply_patches(state, event.payload.patches)
        elif isinstance(event, TaskResultEvent):
            state = event.payload.result

    print(state.output)

Skills

Skills let an agent discover short task-specific summaries up front and load the full instructions only when needed through the builtin skill tool.

from mistralai.vibe.sdk import Agent, AgentConfig, SkillDefinition

agent = Agent(
    config=AgentConfig(
        model="mistral-large-latest",
        skills=[
            SkillDefinition(
                name="interview",
                description="Use when running a structured user interview.",
                content="Ask one question at a time and summarize decisions at the end.",
            )
        ],
    )
)

Download files

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

Source Distribution

mistralai_vibe_sdk-0.8.0.tar.gz (134.6 kB view details)

Uploaded Source

Built Distribution

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

mistralai_vibe_sdk-0.8.0-py3-none-any.whl (188.0 kB view details)

Uploaded Python 3

File details

Details for the file mistralai_vibe_sdk-0.8.0.tar.gz.

File metadata

  • Download URL: mistralai_vibe_sdk-0.8.0.tar.gz
  • Upload date:
  • Size: 134.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mistralai_vibe_sdk-0.8.0.tar.gz
Algorithm Hash digest
SHA256 db765d4f518bd587c51400dde302b4c7f6a65c8b96e4bcb47153e84fe5be8c2e
MD5 e79c2010b1db0b7f3147799be4ef29f8
BLAKE2b-256 28cb5086bf699be96b6a74fccc8c7612856e1b9522e205eb26099aca948fe7ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for mistralai_vibe_sdk-0.8.0.tar.gz:

Publisher: release.yml on mistralai/vibe-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 mistralai_vibe_sdk-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mistralai_vibe_sdk-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c059095b8aa8fefd1da642d8c349c7e1a0a3dff7736760cbf4524bc2aec1a0c
MD5 5736f2e08b112c2da0106c329e9357b1
BLAKE2b-256 a21e0d116e97ec6aa38c014b5b252d91d8ca231be4f866340c6288c141b8b3d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for mistralai_vibe_sdk-0.8.0-py3-none-any.whl:

Publisher: release.yml on mistralai/vibe-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

0.13.2

2 files

0.12.1

2 files

0.11.0

2 files

0.10.1

2 files

0.10.0

2 files

0.9.0

2 files

This release

0.8.0 This release

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.0.1

2 files

Supported by

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