Plato SDK

Common errors

• ValueError: PLATO_API_KEY environment variable not set

  cause The `PLATO_API_KEY` environment variable was not configured, and no `api_key` was provided during client initialization.
  fix Set the `PLATO_API_KEY` environment variable in your shell (e.g., `export PLATO_API_KEY='your_key'`) or pass `api_key="your_api_key_string"` directly to `Plato(api_key=...)`.

• ERROR: Package 'plato-sdk' requires a different Python version: 3.9.x is not in '>=3.10'

  cause The current Python interpreter version is older than 3.10, which is a minimum requirement for `plato-sdk`.
  fix Upgrade your Python environment to 3.10 or newer. You can use tools like `pyenv` or create a new virtual environment with a compatible Python version.

• AttributeError: module 'pydantic' has no attribute 'BaseModel'

  cause This typically occurs when Pydantic v1 is installed in the environment, but `plato-sdk` expects Pydantic v2 or newer. The `BaseModel` structure and import paths changed between major versions.
  fix Create a clean virtual environment and install `plato-sdk` to ensure Pydantic v2 is installed without conflicts. If other libraries require Pydantic v1, you may need to isolate environments or adjust those dependencies.

Warnings

• gotcha API key missing or incorrectly configured. The SDK relies on `PLATO_API_KEY` environment variable or direct `api_key` parameter.
  Fix: Ensure the `PLATO_API_KEY` environment variable is set to your valid Plato API key, or pass `api_key='your_key_here'` directly when initializing `Plato()`.
• gotcha API calls can fail due to network issues, rate limits, or Plato API server errors. Implement robust error handling.
  Fix: Wrap API calls in `try...except` blocks to catch network exceptions and API-specific errors. Consider implementing retry logic with exponential backoff for transient issues.
• gotcha Conflicts with other libraries requiring different Pydantic versions (e.g., Pydantic v1 vs v2). `plato-sdk` requires Pydantic 2.x.
  Fix: Ensure your project environment is isolated (e.g., with virtual environments) and other dependencies are compatible with Pydantic 2.x. If conflicts arise, you may need to adjust other library versions or isolate environments.
• breaking `plato-sdk` requires Python 3.10 or newer. Installing with older Python versions will fail.
  Fix: Upgrade your Python interpreter to 3.10 or later. Use tools like `pyenv` or `conda` to manage Python versions effectively.

Install

• pip install plato-sdk Install stable version

Imports

• Plato

  from plato_sdk import Plato

Quickstart

This quickstart initializes the Plato client using an API key retrieved from environment variables. It then attempts to fetch a list of available models from the Plato API, demonstrating a basic interaction. Error handling is included for common issues like missing API keys or network problems.

import os
from plato_sdk import Plato

# Initialize the Plato client with your API key
# Ensure PLATO_API_KEY is set in your environment or pass it directly.
api_key = os.environ.get("PLATO_API_KEY", "")
if not api_key:
    print("Warning: PLATO_API_KEY environment variable not set. API calls may fail.")
    # In a real app, you might raise an error here.
    # For this example, we'll continue with an empty key if not set.

plato = Plato(api_key=api_key)

# Example: Fetch a list of available models
try:
    # This call requires a valid API key and network connectivity
    models = plato.models.list()
    print("Available models:")
    for model in models:
        print(f"- {model.name} (ID: {model.model_id})")
except Exception as e:
    print(f"Error fetching models: {e}")
    print("Please check your API key and network connection.")