Metadata-Version: 2.3
Name: pycredoai
Version: 1.1.0
Summary: Credo AI SDK
Author: Credo AI
Author-email: Credo AI <support@credo.ai>
License:                                  Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
         
            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
         
            1. Definitions.
         
               "License" shall mean the terms and conditions for use, reproduction,
               and distribution as defined by Sections 1 through 9 of this document.
         
               "Licensor" shall mean the copyright owner or entity authorized by
               the copyright owner that is granting the License.
         
               "Legal Entity" shall mean the union of the acting entity and all
               other entities that control, are controlled by, or are under common
               control with that entity. For the purposes of this definition,
               "control" means (i) the power, direct or indirect, to cause the
               direction or management of such entity, whether by contract or
               otherwise, or (ii) ownership of fifty percent (50%) or more of the
               outstanding shares, or (iii) beneficial ownership of such entity.
         
               "You" (or "Your") shall mean an individual or Legal Entity
               exercising permissions granted by this License.
         
               "Source" form shall mean the preferred form for making modifications,
               including but not limited to software source code, documentation
               source, and configuration files.
         
               "Object" form shall mean any form resulting from mechanical
               transformation or translation of a Source form, including but
               not limited to compiled object code, generated documentation,
               and conversions to other media types.
         
               "Work" shall mean the work of authorship, whether in Source or
               Object form, made available under the License, as indicated by a
               copyright notice that is included in or attached to the work
               (an example is provided in the Appendix below).
         
               "Derivative Works" shall mean any work, whether in Source or Object
               form, that is based on (or derived from) the Work and for which the
               editorial revisions, annotations, elaborations, or other modifications
               represent, as a whole, an original work of authorship. For the purposes
               of this License, Derivative Works shall not include works that remain
               separable from, or merely link (or bind by name) to the interfaces of,
               the Work and Derivative Works thereof.
         
               "Contribution" shall mean any work of authorship, including
               the original version of the Work and any modifications or additions
               to that Work or Derivative Works thereof, that is intentionally
               submitted to the Licensor for inclusion in the Work by the copyright owner
               or by an individual or Legal Entity authorized to submit on behalf of
               the copyright owner. For the purposes of this definition, "submitted"
               means any form of electronic, verbal, or written communication sent
               to the Licensor or its representatives, including but not limited to
               communication on electronic mailing lists, source code control systems,
               and issue tracking systems that are managed by, or on behalf of, the
               Licensor for the purpose of discussing and improving the Work, but
               excluding communication that is conspicuously marked or otherwise
               designated in writing by the copyright owner as "Not a Contribution."
         
               "Contributor" shall mean Licensor and any individual or Legal Entity
               on behalf of whom a Contribution has been received by Licensor and
               subsequently incorporated within the Work.
         
            2. Grant of Copyright License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               copyright license to reproduce, prepare Derivative Works of,
               publicly display, publicly perform, sublicense, and distribute the
               Work and such Derivative Works in Source or Object form.
         
            3. Grant of Patent License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               (except as stated in this section) patent license to make, have made,
               use, offer to sell, sell, import, and otherwise transfer the Work,
               where such license applies only to those patent claims licensable
               by such Contributor that are necessarily infringed by their
               Contribution(s) alone or by combination of their Contribution(s)
               with the Work to which such Contribution(s) was submitted. If You
               institute patent litigation against any entity (including a
               cross-claim or counterclaim in a lawsuit) alleging that the Work
               or a Contribution incorporated within the Work constitutes direct
               or contributory patent infringement, then any patent licenses
               granted to You under this License for that Work shall terminate
               as of the date such litigation is filed.
         
            4. Redistribution. You may reproduce and distribute copies of the
               Work or Derivative Works thereof in any medium, with or without
               modifications, and in Source or Object form, provided that You
               meet the following conditions:
         
               (a) You must give any other recipients of the Work or
                   Derivative Works a copy of this License; and
         
               (b) You must cause any modified files to carry prominent notices
                   stating that You changed the files; and
         
               (c) You must retain, in the Source form of any Derivative Works
                   that You distribute, all copyright, patent, trademark, and
                   attribution notices from the Source form of the Work,
                   excluding those notices that do not pertain to any part of
                   the Derivative Works; and
         
               (d) If the Work includes a "NOTICE" text file as part of its
                   distribution, then any Derivative Works that You distribute must
                   include a readable copy of the attribution notices contained
                   within such NOTICE file, excluding those notices that do not
                   pertain to any part of the Derivative Works, in at least one
                   of the following places: within a NOTICE text file distributed
                   as part of the Derivative Works; within the Source form or
                   documentation, if provided along with the Derivative Works; or,
                   within a display generated by the Derivative Works, if and
                   wherever such third-party notices normally appear. The contents
                   of the NOTICE file are for informational purposes only and
                   do not modify the License. You may add Your own attribution
                   notices within Derivative Works that You distribute, alongside
                   or as an addendum to the NOTICE text from the Work, provided
                   that such additional attribution notices cannot be construed
                   as modifying the License.
         
               You may add Your own copyright statement to Your modifications and
               may provide additional or different license terms and conditions
               for use, reproduction, or distribution of Your modifications, or
               for any such Derivative Works as a whole, provided Your use,
               reproduction, and distribution of the Work otherwise complies with
               the conditions stated in this License.
         
            5. Submission of Contributions. Unless You explicitly state otherwise,
               any Contribution intentionally submitted for inclusion in the Work
               by You to the Licensor shall be under the terms and conditions of
               this License, without any additional terms or conditions.
               Notwithstanding the above, nothing herein shall supersede or modify
               the terms of any separate license agreement you may have executed
               with Licensor regarding such Contributions.
         
            6. Trademarks. This License does not grant permission to use the trade
               names, trademarks, service marks, or product names of the Licensor,
               except as required for reasonable and customary use in describing the
               origin of the Work and reproducing the content of the NOTICE file.
         
            7. Disclaimer of Warranty. Unless required by applicable law or
               agreed to in writing, Licensor provides the Work (and each
               Contributor provides its Contributions) on an "AS IS" BASIS,
               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
               implied, including, without limitation, any warranties or conditions
               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
               PARTICULAR PURPOSE. You are solely responsible for determining the
               appropriateness of using or redistributing the Work and assume any
               risks associated with Your exercise of permissions under this License.
         
            8. Limitation of Liability. In no event and under no legal theory,
               whether in tort (including negligence), contract, or otherwise,
               unless required by applicable law (such as deliberate and grossly
               negligent acts) or agreed to in writing, shall any Contributor be
               liable to You for damages, including any direct, indirect, special,
               incidental, or consequential damages of any character arising as a
               result of this License or out of the use or inability to use the
               Work (including but not limited to damages for loss of goodwill,
               work stoppage, computer failure or malfunction, or any and all
               other commercial damages or losses), even if such Contributor
               has been advised of the possibility of such damages.
         
            9. Accepting Warranty or Additional Liability. While redistributing
               the Work or Derivative Works thereof, You may choose to offer,
               and charge a fee for, acceptance of support, warranty, indemnity,
               or other liability obligations and/or rights consistent with this
               License. However, in accepting such obligations, You may act only
               on Your own behalf and on Your sole responsibility, not on behalf
               of any other Contributor, and only if You agree to indemnify,
               defend, and hold each Contributor harmless for any liability
               incurred by, or claims asserted against, such Contributor by reason
               of your accepting any such warranty or additional liability.
         
            END OF TERMS AND CONDITIONS
         
            Copyright 2025 Credo AI
         
            Licensed under the Apache License, Version 2.0 (the "License");
            you may not use this file except in compliance with the License.
            You may obtain a copy of the License at
         
                http://www.apache.org/licenses/LICENSE-2.0
         
            Unless required by applicable law or agreed to in writing, software
            distributed under the License is distributed on an "AS IS" BASIS,
            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            See the License for the specific language governing permissions and
            limitations under the License.
Classifier: Development Status :: 4 - Beta
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: Programming Language :: Python :: 3.15
Requires-Dist: attrs>=21.3.0
Requires-Dist: httpx>=0.24.0
Requires-Dist: pydantic>=2.0.0
Requires-Python: >=3.10
Project-URL: Homepage, https://credo.ai
Description-Content-Type: text/markdown

# CredoAI Python SDK

Credo AI SDK

## Quick Start

### Using Environment Variables (Recommended)

Set the following environment variables:

```bash
export CREDOAI_API_KEY="your-api-key"
export CREDOAI_API_URL="https://api.credo.ai"  # optional, this is the default
export CREDOAI_TENANT="your-tenant"            # required, your CredoAI tenant
```

Then use the client without any arguments:

```python
from credoai import CredoAI, UseCaseCreate

# No arguments needed when env vars are set
client = CredoAI()

# Create a use case
use_case = client.use_cases.create(
    data=UseCaseCreate(name="My AI Model", description="A machine learning model")
)
print(f"Created: {use_case.id}")
```

### Synchronous Client

```python
from credoai import CredoAI, UseCaseCreate, UseCaseUpdate

# Option 1: Using environment variables (recommended)
client = CredoAI()

# Option 2: Using explicit arguments (overrides env vars)
client = CredoAI(
    base_url="https://api.credo.ai",  # optional - defaults to CREDOAI_API_URL or https://api.credo.ai
    api_key="your-api-key",      # required if CREDOAI_API_KEY not set
    tenant="your-tenant"              # optional - defaults to CREDOAI_TENANT or "credoai"
)

# Create a use case with Pydantic model
use_case_data = UseCaseCreate(
    name="My AI Model",
    description="A machine learning model for predictions"
)
use_case = client.use_cases.create(data=use_case_data)

# Get a use case
use_case = client.use_cases.get(use_case_id="123")

# Update a use case with Pydantic model
update_data = UseCaseUpdate(description="Updated description")
updated_use_case = client.use_cases.update(use_case_id="123", data=update_data)

# Health checks
status = client.system.ping()
liveness = client.health.check_liveness()
readiness = client.health.check_readiness()
```

### Asynchronous Client

```python
import asyncio
from credoai import AsyncCredoAI, UseCaseCreate, UseCaseUpdate

async def main():
    # Option 1: Using environment variables (recommended)
    client = AsyncCredoAI()

    # Option 2: Using explicit arguments
    client = AsyncCredoAI(
        base_url="https://api.credo.ai",
        api_key="your-api-key"
    )

    # Create a use case with Pydantic model
    use_case_data = UseCaseCreate(
        name="My AI Model",
        description="A machine learning model for predictions"
    )
    use_case = await client.use_cases.create(data=use_case_data)

    # Get a use case
    use_case = await client.use_cases.get(use_case_id="123")

    # Update a use case with Pydantic model
    update_data = UseCaseUpdate(description="Updated description")
    updated_use_case = await client.use_cases.update(use_case_id="123", data=update_data)

    # Health checks
    status = await client.system.ping()
    liveness = await client.health.check_liveness()
    readiness = await client.health.check_readiness()

# Run async code
asyncio.run(main())
```

## Configuration

### Environment Variables

The SDK supports configuration via environment variables. This is the recommended approach for production deployments:

| Variable          | Description                    | Default                |
| ----------------- | ------------------------------ | ---------------------- |
| `CREDOAI_API_KEY` | API key for authentication     | _(required)_           |
| `CREDOAI_API_URL` | Base URL of the API service    | `https://api.credo.ai` |
| `CREDOAI_TENANT`  | Your CredoAI tenant identifier | _(required)_           |

**Note:** The SDK automatically appends `/api/v1/integration` to the base URL. You only need to provide the base domain (e.g., `https://api.credo.ai`).

```bash
# Set environment variables
export CREDOAI_API_KEY="your-api-key"
export CREDOAI_API_URL="https://api.credo.ai"
export CREDOAI_TENANT="your-tenant"
```

```python
from credoai import CredoAI

# Client automatically uses environment variables
client = CredoAI()
```

Constructor arguments always take precedence over environment variables:

```python
# Explicit arguments override env vars
client = CredoAI(
    api_key="your-api-key",  # Overrides CREDOAI_API_KEY
    tenant="other-tenant"    # Overrides CREDOAI_TENANT
    # base_url uses CREDOAI_API_URL since not specified
)
```

### Authentication

The SDK uses API key authentication with automatic JWT token exchange:

```python
from credoai import CredoAI

# Using environment variables (recommended)
client = CredoAI()

# Or with explicit arguments
client = CredoAI(
    base_url="https://api.credo.ai",
    api_key="your-api-key",
    tenant="your-tenant"
)
```

#### Authentication Flow

- The client calls `/api/v1/integration/auth/token` at initialization to exchange your API key for a JWT token
- All API requests use `Authorization: Bearer <jwt-token>` header format internally

### Advanced Configuration

```python
import httpx
from credoai import CredoAI

# Full configuration with all options
client = CredoAI(
    base_url="https://api.credo.ai",  # Or set CREDOAI_API_URL
    api_key="your-api-key",           # Or set CREDOAI_API_KEY
    tenant="your-tenant",             # Or set CREDOAI_TENANT
    timeout=30.0,
    verify_ssl=True,
    headers={"Custom-Header": "value"},
    cookies={"session": "token"}
)

# Custom httpx configuration
client = CredoAI(
    api_key="your-api-key",  # Other params from env vars
    httpx_args={
        "proxies": "http://localhost:8080",
        "event_hooks": {
            "request": [lambda request: print(f"Request: {request.method} {request.url}")],
            "response": [lambda response: print(f"Response: {response.status_code}")]
        }
    }
)
```

## Context Managers

Both clients support context managers for automatic resource cleanup:

### Synchronous

```python
from credoai import CredoAI

with CredoAI(base_url="https://api.example.com", api_key="your-api-key") as client:
    use_case = client.use_cases.get(use_case_id="123")
    # Connection automatically closed
```

### Asynchronous

```python
from credoai import AsyncCredoAI

async def main():
    async with AsyncCredoAI(base_url="https://api.example.com", api_key="your-api-key") as client:
        use_case = await client.use_cases.get(use_case_id="123")
        # Connection automatically closed

asyncio.run(main())
```

## API Examples

### Use Cases

Create, list, read, update, and delete use cases.

#### Create a Use Case

```python
from credoai import CredoAI, UseCaseCreate

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Create with Pydantic model
data = UseCaseCreate(
    name="Risk Assessment Model",
    description="ML model for credit risk assessment"
)
use_case = client.use_cases.create(data=data)
print(f"Created use case with ID: {use_case.id}")
```

#### List Use Cases

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# List all use cases
use_cases = client.use_cases.lists()
for uc in use_cases:
    print(f"- {uc.name}: {uc.description}")
```

#### Get a Use Case

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Get by ID
use_case = client.use_cases.get(use_case_id="123")
print(f"Name: {use_case.name}")
print(f"Description: {use_case.description}")
```

#### Update a Use Case

```python
from credoai import CredoAI, UseCaseUpdate

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Update with Pydantic model
data = UseCaseUpdate(
    name="Updated Risk Model",
    description="Updated description for the model"
)
updated = client.use_cases.update(use_case_id="123", data=data)
print(f"Updated: {updated.name}")
```

#### Delete a Use Case

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Delete by ID
client.use_cases.delete(use_case_id="123")
print("Use case deleted")
```

### Models

Create, list, read, update, and delete models.

#### Create a Model

```python
from credoai import CredoAI, ModelCreate

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Create with Pydantic model
data = ModelCreate(
    name="GPT-4 Classification",
    description="LLM-based text classification model"
)
model = client.models.create(data=data)
print(f"Created model with ID: {model.id}")
```

#### List Models

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# List all models
models = client.models.lists()
for m in models:
    print(f"- {m.name}: {m.description}")
```

#### Get a Model

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Get by ID
model = client.models.get(model_id="456")
print(f"Name: {model.name}")
print(f"Description: {model.description}")
```

#### Update a Model

```python
from credoai import CredoAI, ModelUpdate

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Update with Pydantic model
data = ModelUpdate(
    name="GPT-4 Classification v2",
    description="Improved classification model"
)
updated = client.models.update(model_id="456", data=data)
print(f"Updated: {updated.name}")
```

#### Delete a Model

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Delete by ID
client.models.delete(model_id="456")
print("Model deleted")
```

### Vendors

Full CRUD operations for managing vendors.

#### Create a Vendor

```python
from credoai import CredoAI, VendorCreate

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Create with Pydantic model
data = VendorCreate(
    name="OpenAI",
    description="AI research and deployment company"
)
vendor = client.vendors.create(data=data)
print(f"Created vendor with ID: {vendor.id}")
```

#### List Vendors

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# List all vendors
vendors = client.vendors.lists()
for v in vendors:
    print(f"- {v.name}: {v.description}")
```

#### Get a Vendor

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Get by ID
vendor = client.vendors.get(vendor_id="789")
print(f"Name: {vendor.name}")
print(f"Description: {vendor.description}")
```

#### Update a Vendor

```python
from credoai import CredoAI, VendorUpdate

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Update with Pydantic model
data = VendorUpdate(
    name="OpenAI Inc.",
    description="Updated vendor description"
)
updated = client.vendors.update(vendor_id="789", data=data)
print(f"Updated: {updated.name}")
```

#### Delete a Vendor

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Delete by ID
client.vendors.delete(vendor_id="789")
print("Vendor deleted")
```

### System & Health

System status and health check endpoints.

#### Ping

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Check system status
status = client.system.ping()
print(f"System status: {status}")
```

#### Metrics

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Get system metrics
metrics = client.system.metrics_metrics()
print(f"Metrics: {metrics}")
```

#### Liveness Check

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Check if service is alive
liveness = client.health.check_liveness()
print(f"Liveness: {liveness}")
```

#### Readiness Check

```python
from credoai import CredoAI

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

# Check if service is ready to accept requests
readiness = client.health.check_readiness()
print(f"Readiness: {readiness}")
```

### Async Examples

All endpoints are available with async versions using `AsyncCredoAI`:

```python
import asyncio
from credoai import (
    AsyncCredoAI,
    UseCaseCreate, UseCaseUpdate,
    ModelCreate, ModelUpdate,
    VendorCreate, VendorUpdate,
)

async def main():
    client = AsyncCredoAI(base_url="https://api.example.com", api_key="your-api-key")

    # Use Cases
    use_case = await client.use_cases.create(
        data=UseCaseCreate(name="Async Use Case", description="Created async")
    )
    use_cases = await client.use_cases.lists()
    use_case = await client.use_cases.get(use_case_id=use_case.id)
    use_case = await client.use_cases.update(
        use_case_id=use_case.id,
        data=UseCaseUpdate(description="Updated async")
    )
    await client.use_cases.delete(use_case_id=use_case.id)

    # Models
    model = await client.models.create(
        data=ModelCreate(name="Async Model", description="Created async")
    )
    models = await client.models.lists()
    model = await client.models.get(model_id=model.id)
    model = await client.models.update(
        model_id=model.id,
        data=ModelUpdate(description="Updated async")
    )
    await client.models.delete(model_id=model.id)

    # Vendors
    vendor = await client.vendors.create(
        data=VendorCreate(name="Async Vendor", description="Created async")
    )
    vendors = await client.vendors.lists()
    vendor = await client.vendors.get(vendor_id=vendor.id)
    vendor = await client.vendors.update(
        vendor_id=vendor.id,
        data=VendorUpdate(description="Updated async")
    )
    await client.vendors.delete(vendor_id=vendor.id)

    # System & Health
    status = await client.system.ping()
    metrics = await client.system.metrics_metrics()
    liveness = await client.health.check_liveness()
    readiness = await client.health.check_readiness()

asyncio.run(main())
```

## API Reference

### Use Cases

| Method                                                                       | Description             |
| ---------------------------------------------------------------------------- | ----------------------- |
| `use_cases.create(data: UseCaseCreate) -> UseCaseResponse`                   | Create a new use case   |
| `use_cases.lists() -> List[UseCaseResponse]`                                 | List all use cases      |
| `use_cases.get(use_case_id: str) -> UseCaseResponse`                         | Get a specific use case |
| `use_cases.update(use_case_id: str, data: UseCaseUpdate) -> UseCaseResponse` | Update a use case       |
| `use_cases.delete(use_case_id: str)`                                         | Delete a use case       |

### Models

| Method                                                             | Description          |
| ------------------------------------------------------------------ | -------------------- |
| `models.create(data: ModelCreate) -> ModelResponse`                | Create a new model   |
| `models.lists() -> List[ModelResponse]`                            | List all models      |
| `models.get(model_id: str) -> ModelResponse`                       | Get a specific model |
| `models.update(model_id: str, data: ModelUpdate) -> ModelResponse` | Update a model       |
| `models.delete(model_id: str)`                                     | Delete a model       |

### Vendors

| Method                                                                 | Description           |
| ---------------------------------------------------------------------- | --------------------- |
| `vendors.create(data: VendorCreate) -> VendorResponse`                 | Create a new vendor   |
| `vendors.lists() -> List[VendorResponse]`                              | List all vendors      |
| `vendors.get(vendor_id: str) -> VendorResponse`                        | Get a specific vendor |
| `vendors.update(vendor_id: str, data: VendorUpdate) -> VendorResponse` | Update a vendor       |
| `vendors.delete(vendor_id: str)`                                       | Delete a vendor       |

### System

| Method                            | Description                  |
| --------------------------------- | ---------------------------- |
| `system.ping() -> PingResponse`   | Health check / ping endpoint |
| `system.metrics_metrics() -> Any` | Get system metrics           |

### Health

| Method                                       | Description                |
| -------------------------------------------- | -------------------------- |
| `health.check_liveness() -> HealthResponse`  | Kubernetes liveness probe  |
| `health.check_readiness() -> HealthResponse` | Kubernetes readiness probe |

### Client Configuration

Both `CredoAI` and `AsyncCredoAI` inherit from the base client classes and support these parameters:

| Parameter          | Type                            | Description                                               | Default                                             |
| ------------------ | ------------------------------- | --------------------------------------------------------- | --------------------------------------------------- |
| `base_url`         | `str \| None`                   | Base URL for the API (without `/api/v1/integration` path) | `CREDOAI_API_URL` env var or `https://api.credo.ai` |
| `api_key`          | `str \| None`                   | Your API key for authentication                           | `CREDOAI_API_KEY` env var _(required)_              |
| `tenant`           | `str \| None`                   | Your CredoAI tenant identifier                            | `CREDOAI_TENANT` env var _(required)_               |
| `timeout`          | `float \| httpx.Timeout`        | Request timeout configuration                             | `30.0`                                              |
| `verify_ssl`       | `bool \| str \| ssl.SSLContext` | SSL certificate verification                              | `True`                                              |
| `headers`          | `dict[str, str]`                | Additional headers for all requests                       | `{}`                                                |
| `cookies`          | `dict[str, str]`                | Cookies to include with all requests                      | `{}`                                                |
| `follow_redirects` | `bool`                          | Whether to follow HTTP redirects                          | `False`                                             |
| `httpx_args`       | `dict`                          | Additional arguments passed to httpx client               | `{}`                                                |

## Low-Level API Access

For advanced users who need direct access to the underlying HTTP client:

```python
from credoai import AuthenticatedClient
from credoai.models import UseCaseCreate
import httpx

# Using the lower-level authenticated client directly
client = AuthenticatedClient(
    base_url="https://api.example.com",
    token="your-api-key",
    auth_header_name="X-API-Key",
    prefix=""
)

# Manual HTTP request construction
use_case_data = UseCaseCreate(name="Test", description="A test use case")
json_data = use_case_data.model_dump()

with client as httpx_client:
    # Direct HTTP requests
    response = httpx_client.post("/api/v1/use_cases", json=json_data)
    print(f"Status: {response.status_code}, Data: {response.json()}")

    # Get request
    response = httpx_client.get("/api/v1/integration/ping")
    print(f"Ping: {response.json()}")
```

## Error Handling

```python
from credoai import CredoAI
from credoai.errors import ApiError
import httpx

client = CredoAI(base_url="https://api.example.com", api_key="your-api-key")

try:
    use_case = client.use_cases.get(use_case_id="invalid-id")
except ApiError as e:
    print(f"API error: {e.status_code} - {e.message}")
except httpx.HTTPStatusError as e:
    if e.response.status_code == 404:
        print("Use case not found")
    elif e.response.status_code == 422:
        print("Validation error")
        # Parse validation errors if needed
        if e.response.headers.get("content-type") == "application/json":
            error_data = e.response.json()
            print(f"Validation details: {error_data}")
    else:
        print(f"HTTP error: {e.response.status_code}")
except httpx.RequestError as e:
    print(f"Request failed: {e}")
```

## Development

This package is generated using the Credo AI SDK generator.

To regenerate the client:

1. Ensure the API server is running with updated OpenAPI spec
2. Run the generation script from the parent repository
3. The client will be updated with any API changes

## Contributing

1. Make changes to the API server and update OpenAPI specifications
2. Regenerate the client using the provided generation scripts
3. Test the generated client thoroughly
4. Submit pull requests to the main repository

## License

This project is licensed under the terms specified in the parent repository.
