Metadata-Version: 2.4
Name: mistralai-agentic-security
Version: 0.1.0a6
Summary: Typed Python client for the Mistral Agentic Safety service.
Author: Mistral
License: Apache-2.0
Project-URL: homepage, https://github.com/mistralai/dashboard/tree/main/agentic_safety
Project-URL: documentation, https://github.com/mistralai/dashboard/tree/main/agentic_safety
Keywords: ai,agentic,safety,guardrails,security,mistral,llm
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Security
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: httpcore>=1.0.9
Requires-Dist: httpx>=0.28.1
Requires-Dist: pydantic>=2.11.2
Provides-Extra: guardrails
Requires-Dist: mistralai-agents<2,>=1.1.2; (python_version >= "3.12" and python_version < "3.15") and extra == "guardrails"
Requires-Dist: mistralai-vibe-sdk[telemetry]<0.15,>=0.14.0; (python_version >= "3.12" and python_version < "3.15") and extra == "guardrails"

# mistralai-agentic-security

<!--
  Hand-owned header. Speakeasy appends its generated SDK docs below
  and will not inject its scaffold preamble (badges + "not yet ready
  for production" note) because this README already exists at
  generation time. Edit freely. See clients/README.md.
-->

<!-- Start Summary [summary] -->
## Summary

Agentic Safety: Agentic Safety Service API
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [mistralai-agentic-security](#mistralai-agentic-security)
  * [SDK Installation](#sdk-installation)
  * [IDE Support](#ide-support)
  * [SDK Example Usage](#sdk-example-usage)
  * [Authentication](#authentication)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Server Selection](#server-selection)
  * [Custom HTTP Client](#custom-http-client)
  * [Resource Management](#resource-management)
  * [Debugging](#debugging)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

> [!TIP]
> To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).


> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with *uv*, *pip*, or *poetry* package managers.

### uv

*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

```bash
uv add git+<UNSET>.git
```

### PIP

*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

```bash
pip install git+<UNSET>.git
```

### Poetry

*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.

```bash
poetry add git+<UNSET>.git
```

### Shell and script usage with `uv`

You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:

```shell
uvx --from mistralai-agentic-security python
```

It's also possible to write a standalone Python script without needing to set up a whole project like so:

```python
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "mistralai-agentic-security",
# ]
# ///

from mistral.agentic_safety import AgenticSafetyClient

sdk = AgenticSafetyClient(
  # SDK arguments
)

# Rest of script here...
```

Once that is saved to a file, you can run it with `uv run script.py` where
`script.py` can be replaced with the actual file name.
<!-- End SDK Installation [installation] -->

<!-- Start IDE Support [idesupport] -->
## IDE Support

### PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```python
# Synchronous Example
from mistral.agentic_safety import AgenticSafetyClient, models


with AgenticSafetyClient() as agentic_safety_client:

    res = agentic_safety_client.policies.create_policy(name="Block sensitive data", enabled=True, products=[
        models.Product.VIBE_WORK,
    ], rule_ids=[])

    # Handle response
    print(res)
```

</br>

The same SDK client can also be used to make asynchronous requests by importing asyncio.

```python
# Asynchronous Example
import asyncio
from mistral.agentic_safety import AgenticSafetyClient, models

async def main():

    async with AgenticSafetyClient() as agentic_safety_client:

        res = await agentic_safety_client.policies.create_policy_async(name="Block sensitive data", enabled=True, products=[
            models.Product.VIBE_WORK,
        ], rule_ids=[])

        # Handle response
        print(res)

asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name      | Type | Scheme      | Environment Variable |
| --------- | ---- | ----------- | -------------------- |
| `api_key` | http | HTTP Bearer | `MISTRAL_API_KEY`    |

To authenticate with the API the `api_key` parameter must be set when initializing the SDK client instance. For example:
```python
from mistral.agentic_safety import AgenticSafetyClient, models
import os


with AgenticSafetyClient(
    api_key=os.getenv("MISTRAL_API_KEY", ""),
) as agentic_safety_client:

    res = agentic_safety_client.policies.create_policy(name="Block sensitive data", enabled=True, products=[
        models.Product.VIBE_WORK,
    ], rule_ids=[])

    # Handle response
    print(res)

```
<!-- End Authentication [security] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [AgenticSafety](docs/sdks/agenticsafety/README.md)

* [create_policy](docs/sdks/agenticsafety/README.md#create_policy) - Create Policy
* [list_policies](docs/sdks/agenticsafety/README.md#list_policies) - List Policies
* [list_policy_authors_editors](docs/sdks/agenticsafety/README.md#list_policy_authors_editors) - List Policy Authors Editors
* [batch_get_policies](docs/sdks/agenticsafety/README.md#batch_get_policies) - Batch Get Policies
* [count_policies](docs/sdks/agenticsafety/README.md#count_policies) - Count Policies
* [get_policy](docs/sdks/agenticsafety/README.md#get_policy) - Get Policy
* [update_policy](docs/sdks/agenticsafety/README.md#update_policy) - Update Policy
* [delete_policy](docs/sdks/agenticsafety/README.md#delete_policy) - Delete Policy
* [create_rule](docs/sdks/agenticsafety/README.md#create_rule) - Create Rule
* [list_rules](docs/sdks/agenticsafety/README.md#list_rules) - List Rules
* [list_rule_authors_editors](docs/sdks/agenticsafety/README.md#list_rule_authors_editors) - List Rule Authors Editors
* [batch_get_rules](docs/sdks/agenticsafety/README.md#batch_get_rules) - Batch Get Rules
* [count_rules](docs/sdks/agenticsafety/README.md#count_rules) - Count Rules
* [get_rule](docs/sdks/agenticsafety/README.md#get_rule) - Get Rule
* [update_rule](docs/sdks/agenticsafety/README.md#update_rule) - Update Rule
* [delete_rule](docs/sdks/agenticsafety/README.md#delete_rule) - Delete Rule
* [get_bundle](docs/sdks/agenticsafety/README.md#get_bundle) - Get Bundle
* [list_alerts](docs/sdks/agenticsafety/README.md#list_alerts) - List Alerts
* [get_harness_config](docs/sdks/agenticsafety/README.md#get_harness_config) - Get Harness Config
* [make_guardrails_decision](docs/sdks/agenticsafety/README.md#make_guardrails_decision) - Make Guardrails Decision

### [Alerts](docs/sdks/alerts/README.md)

* [list_alerts](docs/sdks/alerts/README.md#list_alerts) - List Alerts

### [Bundles](docs/sdks/bundles/README.md)

* [get_bundle](docs/sdks/bundles/README.md#get_bundle) - Get Bundle

### [Policies](docs/sdks/policies/README.md)

* [create_policy](docs/sdks/policies/README.md#create_policy) - Create Policy
* [list_policies](docs/sdks/policies/README.md#list_policies) - List Policies
* [list_policy_authors_editors](docs/sdks/policies/README.md#list_policy_authors_editors) - List Policy Authors Editors
* [batch_get_policies](docs/sdks/policies/README.md#batch_get_policies) - Batch Get Policies
* [count_policies](docs/sdks/policies/README.md#count_policies) - Count Policies
* [get_policy](docs/sdks/policies/README.md#get_policy) - Get Policy
* [update_policy](docs/sdks/policies/README.md#update_policy) - Update Policy
* [delete_policy](docs/sdks/policies/README.md#delete_policy) - Delete Policy

### [Rules](docs/sdks/rules/README.md)

* [create_rule](docs/sdks/rules/README.md#create_rule) - Create Rule
* [list_rules](docs/sdks/rules/README.md#list_rules) - List Rules
* [list_rule_authors_editors](docs/sdks/rules/README.md#list_rule_authors_editors) - List Rule Authors Editors
* [batch_get_rules](docs/sdks/rules/README.md#batch_get_rules) - Batch Get Rules
* [count_rules](docs/sdks/rules/README.md#count_rules) - Count Rules
* [get_rule](docs/sdks/rules/README.md#get_rule) - Get Rule
* [update_rule](docs/sdks/rules/README.md#update_rule) - Update Rule
* [delete_rule](docs/sdks/rules/README.md#delete_rule) - Delete Rule

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start Retries [retries] -->
## Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from mistral.agentic_safety import AgenticSafetyClient, models
from mistral.agentic_safety.utils import BackoffStrategy, RetryConfig


with AgenticSafetyClient() as agentic_safety_client:

    res = agentic_safety_client.policies.create_policy(name="Block sensitive data", enabled=True, products=[
        models.Product.VIBE_WORK,
    ], rule_ids=[],
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

```

If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from mistral.agentic_safety import AgenticSafetyClient, models
from mistral.agentic_safety.utils import BackoffStrategy, RetryConfig


with AgenticSafetyClient(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as agentic_safety_client:

    res = agentic_safety_client.policies.create_policy(name="Block sensitive data", enabled=True, products=[
        models.Product.VIBE_WORK,
    ], rule_ids=[])

    # Handle response
    print(res)

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

[`SDKError`](./src/mistral/agentic_safety/errors/sdkerror.py) is the base class for all HTTP error responses. It has the following properties:

| Property           | Type             | Description                                                                             |
| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
| `err.message`      | `str`            | Error message                                                                           |
| `err.status_code`  | `int`            | HTTP response status code eg `404`                                                      |
| `err.headers`      | `httpx.Headers`  | HTTP response headers                                                                   |
| `err.body`         | `str`            | HTTP body. Can be empty string if no body is returned.                                  |
| `err.raw_response` | `httpx.Response` | Raw HTTP response                                                                       |
| `err.data`         |                  | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |

### Example
```python
from mistral.agentic_safety import AgenticSafetyClient, errors, models


with AgenticSafetyClient() as agentic_safety_client:
    res = None
    try:

        res = agentic_safety_client.policies.create_policy(name="Block sensitive data", enabled=True, products=[
            models.Product.VIBE_WORK,
        ], rule_ids=[])

        # Handle response
        print(res)


    except errors.SDKError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.HTTPValidationError):
            print(e.data.detail)  # Optional[List[models.ValidationError]]
```

### Error Classes
**Primary error:**
* [`SDKError`](./src/mistral/agentic_safety/errors/sdkerror.py): The base class for HTTP error responses.

<details><summary>Less common errors (8)</summary>

<br />

**Network errors:**
* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
    * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
    * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.


**Inherit from [`SDKError`](./src/mistral/agentic_safety/errors/sdkerror.py)**:
* [`HTTPValidationError`](./src/mistral/agentic_safety/errors/httpvalidationerror.py): Validation Error. Status code `422`. Applicable to 18 of 38 methods.*
* [`NotFoundError`](./src/mistral/agentic_safety/errors/notfounderror.py): 404 body: the requested resource (or filtered set) does not exist. Status code `404`. Applicable to 9 of 38 methods.*
* [`RuleInUseError`](./src/mistral/agentic_safety/errors/ruleinuseerror.py): 409 body: the rule is still referenced by active policies. Status code `409`. Applicable to 1 of 38 methods.*
* [`ResponseValidationError`](./src/mistral/agentic_safety/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.

</details>

\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## Server Selection

### Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
from mistral.agentic_safety import AgenticSafetyClient, models


with AgenticSafetyClient(
    server_url="https://api.mistral.ai",
) as agentic_safety_client:

    res = agentic_safety_client.policies.create_policy(name="Block sensitive data", enabled=True, products=[
        models.Product.VIBE_WORK,
    ], rule_ids=[])

    # Handle response
    print(res)

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.

For example, you could specify a header for every request that this sdk makes as follows:
```python
from mistral.agentic_safety import AgenticSafetyClient
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = AgenticSafetyClient(client=http_client)
```

or you could wrap the client with your own custom logic:
```python
from mistral.agentic_safety import AgenticSafetyClient
from mistral.agentic_safety.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = AgenticSafetyClient(async_client=CustomClient(httpx.AsyncClient()))
```
### httpx2 (Pydantic's httpx fork)

[httpx2](https://httpx2.pydantic.dev/) is Pydantic's maintained fork of `httpx`. To run this SDK on httpx2, call `alias_httpx()` at your program's entry point, before importing the SDK, so every `import httpx` — including the ones inside the SDK — resolves to `httpx2`:
```python
import httpx2

httpx2.alias_httpx()

from mistral.agentic_safety import AgenticSafetyClient

s = AgenticSafetyClient()
```

An SDK can also be generated against httpx2 directly, so it depends on the fork instead of `httpx`, by setting `python.httpClientLibrary: httpx2` in `gen.yaml`.
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Resource Management [resource-management] -->
## Resource Management

The `AgenticSafetyClient` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.

[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers

```python
from mistral.agentic_safety import AgenticSafetyClient
def main():

    with AgenticSafetyClient() as agentic_safety_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with AgenticSafetyClient() as agentic_safety_client:
        # Rest of application here...
```
<!-- End Resource Management [resource-management] -->

<!-- Start Debugging [debug] -->
## Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.
```python
from mistral.agentic_safety import AgenticSafetyClient
import logging

logging.basicConfig(level=logging.DEBUG)
s = AgenticSafetyClient(debug_logger=logging.getLogger("mistral.agentic_safety"))
```

You can also enable a default debug logger by setting an environment variable `MISTRAL_DEBUG` to true.
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->
