agentle.agents.apisΒΆ

Functions

endpoints_to_tools(endpoints[, base_url, ...])

Convert a list of endpoints and APIs to tools.

Classes

API()

Enhanced API collection with comprehensive features.

APIMetrics(*[, total_requests, ...])

Metrics for API usage.

ApiKeyAuthentication(api_key[, location, ...])

API Key authentication.

ApiKeyLocation(*values)

Where to place API key.

ArraySchema(*[, type, min_items, max_items, ...])

Schema definition for array parameters.

AuthType(*values)

Types of authentication supported.

AuthenticationBase()

Base class for authentication handlers.

AuthenticationConfig(*[, type, ...])

Configuration for API authentication.

BasicAuthentication(username, password)

HTTP Basic authentication.

BearerAuthentication(token[, auto_refresh])

Bearer token authentication.

CacheStrategy(*values)

Cache strategies.

CircuitBreaker(config)

Circuit breaker implementation for resilient API calls.

Endpoint()

Enhanced HTTP API endpoint with comprehensive features.

EndpointParameter(*, name, description[, ...])

Represents a parameter for an API endpoint with proper object support.

FileUpload(*, filename, content[, mime_type])

Represents a file to be uploaded.

HMACAuthentication(secret_key[, algorithm, ...])

HMAC signature authentication.

HTTPMethod(*values)

HTTP methods supported by endpoints.

NoAuthentication()

No authentication.

OAuth2Authentication(token_url, client_id, ...)

OAuth2 authentication with token refresh.

OAuth2GrantType(*values)

OAuth2 grant types.

ObjectSchema(*[, type, properties, ...])

Schema definition for object parameters.

ObjectSerializationStyle(*values)

Different ways to serialize objects for different parameter locations.

ParameterLocation(*values)

Where to place parameters in the HTTP request.

PrimitiveSchema(*, type[, format, enum, ...])

Schema definition for primitive parameters.

RateLimiter(config)

Rate limiter for API calls.

RequestConfig(*[, timeout, connect_timeout, ...])

Enhanced configuration for HTTP requests.

RequestHook(*, name[, callback])

Hook for request/response interception.

ResponseCache(config)

Simple in-memory response cache.

RetryStrategy(*values)

Retry strategies.

Exceptions

CircuitBreakerError

Raised when circuit breaker is open.

RateLimitError

Raised when rate limit is exceeded.

Modules

api

Complete enhanced API module with comprehensive OpenAPI support.

api_key_authentication

API key authentication.

api_key_location

API key location types.

api_metrics

API metrics tracking.

array_schema

auth_type

Authentication types.

authentication

Authentication support for API endpoints.

authentication_base

Base authentication handler.

authentication_config

Authentication configuration.

basic_authentication

Basic authentication.

bearer_authentication

Bearer token authentication.

cache_strategy

Cache strategies.

circuit_breaker

Circuit breaker for resilient API calls.

circuit_breaker_error

Circuit breaker errors.

circuit_breaker_state

Circuit breaker states.

endpoint

Complete enhanced API endpoint integration for Agentle framework.

endpoint_parameter

file_upload

File upload support for endpoints.

hmac_authentication

HMAC signature authentication.

http_method

no_authentication

No authentication handler.

oauth2_authentication

OAuth2 authentication.

oauth2_grant_type

OAuth2 grant types.

object_schema

Clean replacement for the existing endpoint parameter implementation.

object_serialization_style

parameter_location

params

primitive_schema

rate_limit_error

Rate limit errors.

rate_limiter

Rate limiter for API calls.

request_config

Enhanced request configuration with advanced features.

request_hook

Request hooks for endpoints.

response_cache

Simple in-memory response cache.

retry_strategy

Retry strategies.