guardrails_ai.sdk.guardrails_ai_client

Classes

GuardrailsAI

Main Guardrails AI SDK client with namespaced API access.

Module Contents

class guardrails_ai.sdk.guardrails_ai_client.GuardrailsAI(*, api_key: str, base_url: str = 'http://localhost:8000', timeout: float | None = None, max_retries: int = 5, headers: Mapping[str, str] | None = None, http_client: httpx.AsyncClient | None = None)

Bases: guardrails_ai.sdk.abstract_client.Client

Main Guardrails AI SDK client with namespaced API access.

Example:

client = GuardrailsAI(api_key="your-api-key")
guard = await client.guards.retrieve(name="my-guard")
result = await client.guards.validate("my-guard", "some text")

Initialize the Guardrails AI client.

Parameters:

  • api_key – Guardrails AI API key for authentication.

  • base_url – Base URL for the Guardrails API. Defaults to http://localhost:8000.

  • timeout – HTTP request timeout in seconds. Defaults to None (no timeout).

  • max_retries – Maximum number of retry attempts for failed requests. Defaults to 5.

  • headers – Additional HTTP headers to include with every request.

  • http_client – A pre-configured httpx.AsyncClient to use instead of the default. If provided, the required auth headers will be merged into its headers.

guards: guardrails_ai.sdk.guards_api.GuardsApi
headers: dict[str, str]
http_client: httpx.AsyncClient
max_retries: int