python-sdk/api.md

Hanzo

Methods:

• client.get_home() -> object

Models

Methods:

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

OpenAI

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

Methods:

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

Chat

Methods:

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

Engines

Methods:

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

Chat

Methods:

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

Chat

Completions

Methods:

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

Completions

Methods:

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

Embeddings

Methods:

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

Images

Generations

Methods:

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

Audio

Speech

Methods:

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

Transcriptions

Methods:

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

Assistants

Methods:

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

Threads

Methods:

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

Messages

Methods:

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

Runs

Methods:

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

Moderations

Methods:

• client.moderations.create() -> object

Utils

Types:

from hanzoai.types import 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

Methods:

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

Info

Methods:

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

Update

Types:

from hanzoai.types.model import UpdateDeployment

Methods:

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

ModelGroup

Methods:

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

Routes

Methods:

• client.routes.list() -> object

Responses

Methods:

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

InputItems

Methods:

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

Batches

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

Methods:

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

Rerank

Methods:

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

FineTuning

Jobs

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

Methods:

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

Credentials

Types:

from hanzoai.types import CredentialItem

Methods:

• client.credentials.create(**params) -> object
• client.credentials.list() -> object
• client.credentials.delete(credential_name) -> object

VertexAI

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

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

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

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

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

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

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

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

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

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

Methods:

• client.test.ping() -> object

Health

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

Methods:

• client.active.list_callbacks() -> object

Settings

Methods:

• client.settings.retrieve() -> object

Key

Types:

from hanzoai.types import (
    BlockKeyRequest,
    GenerateKeyResponse,
    KeyListResponse,
    KeyBlockResponse,
    KeyCheckHealthResponse,
)

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

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,
    Member,
    TeamCreateResponse,
    TeamAddMemberResponse,
    TeamUpdateMemberResponse,
)

Methods:

• client.team.create(**params) -> TeamCreateResponse
• 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

Methods:

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

Callback

Methods:

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

Organization

Types:

from hanzoai.types import (
    OrgMember,
    OrganizationCreateResponse,
    OrganizationUpdateResponse,
    OrganizationListResponse,
    OrganizationDeleteResponse,
    OrganizationAddMemberResponse,
    OrganizationUpdateMemberResponse,
)

Methods:

• client.organization.create(**params) -> OrganizationCreateResponse
• client.organization.update(**params) -> OrganizationUpdateResponse
• 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) -> OrganizationUpdateMemberResponse

Info

Types:

from hanzoai.types.organization import InfoRetrieveResponse

Methods:

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

Customer

Types:

from hanzoai.types import BlockUsers, CustomerListResponse, CustomerRetrieveInfoResponse

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) -> CustomerRetrieveInfoResponse
• client.customer.unblock(**params) -> object

Spend

Types:

from hanzoai.types import 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, 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 CachePingResponse

Methods:

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

Redis

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

Methods:

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

Delete

Methods:

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

Files

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

Methods:

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

Budget

Types:

from hanzoai.types import BudgetNew

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