python-sdk/api.md

Hanzo

Types:

from hanzoai.types import GetHomeResponse

Methods:

• client.get_home() -> object

Models

Types:

from hanzoai.types import ModelListResponse

Methods:

• client.models.list(**params) -> object

OpenAI

Types:

from hanzoai.types import (
    OpenAICreateResponse,
    OpenAIRetrieveResponse,
    OpenAIUpdateResponse,
    OpenAIDeleteResponse,
    OpenAIPatchResponse,
)

Methods:

• client.openai.create(endpoint) -> object
• client.openai.retrieve(endpoint) -> object
• client.openai.update(endpoint) -> object
• client.openai.delete(endpoint) -> object
• client.openai.patch(endpoint) -> object

Deployments

Types:

from hanzoai.types.openai import DeploymentCompleteResponse, DeploymentEmbedResponse

Methods:

• client.openai.deployments.complete(model) -> object
• client.openai.deployments.embed(model) -> object

Chat

Types:

from hanzoai.types.openai.deployments import ChatCompleteResponse

Methods:

• client.openai.deployments.chat.complete(model) -> object

Engines

Types:

from hanzoai.types import EngineCompleteResponse, EngineEmbedResponse

Methods:

• client.engines.complete(model) -> object
• client.engines.embed(model) -> object

Chat

Types:

from hanzoai.types.engines import ChatCompleteResponse

Methods:

• client.engines.chat.complete(model) -> object

Chat

Completions

Types:

from hanzoai.types.chat import CompletionCreateResponse

Methods:

• client.chat.completions.create(**params) -> object

Completions

Types:

from hanzoai.types import CompletionCreateResponse

Methods:

• client.completions.create(**params) -> object

Embeddings

Types:

from hanzoai.types import EmbeddingCreateResponse

Methods:

• client.embeddings.create(**params) -> object

Images

Generations

Types:

from hanzoai.types.images import GenerationCreateResponse

Methods:

• client.images.generations.create() -> object

Audio

Speech

Types:

from hanzoai.types.audio import SpeechCreateResponse

Methods:

• client.audio.speech.create() -> object

Transcriptions

Types:

from hanzoai.types.audio import TranscriptionCreateResponse

Methods:

• client.audio.transcriptions.create(**params) -> object

Assistants

Types:

from hanzoai.types import AssistantCreateResponse, AssistantListResponse, AssistantDeleteResponse

Methods:

• client.assistants.create() -> object
• client.assistants.list() -> object
• client.assistants.delete(assistant_id) -> object

Threads

Types:

from hanzoai.types import ThreadCreateResponse, ThreadRetrieveResponse

Methods:

• client.threads.create() -> object
• client.threads.retrieve(thread_id) -> object

Messages

Types:

from hanzoai.types.threads import MessageCreateResponse, MessageListResponse

Methods:

• client.threads.messages.create(thread_id) -> object
• client.threads.messages.list(thread_id) -> object

Runs

Types:

from hanzoai.types.threads import RunCreateResponse

Methods:

• client.threads.runs.create(thread_id) -> object

Moderations

Types:

from hanzoai.types import ModerationCreateResponse

Methods:

• client.moderations.create() -> object

Utils

Types:

from hanzoai.types import (
    UtilGetSupportedOpenAIParamsResponse,
    UtilTokenCounterResponse,
    UtilTransformRequestResponse,
)

Methods:

• client.utils.get_supported_openai_params(**params) -> object
• client.utils.token_counter(**params) -> UtilTokenCounterResponse
• client.utils.transform_request(**params) -> UtilTransformRequestResponse

Model

Types:

from hanzoai.types import (
    ConfigurableClientsideParamsCustomAuth,
    ModelInfo,
    ModelCreateResponse,
    ModelDeleteResponse,
)

Methods:

• client.model.create(**params) -> object
• client.model.delete(**params) -> object

Info

Types:

from hanzoai.types.model import InfoListResponse

Methods:

• client.model.info.list(**params) -> object

Update

Types:

from hanzoai.types.model import UpdateDeployment, UpdateFullResponse, UpdatePartialResponse

Methods:

• client.model.update.full(**params) -> object
• client.model.update.partial(model_id, **params) -> object

ModelGroup

Types:

from hanzoai.types import ModelGroupRetrieveInfoResponse

Methods:

• client.model_group.retrieve_info(**params) -> object

Routes

Types:

from hanzoai.types import RouteListResponse

Methods:

• client.routes.list() -> object

Responses

Types:

from hanzoai.types import ResponseCreateResponse, ResponseRetrieveResponse, ResponseDeleteResponse

Methods:

• client.responses.create() -> object
• client.responses.retrieve(response_id) -> object
• client.responses.delete(response_id) -> object

InputItems

Types:

from hanzoai.types.responses import InputItemListResponse

Methods:

• client.responses.input_items.list(response_id) -> object

Batches

Types:

from hanzoai.types import (
    BatchCreateResponse,
    BatchRetrieveResponse,
    BatchListResponse,
    BatchCancelWithProviderResponse,
    BatchCreateWithProviderResponse,
    BatchListWithProviderResponse,
    BatchRetrieveWithProviderResponse,
)

Methods:

• client.batches.create(**params) -> object
• client.batches.retrieve(batch_id, **params) -> object
• client.batches.list(**params) -> object
• client.batches.cancel_with_provider(batch_id, *, provider) -> object
• client.batches.create_with_provider(provider) -> object
• client.batches.list_with_provider(provider, **params) -> object
• client.batches.retrieve_with_provider(batch_id, *, provider) -> object

Cancel

Types:

from hanzoai.types.batches import CancelCancelResponse

Methods:

• client.batches.cancel.cancel(batch_id, **params) -> object

Rerank

Types:

from hanzoai.types import RerankCreateResponse, RerankCreateV1Response, RerankCreateV2Response

Methods:

• client.rerank.create() -> object
• client.rerank.create_v1() -> object
• client.rerank.create_v2() -> object

FineTuning

Jobs

Types:

from hanzoai.types.fine_tuning import (
    HanzoFineTuningJobCreate,
    JobCreateResponse,
    JobRetrieveResponse,
    JobListResponse,
)

Methods:

• client.fine_tuning.jobs.create(**params) -> object
• client.fine_tuning.jobs.retrieve(fine_tuning_job_id, **params) -> object
• client.fine_tuning.jobs.list(**params) -> object

Cancel

Types:

from hanzoai.types.fine_tuning.jobs import CancelCreateResponse

Methods:

• client.fine_tuning.jobs.cancel.create(fine_tuning_job_id) -> object

Credentials

Types:

from hanzoai.types import (
    CredentialItem,
    CredentialCreateResponse,
    CredentialRetrieveResponse,
    CredentialUpdateResponse,
    CredentialListResponse,
    CredentialDeleteResponse,
)

Methods:

• client.credentials.create(**params) -> object
• client.credentials.retrieve(credential_name) -> object
• client.credentials.update(path_credential_name, **params) -> object
• client.credentials.list() -> object
• client.credentials.delete(credential_name) -> object

VertexAI

Types:

from hanzoai.types import (
    VertexAICreateResponse,
    VertexAIRetrieveResponse,
    VertexAIUpdateResponse,
    VertexAIDeleteResponse,
    VertexAIPatchResponse,
)

Methods:

• client.vertex_ai.create(endpoint) -> object
• client.vertex_ai.retrieve(endpoint) -> object
• client.vertex_ai.update(endpoint) -> object
• client.vertex_ai.delete(endpoint) -> object
• client.vertex_ai.patch(endpoint) -> object

Gemini

Types:

from hanzoai.types import (
    GeminiCreateResponse,
    GeminiRetrieveResponse,
    GeminiUpdateResponse,
    GeminiDeleteResponse,
    GeminiPatchResponse,
)

Methods:

• client.gemini.create(endpoint) -> object
• client.gemini.retrieve(endpoint) -> object
• client.gemini.update(endpoint) -> object
• client.gemini.delete(endpoint) -> object
• client.gemini.patch(endpoint) -> object

Cohere

Types:

from hanzoai.types import (
    CohereCreateResponse,
    CohereRetrieveResponse,
    CohereUpdateResponse,
    CohereDeleteResponse,
    CohereModifyResponse,
)

Methods:

• client.cohere.create(endpoint) -> object
• client.cohere.retrieve(endpoint) -> object
• client.cohere.update(endpoint) -> object
• client.cohere.delete(endpoint) -> object
• client.cohere.modify(endpoint) -> object

Anthropic

Types:

from hanzoai.types import (
    AnthropicCreateResponse,
    AnthropicRetrieveResponse,
    AnthropicUpdateResponse,
    AnthropicDeleteResponse,
    AnthropicModifyResponse,
)

Methods:

• client.anthropic.create(endpoint) -> object
• client.anthropic.retrieve(endpoint) -> object
• client.anthropic.update(endpoint) -> object
• client.anthropic.delete(endpoint) -> object
• client.anthropic.modify(endpoint) -> object

Bedrock

Types:

from hanzoai.types import (
    BedrockCreateResponse,
    BedrockRetrieveResponse,
    BedrockUpdateResponse,
    BedrockDeleteResponse,
    BedrockPatchResponse,
)

Methods:

• client.bedrock.create(endpoint) -> object
• client.bedrock.retrieve(endpoint) -> object
• client.bedrock.update(endpoint) -> object
• client.bedrock.delete(endpoint) -> object
• client.bedrock.patch(endpoint) -> object

EuAssemblyai

Types:

from hanzoai.types import (
    EuAssemblyaiCreateResponse,
    EuAssemblyaiRetrieveResponse,
    EuAssemblyaiUpdateResponse,
    EuAssemblyaiDeleteResponse,
    EuAssemblyaiPatchResponse,
)

Methods:

• client.eu_assemblyai.create(endpoint) -> object
• client.eu_assemblyai.retrieve(endpoint) -> object
• client.eu_assemblyai.update(endpoint) -> object
• client.eu_assemblyai.delete(endpoint) -> object
• client.eu_assemblyai.patch(endpoint) -> object

Assemblyai

Types:

from hanzoai.types import (
    AssemblyaiCreateResponse,
    AssemblyaiRetrieveResponse,
    AssemblyaiUpdateResponse,
    AssemblyaiDeleteResponse,
    AssemblyaiPatchResponse,
)

Methods:

• client.assemblyai.create(endpoint) -> object
• client.assemblyai.retrieve(endpoint) -> object
• client.assemblyai.update(endpoint) -> object
• client.assemblyai.delete(endpoint) -> object
• client.assemblyai.patch(endpoint) -> object

Azure

Types:

from hanzoai.types import (
    AzureCreateResponse,
    AzureUpdateResponse,
    AzureDeleteResponse,
    AzureCallResponse,
    AzurePatchResponse,
)

Methods:

• client.azure.create(endpoint) -> object
• client.azure.update(endpoint) -> object
• client.azure.delete(endpoint) -> object
• client.azure.call(endpoint) -> object
• client.azure.patch(endpoint) -> object

Langfuse

Types:

from hanzoai.types import (
    LangfuseCreateResponse,
    LangfuseRetrieveResponse,
    LangfuseUpdateResponse,
    LangfuseDeleteResponse,
    LangfusePatchResponse,
)

Methods:

• client.langfuse.create(endpoint) -> object
• client.langfuse.retrieve(endpoint) -> object
• client.langfuse.update(endpoint) -> object
• client.langfuse.delete(endpoint) -> object
• client.langfuse.patch(endpoint) -> object

Config

PassThroughEndpoint

Types:

from hanzoai.types.config import (
    PassThroughEndpointResponse,
    PassThroughGenericEndpoint,
    PassThroughEndpointCreateResponse,
    PassThroughEndpointUpdateResponse,
)

Methods:

• client.config.pass_through_endpoint.create(**params) -> object
• client.config.pass_through_endpoint.update(endpoint_id) -> object
• client.config.pass_through_endpoint.list(**params) -> PassThroughEndpointResponse
• client.config.pass_through_endpoint.delete(**params) -> PassThroughEndpointResponse

Test

Types:

from hanzoai.types import TestPingResponse

Methods:

• client.test.ping() -> object

Health

Types:

from hanzoai.types import (
    HealthCheckAllResponse,
    HealthCheckLivelinessResponse,
    HealthCheckLivenessResponse,
    HealthCheckReadinessResponse,
    HealthCheckServicesResponse,
)

Methods:

• client.health.check_all(**params) -> object
• client.health.check_liveliness() -> object
• client.health.check_liveness() -> object
• client.health.check_readiness() -> object
• client.health.check_services(**params) -> object

Active

Types:

from hanzoai.types import ActiveListCallbacksResponse

Methods:

• client.active.list_callbacks() -> object

Settings

Types:

from hanzoai.types import SettingRetrieveResponse

Methods:

• client.settings.retrieve() -> object

Key

Types:

from hanzoai.types import (
    BlockKeyRequest,
    GenerateKeyResponse,
    KeyUpdateResponse,
    KeyListResponse,
    KeyDeleteResponse,
    KeyBlockResponse,
    KeyCheckHealthResponse,
    KeyRetrieveInfoResponse,
    KeyUnblockResponse,
)

Methods:

• client.key.update(**params) -> object
• client.key.list(**params) -> KeyListResponse
• client.key.delete(**params) -> object
• client.key.block(**params) -> Optional[KeyBlockResponse]
• client.key.check_health() -> KeyCheckHealthResponse
• client.key.generate(**params) -> GenerateKeyResponse
• client.key.regenerate_by_key(path_key, **params) -> Optional[GenerateKeyResponse]
• client.key.retrieve_info(**params) -> object
• client.key.unblock(**params) -> object

Regenerate

Types:

from hanzoai.types.key import RegenerateKeyRequest

User

Types:

from hanzoai.types import (
    UserCreateResponse,
    UserUpdateResponse,
    UserListResponse,
    UserDeleteResponse,
    UserRetrieveInfoResponse,
)

Methods:

• client.user.create(**params) -> UserCreateResponse
• client.user.update(**params) -> object
• client.user.list(**params) -> object
• client.user.delete(**params) -> object
• client.user.retrieve_info(**params) -> object

Team

Types:

from hanzoai.types import (
    BlockTeamRequest,
    HanzoModelTable,
    HanzoTeamTable,
    HanzoUserTable,
    Member,
    TeamUpdateResponse,
    TeamListResponse,
    TeamDeleteResponse,
    TeamAddMemberResponse,
    TeamBlockResponse,
    TeamDisableLoggingResponse,
    TeamListAvailableResponse,
    TeamRemoveMemberResponse,
    TeamRetrieveInfoResponse,
    TeamUnblockResponse,
    TeamUpdateMemberResponse,
)

Methods:

• client.team.create(**params) -> HanzoTeamTable
• client.team.update(**params) -> object
• client.team.list(**params) -> object
• client.team.delete(**params) -> object
• client.team.add_member(**params) -> TeamAddMemberResponse
• client.team.block(**params) -> object
• client.team.disable_logging(team_id) -> object
• client.team.list_available(**params) -> object
• client.team.remove_member(**params) -> object
• client.team.retrieve_info(**params) -> object
• client.team.unblock(**params) -> object
• client.team.update_member(**params) -> TeamUpdateMemberResponse

Model

Types:

from hanzoai.types.team import ModelAddResponse, ModelRemoveResponse

Methods:

• client.team.model.add(**params) -> object
• client.team.model.remove(**params) -> object

Callback

Types:

from hanzoai.types.team import CallbackRetrieveResponse, CallbackAddResponse

Methods:

• client.team.callback.retrieve(team_id) -> object
• client.team.callback.add(team_id, **params) -> object

Organization

Types:

from hanzoai.types import (
    BudgetTable,
    OrgMember,
    OrganizationMembershipTable,
    OrganizationTableWithMembers,
    UserRoles,
    OrganizationCreateResponse,
    OrganizationListResponse,
    OrganizationDeleteResponse,
    OrganizationAddMemberResponse,
    OrganizationDeleteMemberResponse,
)

Methods:

• client.organization.create(**params) -> OrganizationCreateResponse
• client.organization.update(**params) -> OrganizationTableWithMembers
• client.organization.list() -> OrganizationListResponse
• client.organization.delete(**params) -> OrganizationDeleteResponse
• client.organization.add_member(**params) -> OrganizationAddMemberResponse
• client.organization.delete_member(**params) -> object
• client.organization.update_member(**params) -> OrganizationMembershipTable

Info

Types:

from hanzoai.types.organization import InfoDeprecatedResponse

Methods:

• client.organization.info.retrieve(**params) -> OrganizationTableWithMembers
• client.organization.info.deprecated(**params) -> object

Customer

Types:

from hanzoai.types import (
    BlockUsers,
    HanzoEndUserTable,
    CustomerCreateResponse,
    CustomerUpdateResponse,
    CustomerListResponse,
    CustomerDeleteResponse,
    CustomerBlockResponse,
    CustomerUnblockResponse,
)

Methods:

• client.customer.create(**params) -> object
• client.customer.update(**params) -> object
• client.customer.list() -> CustomerListResponse
• client.customer.delete(**params) -> object
• client.customer.block(**params) -> object
• client.customer.retrieve_info(**params) -> HanzoEndUserTable
• client.customer.unblock(**params) -> object

Spend

Types:

from hanzoai.types import (
    HanzoSpendLogs,
    SpendCalculateSpendResponse,
    SpendListLogsResponse,
    SpendListTagsResponse,
)

Methods:

• client.spend.calculate_spend(**params) -> object
• client.spend.list_logs(**params) -> SpendListLogsResponse
• client.spend.list_tags(**params) -> SpendListTagsResponse

Global

Spend

Types:

from hanzoai.types.global_ import (
    SpendListTagsResponse,
    SpendResetResponse,
    SpendRetrieveReportResponse,
)

Methods:

• client.global*.spend.list*tags(**params) -> SpendListTagsResponse
• client.global*.spend.reset() -> object
• client.global*.spend.retrieve*report(**params) -> SpendRetrieveReportResponse

Provider

Types:

from hanzoai.types import ProviderListBudgetsResponse

Methods:

• client.provider.list_budgets() -> ProviderListBudgetsResponse

Cache

Types:

from hanzoai.types import CacheDeleteResponse, CacheFlushAllResponse, CachePingResponse

Methods:

• client.cache.delete() -> object
• client.cache.flush_all() -> object
• client.cache.ping() -> CachePingResponse

Redis

Types:

from hanzoai.types.cache import RediRetrieveInfoResponse

Methods:

• client.cache.redis.retrieve_info() -> object

Guardrails

Types:

from hanzoai.types import GuardrailListResponse

Methods:

• client.guardrails.list() -> GuardrailListResponse

Add

Types:

from hanzoai.types import IPAddress, AddAddAllowedIPResponse

Methods:

• client.add.add_allowed_ip(**params) -> object

Delete

Types:

from hanzoai.types import DeleteCreateAllowedIPResponse

Methods:

• client.delete.create_allowed_ip(**params) -> object

Files

Types:

from hanzoai.types import (
    FileCreateResponse,
    FileRetrieveResponse,
    FileListResponse,
    FileDeleteResponse,
)

Methods:

• client.files.create(provider, **params) -> object
• client.files.retrieve(file_id, *, provider) -> object
• client.files.list(provider, **params) -> object
• client.files.delete(file_id, *, provider) -> object

Content

Types:

from hanzoai.types.files import ContentRetrieveResponse

Methods:

• client.files.content.retrieve(file_id, *, provider) -> object

Budget

Types:

from hanzoai.types import (
    BudgetNew,
    BudgetCreateResponse,
    BudgetUpdateResponse,
    BudgetListResponse,
    BudgetDeleteResponse,
    BudgetInfoResponse,
    BudgetSettingsResponse,
)

Methods:

• client.budget.create(**params) -> object
• client.budget.update(**params) -> object
• client.budget.list() -> object
• client.budget.delete(**params) -> object
• client.budget.info(**params) -> object
• client.budget.settings(**params) -> object