Metadata-Version: 2.4
Name: yaagents-client
Version: 0.4.0
Summary: YAAgents Python client — Agentic REST Profile v0.3
Project-URL: Homepage, https://github.com/ai-mpathyminds/yaagents
Project-URL: Supports-YAAgents-Profile, https://github.com/ai-mpathyminds/yaagents/blob/v0.3.0/spec/agentic-rest-profile.md
License: Apache-2.0
License-File: LICENSE
Keywords: REST,agentic,client,profile-v0.3,yaagents
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.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: <4,>=3.11
Requires-Dist: httpx>=0.27
Provides-Extra: test
Requires-Dist: pip-audit>=2.7; extra == 'test'
Requires-Dist: pytest-cov>=5; extra == 'test'
Requires-Dist: pytest>=8; extra == 'test'
Description-Content-Type: text/markdown

# yaagents-client

Python client for the **YAAgents Agentic REST Profile v0.3**.

Supports-YAAgents-Profile: **v0.3**

## Install

```bash
pip install yaagents-client==0.3.0
```

## Quickstart

```python
from yaagents_client import YaAgentsClient

with YaAgentsClient(
    base_url="https://api.example.com",
    token="<bearer-token>",
    tenant_id="<tenant-id>",
) as client:
    response = client.campaigns("camp-123").optimizations.create(
        {"goal": "ctr", "budget": 1000}
    )
    print(response.status_code, response.json())
```

## Headers

Every request carries:

| Header | Value |
|--------|-------|
| `Authorization` | `Bearer <token>` |
| `X-Tenant-ID` | value passed to constructor |
| `X-Correlation-ID` | auto-generated UUID v4 (overridable per call) |

## Resources

| Accessor | HTTP | Path |
|----------|------|------|
| `campaigns(id).optimizations.create(body)` | POST | `/campaigns/{id}/optimizations` |
| `campaigns(id).assets.generate(body)` | POST | `/campaigns/{id}/assets:generate` |

Source: https://github.com/ai-mpathyminds/yaagents-client-python

Community docs: https://github.com/ai-mpathyminds/yaagents
