ApiClient

class baseten.client.managementapi.ApiClient(http_client, *, base_url=None, auth=None, headers=None, timeout=None)

Bases: object

Generated HTTP client for the Baseten API.

Methods on this client are generated from the OpenAPI specification and are NOT covered by any stability or compatibility guarantees. They may change without notice between versions.

Parameters:

  • http_client (httpx.Client)

  • base_url (str | None)

  • auth (httpx.Auth | None)

  • headers (Mapping[str, str] | None)

  • timeout (httpx.Timeout | None)

cleanup_images(*, params=None)

Clean up unused images

Parameters:

params (CleanupImagesParams | None)

Return type:

CleanupSandboxImagesResponse

create_sandbox(*, params=None, request)

Create a sandbox

Parameters:
Return type:

Sandbox

create_sandbox_preview(*, sandbox_name, params=None, request)

Create a sandbox preview

Parameters:
Return type:

SandboxPreview

create_sandbox_preview_token(*, sandbox_name, preview_name, params=None, request)

Create a preview token

Parameters:
Return type:

SandboxPreviewToken

create_sandbox_volume(*, params=None, request)

Create a volume

Parameters:
Return type:

SandboxVolume

delete_api_keys(*, api_key_prefix)

Deletes an API key by prefix

Parameters:

api_key_prefix (str)

Return type:

APIKeyTombstone

delete_chains(*, chain_id)

Deletes a chain by ID

Parameters:

chain_id (str)

Return type:

ChainTombstone

delete_chains_deployments(*, chain_id, chain_deployment_id)

Deletes a chain deployment by ID

Parameters:

  • chain_id (str)

  • chain_deployment_id (str)

Return type:

ChainDeploymentTombstone

delete_gateway_endpoints(*, endpoint_id)

Deletes a Gateway endpoint

Parameters:

endpoint_id (str)

Return type:

EndpointTombstone

delete_grid_connections(*, connection_id)

Deletes a connection

Parameters:

connection_id (str)

Return type:

GridConnectionTombstone

delete_grid_machine_users(*, machine_user_id)

Deletes a machine user

Parameters:

machine_user_id (str)

Return type:

GridMachineUserTombstone

delete_grid_machine_users_api_keys(*, machine_user_id, api_key_prefix)

Revokes a machine user’s API key

Parameters:

  • machine_user_id (str)

  • api_key_prefix (str)

Return type:

APIKeyTombstone

delete_grid_routes(*, route_id)

Deletes a route

Parameters:

route_id (str)

Return type:

GridRouteTombstone

delete_image(*, image_name, params=None)

Delete a sandbox image

Parameters:
Return type:

SandboxImage

delete_image_tag(*, image_name, tag_name, params=None)

Delete an image tag

Parameters:
Return type:

SandboxImage

delete_library_listings(*, user_defined_listing_id)

Deletes a library listing

Parameters:

user_defined_listing_id (str)

Return type:

LibraryListingTombstone

delete_library_listings_versions(*, user_defined_listing_id, version_tag)

Deletes a library listing version

Parameters:

  • user_defined_listing_id (str)

  • version_tag (str)

Return type:

LibraryListingVersionTombstone

delete_models(*, model_id)

Deletes a model by ID

Parameters:

model_id (str)

Return type:

ModelTombstone

delete_models_deployments(*, model_id, deployment_id)

Deletes a model’s deployment by ID

Parameters:

  • model_id (str)

  • deployment_id (str)

Return type:

DeploymentTombstone

delete_models_deployments_replicas(*, model_id, deployment_id, replica_id)

Terminates a replica in a deployment

Parameters:

  • model_id (str)

  • deployment_id (str)

  • replica_id (str)

Return type:

TerminateReplicaResponse

delete_models_environments(*, model_id, env_name)

Deletes an environment

Parameters:

  • model_id (str)

  • env_name (str)

Return type:

EnvironmentTombstone

delete_sandbox(*, sandbox_name, params=None)

Delete a sandbox

Parameters:
Return type:

Sandbox

delete_sandbox_preview(*, sandbox_name, preview_name, params=None)

Delete a sandbox preview

Parameters:
Return type:

SandboxPreview

delete_sandbox_preview_token(*, sandbox_name, preview_name, token_name, params=None)

Delete a preview token

Parameters:
Return type:

None

delete_sandbox_volume(*, volume_name, params=None)

Delete a volume

Parameters:
Return type:

SandboxVolume

delete_secrets(*, secret_name)

Deletes a secret by name

Parameters:

secret_name (str)

Return type:

SecretTombstone

delete_teams_secrets(*, team_id, secret_name)

Deletes a secret by name

Parameters:

  • team_id (str)

  • secret_name (str)

Return type:

SecretTombstone

delete_training_projects(*, training_project_id)

Deletes a training project

Parameters:

training_project_id (str)

Return type:

TrainingProjectTombstone

delete_training_projects_jobs(*, training_project_id, training_job_id)

Deletes a training job

Parameters:

  • training_project_id (str)

  • training_job_id (str)

Return type:

TrainingJobTombstone

delete_volumes(*, volume_namespace, volume_name, request)

Deletes a volume

Parameters:
Return type:

DeleteVolumeResponse

delete_volumes_tags(*, volume_namespace, volume_name, volume_tag, request)

Deletes a volume tag

Parameters:
Return type:

DeleteVolumeTagResponse

delete_volumes_versions(*, volume_namespace, volume_name, volume_version, request)

Deletes one version of a volume

Parameters:
Return type:

DeleteVolumeVersionResponse

get_api_keys(*, params=None)

Lists API keys (metadata only, no plain text keys)

Parameters:

params (GetApiKeysParams | None)

Return type:

APIKeys

get_audit_logs(*, params=None)

Gets the audit log for the workspace

Parameters:

params (GetAuditLogsParams | None)

Return type:

ListAuditLogsResponse

get_billing_model_apis(*, params=None)

Gets daily Model APIs costs

Parameters:

params (GetBillingModelApisParams | None)

Return type:

ModelApisCostsResponse

get_billing_tool_call_usage(*, params)

Gets server-side tool call usage

Parameters:

params (GetBillingToolCallUsageParams)

Return type:

ToolCallUsageResponse

get_billing_usage_summary(*, params)

Gets billing usage summary for a date range

Parameters:

params (GetBillingUsageSummaryParams)

Return type:

UsageSummary

get_blobs_credentials_model()

Gets blob credentials for models

Return type:

GetBlobCredentialsResponse

get_blobs_credentials_train()

Gets blob credentials for training

Return type:

GetBlobCredentialsResponse

get_chains()

Gets all chains

Return type:

Chains

get_chains_audit_logs(*, chain_id, params=None)

Gets the audit log for a chain

Parameters:
Return type:

ListAuditLogsResponse

get_chains_chain_id(*, chain_id)

Gets a chain by ID

Parameters:

chain_id (str)

Return type:

Chain

get_chains_deployments(*, chain_id)

Gets all chain deployments

Parameters:

chain_id (str)

Return type:

ChainDeployments

get_chains_deployments_chain_deployment_id(*, chain_id, chain_deployment_id)

Gets a chain deployment by ID

Parameters:

  • chain_id (str)

  • chain_deployment_id (str)

Return type:

ChainDeployment

get_chains_deployments_chainlets_logs(*, chain_id, chain_deployment_id, chainlet_id, params=None)

Gets the logs for a chainlet within a chain deployment

Parameters:
Return type:

GetLogsResponse

get_chains_environments(*, chain_id)

Gets all chain environments

Parameters:

chain_id (str)

Return type:

Environments

get_chains_environments_env_name(*, chain_id, env_name)

Gets a chain environment’s details

Parameters:

  • chain_id (str)

  • env_name (str)

Return type:

ChainEnvironment

get_environment_groups()

Lists environment groups

Return type:

EnvironmentGroups

get_environment_groups_env_name(*, env_name)

Gets an environment group by name

Parameters:

env_name (str)

Return type:

EnvironmentGroup

get_explore_metadata(*, params=None)

Lists model metadata

Parameters:

params (GetExploreMetadataParams | None)

Return type:

ExploreMetadataResponse

get_gateway_endpoints()

Lists Gateway endpoints

Return type:

EndpointsResponse

get_gateway_endpoints_endpoint_id(*, endpoint_id)

Gets a Gateway endpoint

Parameters:

endpoint_id (str)

Return type:

Endpoint

get_gateway_events(*, params=None)

Lists gateway events

Parameters:

params (GetGatewayEventsParams | None)

Return type:

GatewayEventsResponse

get_gateway_groups()

Lists groups

Return type:

GroupsResponse

get_gateway_groups_api_keys(*, group_id)

Lists API keys for a group

Parameters:

group_id (str)

Return type:

KeysForGroupResponse

get_gateway_groups_api_keys_api_key_prefix(*, group_id, api_key_prefix)

Gets an API key for a group

Parameters:

  • group_id (str)

  • api_key_prefix (str)

Return type:

GatewayKeyInfo

get_gateway_groups_group_id(*, group_id)

Gets a group

Parameters:

group_id (str)

Return type:

Group

get_grid_classifiers(*, params=None)

Lists classifiers available for intelligent routes

Parameters:

params (GetGridClassifiersParams | None)

Return type:

GridClassifiersResponse

get_grid_classifiers_classifier_id(*, classifier_id)

Gets a classifier available for intelligent routes

Parameters:

classifier_id (str)

Return type:

GridClassifier

get_grid_connections(*, params=None)

Lists connections

Parameters:

params (GetGridConnectionsParams | None)

Return type:

GridConnectionsResponse

get_grid_connections_connection_id(*, connection_id)

Gets a connection

Parameters:

connection_id (str)

Return type:

GridConnection

get_grid_machine_users(*, params=None)

Lists machine users

Parameters:

params (GetGridMachineUsersParams | None)

Return type:

GridMachineUsersResponse

get_grid_machine_users_api_keys(*, machine_user_id)

Lists a machine user’s API keys

Parameters:

machine_user_id (str)

Return type:

APIKeys

get_grid_machine_users_machine_user_id(*, machine_user_id)

Gets a machine user

Parameters:

machine_user_id (str)

Return type:

GridMachineUser

get_grid_route_classifiers(*, params=None)

Lists route classifiers available for intelligent routes

Parameters:

params (GetGridRouteClassifiersParams | None)

Return type:

GridRouteClassifiersResponse

get_grid_route_classifiers_route_classifier_id(*, route_classifier_id)

Gets a route classifier available for intelligent routes

Parameters:

route_classifier_id (str)

Return type:

GridRouteClassifier

get_grid_routes(*, params=None)

Lists routes

Parameters:

params (GetGridRoutesParams | None)

Return type:

GridRoutesResponse

get_grid_routes_route_id(*, route_id)

Gets a route

Parameters:

route_id (str)

Return type:

GridRoute

get_grid_routes_usage(*, params=None)

Gets daily Grid usage and estimated costs

Parameters:

params (GetGridRoutesUsageParams | None)

Return type:

GridRouteUsageResponse

get_grid_team_settings(*, params=None)

Gets a team’s Grid settings by team ID or your only team

Parameters:

params (GetGridTeamSettingsParams | None)

Return type:

GridTeamSettings

get_grid_team_settings_users(*, params=None)

Lists members’ Grid settings

Parameters:

params (GetGridTeamSettingsUsersParams | None)

Return type:

GridTeamUserSettingsList

get_grid_team_settings_users_user_id(*, user_id, params=None)

Gets a user’s Grid settings by team ID or your only team

Parameters:
Return type:

GridTeamUserSettings

get_image(*, image_name, params=None)

Get a sandbox image

Parameters:
Return type:

SandboxImage

get_image_build_logs(*, image_name, params=None)

Get image build logs

Parameters:
Return type:

SandboxImageBuildLogsResponse

get_instance_type_prices()

Gets prices for available instance types

Return type:

InstanceTypePrices

get_instance_types()

Gets all available instance types

Return type:

InstanceTypes

get_library_listings()

Gets all library listings

Return type:

LibraryListings

get_library_listings_user_defined_listing_id(*, user_defined_listing_id)

Gets a library listing

Parameters:

user_defined_listing_id (str)

Return type:

LibraryListing

get_library_listings_versions(*, user_defined_listing_id)

Gets all versions for a library listing

Parameters:

user_defined_listing_id (str)

Return type:

LibraryListingVersions

get_library_listings_versions_version_tag(*, user_defined_listing_id, version_tag)

Gets a library listing version

Parameters:

  • user_defined_listing_id (str)

  • version_tag (str)

Return type:

LibraryListingVersion

get_loops_capabilities(*, params=None)

Gets Loops server capabilities

Parameters:

params (GetLoopsCapabilitiesParams | None)

Return type:

GetLoopsCapabilitiesResponse

get_loops_checkpoints(*, params=None)

Lists Loops checkpoints

Parameters:

params (GetLoopsCheckpointsParams | None)

Return type:

ListLoopsCheckpointsResponse

get_loops_checkpoints_files(*, checkpoint_id, params=None)

Gets Loops checkpoint files

Parameters:
Return type:

LoopsCheckpointFilesResponse

get_loops_checkpoints_source(*, checkpoint_id)

Gets where a Loops checkpoint’s files come from

Parameters:

checkpoint_id (str)

Return type:

LoopsCheckpointSourceResponse

get_loops_deployments(*, params=None)

Lists Loops deployments

Parameters:

params (GetLoopsDeploymentsParams | None)

Return type:

ListLoopsDeploymentsResponse

get_loops_deployments_debug_archive_files(*, deployment_id, params=None)

Gets Loops debug archive files

Parameters:
Return type:

LoopsDebugArchiveFilesResponse

get_loops_deployments_deployment_id(*, deployment_id)

Gets a Loops deployment

Parameters:

deployment_id (str)

Return type:

GetLoopsDeploymentResponse

get_loops_deployments_logs(*, deployment_id, params=None)

Gets logs for a Loops trainer deployment

Parameters:
Return type:

GetLogsResponse

get_loops_runs(*, params=None)

Lists Loops runs

Parameters:

params (GetLoopsRunsParams | None)

Return type:

ListLoopsRunsResponse

get_loops_runs_run_id(*, run_id)

Gets a Loops run

Parameters:

run_id (str)

Return type:

GetLoopsRunResponse

get_loops_samplers(*, params=None)

Lists Loops samplers

Parameters:

params (GetLoopsSamplersParams | None)

Return type:

ListLoopsSamplersResponse

get_loops_samplers_sampler_id(*, sampler_id)

Gets a Loops sampler

Parameters:

sampler_id (str)

Return type:

GetLoopsSamplerResponse

get_loops_sessions(*, session_id)

Gets a Loops session

Parameters:

session_id (str)

Return type:

GetLoopsSessionResponse

get_loops_user_config()

Gets the caller’s Loops user config

Return type:

GetLoopsUserConfigResponse

get_model_apis(*, params=None)

Lists Model APIs

Parameters:

params (GetModelApisParams | None)

Return type:

ModelAPIsResponse

get_model_apis_metrics(*, model_api_name, params=None)

Gets the metrics for a Model API

Parameters:
Return type:

GetMetricsResponse

get_model_apis_model_api_name(*, model_api_name, params=None)

Gets a Model API

Parameters:
Return type:

ModelAPI

get_model_apis_usage(*, params=None)

Gets Model APIs token usage in time buckets

Parameters:

params (GetModelApisUsageParams | None)

Return type:

ModelApisUsageResponse

get_models(*, params=None)

Gets all models

Parameters:

params (GetModelsParams | None)

Return type:

Models

get_models_audit_logs(*, model_id, params=None)

Gets the audit log for a model

Parameters:
Return type:

ListAuditLogsResponse

get_models_deployments(*, model_id, params=None)

Gets all deployments of a model

Parameters:
Return type:

Deployments

get_models_deployments_config(*, model_id, deployment_id, params=None)

Gets a deployment’s config

Parameters:
Return type:

DeploymentConfigResponse

get_models_deployments_deployment_id(*, model_id, deployment_id)

Gets a model’s deployment by ID

Parameters:

  • model_id (str)

  • deployment_id (str)

Return type:

Deployment

get_models_deployments_development(*, model_id)

Gets a model’s development deployment

Parameters:

model_id (str)

Return type:

Deployment

get_models_deployments_download(*, model_id, deployment_id)

Gets a presigned download URL for a deployment’s truss

Parameters:

  • model_id (str)

  • deployment_id (str)

Return type:

DownloadDeploymentResponse

get_models_deployments_logs(*, model_id, deployment_id, params=None)

Gets the logs for a model deployment

Parameters:
Return type:

GetLogsResponse

get_models_deployments_metrics(*, model_id, deployment_id, params=None)

Gets the metrics for a model deployment

Parameters:
Return type:

GetMetricsResponse

get_models_deployments_patches_state(*, model_id, deployment_id)

Gets a development deployment’s patch state

Parameters:

  • model_id (str)

  • deployment_id (str)

Return type:

GetDeploymentPatchesStateResponse

get_models_deployments_production(*, model_id)

Gets a model’s production deployment

Parameters:

model_id (str)

Return type:

Deployment

get_models_deployments_startups(*, model_id, deployment_id, params)

Lists the startups of a model deployment

Parameters:
Return type:

StartupAttempts

get_models_deployments_startups_summary(*, model_id, deployment_id, params)

Gets the startup summary for a model deployment

Parameters:
Return type:

StartupSummary

get_models_environments(*, model_id)

Gets all environments

Parameters:

model_id (str)

Return type:

Environments

get_models_environments_env_name(*, model_id, env_name)

Gets an environment’s details

Parameters:

  • model_id (str)

  • env_name (str)

Return type:

Environment

get_models_environments_logs(*, model_id, env_name, params=None)

Gets the logs for a model environment

Parameters:
Return type:

GetLogsResponse

get_models_environments_metrics(*, model_id, env_name, params=None)

Gets the metrics for a model environment.

Parameters:
Return type:

GetMetricsResponse

get_models_environments_startups(*, model_id, env_name, params)

Lists the startups of a model environment

Parameters:
Return type:

StartupAttempts

get_models_environments_startups_summary(*, model_id, env_name, params)

Gets the startup summary for a model environment

Parameters:
Return type:

StartupSummary

get_models_model_id(*, model_id)

Gets a model by ID

Parameters:

model_id (str)

Return type:

Model

get_organizations_me()

Gets the authenticated organization

Return type:

OrganizationInfo

get_regions()

Lists regions available to the organization

Return type:

Regions

get_sandbox(*, sandbox_name, params=None)

Get a sandbox

Parameters:
Return type:

Sandbox

get_sandbox_configuration()

Get sandbox configuration

Return type:

GetSandboxConfigurationResponse

get_sandbox_logs(*, sandbox_name, params)

Get sandbox logs

Parameters:
Return type:

SandboxLogs

get_sandbox_metrics(*, sandbox_name, params=None)

Get sandbox metrics

Parameters:
Return type:

SandboxMetrics

get_sandbox_preview(*, sandbox_name, preview_name, params=None)

Get a sandbox preview

Parameters:
Return type:

SandboxPreview

get_sandbox_volume(*, volume_name, params=None)

Get a volume

Parameters:
Return type:

SandboxVolume

get_secrets()

Gets all secrets (metadata only, no plain text keys)

Return type:

Secrets

get_teams(*, params=None)

Lists all teams

Parameters:

params (GetTeamsParams | None)

Return type:

Teams

get_teams_environment_groups(*, team_id)

Lists environment groups

Parameters:

team_id (str)

Return type:

EnvironmentGroups

get_teams_environment_groups_env_name(*, team_id, env_name)

Gets an environment group by name

Parameters:

  • team_id (str)

  • env_name (str)

Return type:

EnvironmentGroup

get_teams_loops_runs(*, team_id, params=None)

Lists a team’s Loops runs

Parameters:
Return type:

ListLoopsRunsResponse

get_teams_loops_samplers(*, team_id, params=None)

Lists a team’s Loops samplers

Parameters:
Return type:

ListLoopsSamplersResponse

get_teams_models(*, team_id, params=None)

Gets all models

Parameters:
Return type:

Models

get_teams_regions(*, team_id)

Lists regions available to a team

Parameters:

team_id (str)

Return type:

Regions

get_teams_secrets(*, team_id)

Gets all secrets for a team (metadata only, no plain text keys)

Parameters:

team_id (str)

Return type:

Secrets

get_teams_team_id(*, team_id)

Gets a team by ID

Parameters:

team_id (str)

Return type:

Team

get_training_capacity()

Gets training GPU capacity

Return type:

GetTrainingGpuCapacityResponse

get_training_jobs_queue_context(*, training_job_id)

Reconstructs queue context for a training job

Parameters:

training_job_id (str)

Return type:

GetTrainingJobQueueContextResponse

get_training_projects(*, params=None)

Lists training projects

Parameters:

params (GetTrainingProjectsParams | None)

Return type:

ListTrainingProjectsResponse

get_training_projects_cache_summary(*, training_project_id)

Gets training project cache summary

Parameters:

training_project_id (str)

Return type:

GetCacheSummaryResponse

get_training_projects_jobs(*, training_project_id)

Lists training jobs

Parameters:

training_project_id (str)

Return type:

ListTrainingJobsResponse

get_training_projects_jobs_auth_codes(*, training_project_id, training_job_id)

Gets auth codes for a training job

Parameters:

  • training_project_id (str)

  • training_job_id (str)

Return type:

GetAuthCodesResponse

get_training_projects_jobs_checkpoint_files(*, training_project_id, training_job_id, params=None)

Gets training job checkpoint files

Parameters:
Return type:

GetTrainingJobCheckpointFilesResponse

get_training_projects_jobs_checkpoints(*, training_project_id, training_job_id)

Gets training job checkpoints

Parameters:

  • training_project_id (str)

  • training_job_id (str)

Return type:

GetTrainingJobCheckpointsResponse

get_training_projects_jobs_download(*, training_project_id, training_job_id)

Gets presigned URLs for a training job’s artifacts

Parameters:

  • training_project_id (str)

  • training_job_id (str)

Return type:

DownloadTrainingJobResponse

get_training_projects_jobs_logs(*, training_project_id, training_job_id, params=None)

Gets the logs for a training job

Parameters:
Return type:

GetLogsResponse

get_training_projects_jobs_metrics(*, training_project_id, training_job_id, params=None)

Gets the metrics for a training job

Parameters:
Return type:

GetTrainingJobMetricsResponse

get_training_projects_jobs_training_job_id(*, training_project_id, training_job_id)

Gets a training job

Parameters:

  • training_project_id (str)

  • training_job_id (str)

Return type:

GetTrainingJobResponse

get_training_projects_training_project_id(*, training_project_id)

Gets a training project

Parameters:

training_project_id (str)

Return type:

GetTrainingProjectResponse

get_users(*, params=None)

Lists users in the workspace

Parameters:

params (GetUsersParams | None)

Return type:

UsersResponse

get_users_me()

Gets the authenticated user

Return type:

UserInfo

get_users_user_id(*, user_id)

Gets a user by ID

Parameters:

user_id (str)

Return type:

UserInfo

get_volumes(*, params)

Gets the volumes in a namespace

Parameters:

params (GetVolumesParams)

Return type:

ListVolumesResponse

get_volumes_namespaces(*, params=None)

Gets the volume namespaces in your workspace

Parameters:

params (GetVolumesNamespacesParams | None)

Return type:

ListVolumeNamespacesResponse

get_volumes_syncs(*, params=None)

Lists volume syncs

Parameters:

params (GetVolumesSyncsParams | None)

Return type:

VolumeSyncs

get_volumes_syncs_volume_sync_id(*, volume_sync_id)

Gets a volume sync

Parameters:

volume_sync_id (str)

Return type:

VolumeSync

get_volumes_versions(*, volume_namespace, volume_name, params=None)

Gets the versions of a volume

Parameters:
Return type:

ListVolumeVersionsResponse

get_volumes_versions_volume_version(*, volume_namespace, volume_name, volume_version)

Gets one version of a volume

Parameters:

  • volume_namespace (str)

  • volume_name (str)

  • volume_version (str)

Return type:

VolumeVersionDetail

get_volumes_volume_name(*, volume_namespace, volume_name)

Gets a volume

Parameters:

  • volume_namespace (str)

  • volume_name (str)

Return type:

Volume

list_image_tags(*, image_name, params=None)

List image tags

Parameters:
Return type:

ListSandboxImageTagsResponse

list_images(*, params=None)

List sandbox images

Parameters:

params (ListImagesParams | None)

Return type:

ListSandboxImagesResponse

list_sandbox_library_images()

List built-in sandbox images

Return type:

ListSandboxLibraryImagesResponse

list_sandbox_preview_tokens(*, sandbox_name, preview_name, params=None)

List preview tokens

Parameters:
Return type:

ListSandboxPreviewTokensResponse

list_sandbox_previews(*, sandbox_name, params=None)

List sandbox previews

Parameters:
Return type:

ListSandboxPreviewsResponse

list_sandbox_volumes(*, params=None)

List volumes

Parameters:

params (ListSandboxVolumesParams | None)

Return type:

ListSandboxVolumesResponse

list_sandboxes(*, params=None)

List sandboxes

Parameters:

params (ListSandboxesParams | None)

Return type:

ListSandboxesResponse

patch_chains_environments(*, chain_id, env_name, request)

Updates a chain environment’s settings

Parameters:
Return type:

UpdateChainEnvironmentResponse

patch_chains_environments_chainlet_settings_autoscaling_settings(*, chain_id, env_name, request)

Updates a chainlet environment’s autoscaling settings

Parameters:
Return type:

UpdateAutoscalingSettingsResponse

patch_environment_groups(*, env_name, request)

Updates an environment group’s restriction settings

Parameters:
Return type:

EnvironmentGroup

patch_gateway_endpoints(*, endpoint_id, request)

Updates a Gateway endpoint

Parameters:
Return type:

Endpoint

patch_gateway_groups(*, group_id, request)

Updates a group

Parameters:
Return type:

Group

patch_grid_connections(*, connection_id, request)

Updates a connection

Parameters:
Return type:

GridConnection

patch_grid_machine_users(*, machine_user_id, request)

Updates a machine user

Parameters:
Return type:

GridMachineUser

patch_grid_routes(*, route_id, request)

Updates a route

Parameters:
Return type:

GridRoute

patch_grid_team_settings(*, request)

Updates a team’s Grid settings by team ID or your only team

Parameters:

request (UpdateGridTeamSettingsRequest)

Return type:

GridTeamSettings

patch_grid_team_settings_users(*, user_id, request)

Updates a user’s Grid settings by team ID or your only team

Parameters:
Return type:

GridTeamUserSettings

patch_library_listings(*, user_defined_listing_id, request)

Updates a library listing

Parameters:
Return type:

LibraryListing

patch_library_listings_versions(*, user_defined_listing_id, version_tag, request)

Updates a library listing version

Parameters:
Return type:

LibraryListingVersion

patch_loops_user_config(*, request)

Patches the caller’s Loops user config

Parameters:

request (PatchLoopsUserConfigRequest)

Return type:

PatchLoopsUserConfigResponse

patch_models(*, model_id, request)

Updates a model by ID

Parameters:
Return type:

Model

patch_models_deployments(*, model_id, deployment_id, request)

Updates a model’s deployment by ID

Parameters:
Return type:

Deployment

patch_models_deployments_autoscaling_settings(*, model_id, deployment_id, request)

Updates a deployment’s autoscaling settings

Parameters:
Return type:

UpdateAutoscalingSettingsResponse

patch_models_deployments_development_autoscaling_settings(*, model_id, request)

Updates a development deployment’s autoscaling settings

Parameters:
Return type:

UpdateAutoscalingSettingsResponse

patch_models_deployments_production_autoscaling_settings(*, model_id, request)

Updates a production deployment’s autoscaling settings

Parameters:
Return type:

UpdateAutoscalingSettingsResponse

patch_models_deployments_request_backpressure_settings(*, model_id, deployment_id, request)

Updates a deployment’s request backpressure settings

Parameters:
Return type:

RequestBackpressureSettings

patch_models_environments(*, model_id, env_name, request)

Updates an environment’s settings

Parameters:
Return type:

UpdateEnvironmentResponse

patch_teams_environment_groups(*, team_id, env_name, request)

Updates an environment group’s restriction settings

Parameters:
Return type:

EnvironmentGroup

patch_training_capacity(*, request)

Sets a team’s training GPU capacity

Parameters:

request (PatchTeamTrainingGpuCapacityRequest)

Return type:

PatchTeamTrainingGpuCapacityResponse

patch_training_projects_jobs(*, training_project_id, training_job_id, request)

Updates a training job

Parameters:
Return type:

UpdateTrainingJobResponse

patch_training_projects_jobs_interactive_sessions(*, training_project_id, training_job_id, session_id, request)

Patches an interactive session

Parameters:
Return type:

PatchInteractiveSessionResponse

patch_volumes(*, volume_namespace, volume_name, request)

Updates a volume

Parameters:
Return type:

PatchVolumeResponse

post_api_keys(*, request)

Creates an API key

Parameters:

request (CreateAPIKeyRequest)

Return type:

APIKey

post_chains_deployments_deactivate(*, chain_id, chain_deployment_id)

Deactivates a chain deployment

Parameters:

  • chain_id (str)

  • chain_deployment_id (str)

Return type:

DeactivateResponse

post_chains_environments(*, chain_id, request)

Creates a chain environment

Parameters:
Return type:

ChainEnvironment

post_chains_environments_chainlet_settings_instance_types_update(*, chain_id, env_name, request)

Updates a chainlet environment’s instance type settings

Parameters:
Return type:

UpdateChainletEnvironmentInstanceTypeResponse

post_chains_environments_promote(*, chain_id, env_name, request)

Promotes a chain deployment to an environment

Parameters:
Return type:

ChainDeployment

post_gateway_endpoints(*, request)

Creates a Gateway endpoint

Parameters:

request (CreateEndpointRequest)

Return type:

Endpoint

post_gateway_groups(*, request)

Creates a group

Parameters:

request (CreateGroupRequest)

Return type:

Group

post_gateway_groups_api_keys(*, group_id, request)

Creates an API key for a group

Parameters:
Return type:

CreateApiKeyForGroupResponse

post_gateway_groups_api_keys_register(*, group_id, request)

Registers an API key for a group

Parameters:
Return type:

RegisterAPIKeyResponse

post_grid_connections(*, request)

Creates a connection

Parameters:

request (CreateGridConnectionRequest)

Return type:

GridConnection

post_grid_machine_users(*, request)

Creates a machine user

Parameters:

request (CreateGridMachineUserRequest)

Return type:

CreatedGridMachineUser

post_grid_machine_users_api_keys(*, machine_user_id, request)

Creates an API key for a machine user

Parameters:
Return type:

APIKey

post_grid_routes(*, request)

Creates a route

Parameters:

request (CreateGridRouteRequest)

Return type:

GridRoute

post_grid_token(*, request)

Creates a Grid access token

Parameters:

request (CreateGridTokenRequest)

Return type:

GridToken

post_library_listings(*, request)

Creates a new library listing

Parameters:

request (CreateLibraryListingRequest)

Return type:

LibraryListing

post_library_listings_versions(*, user_defined_listing_id, request)

Creates a new library listing version

Parameters:
Return type:

LibraryListingVersion

post_llm_models(*, request)

Creates a new BIS-LLM deployment

Parameters:

request (CreateLLMModelRequest)

Return type:

LLMModelHandle

post_llm_models_deployments(*, model_id, request)

Creates a new BIS-LLM deployment version

Parameters:
Return type:

LLMModelHandle

post_loops_checkpoints_deploy(*, request)

Deploys Loops checkpoints

Parameters:

request (DeployLoopsCheckpointRequest)

Return type:

DeployLoopsCheckpointResponse

post_loops_checkpoints_validate(*, request)

Validates a Loops checkpoint bt:// URI

Parameters:

request (ValidateLoopsCheckpointRequest)

Return type:

ValidateLoopsCheckpointResponse

post_loops_deployments_deactivate(*, deployment_id)

Deactivates a Loops deployment

Parameters:

deployment_id (str)

Return type:

DeactivateLoopsDeploymentResponse

post_loops_deployments_metrics(*, deployment_id, request)

Gets metrics for a Loops trainer deployment

Parameters:
Return type:

GetLoopsDeploymentMetricsResponse

post_loops_runs(*, request)

Creates a Loops run

Parameters:

request (CreateLoopsRunRequest)

Return type:

CreateLoopsRunResponse

post_loops_runs_deactivate(*, run_id)

Deactivates a Loops run

Parameters:

run_id (str)

Return type:

DeactivateLoopsRunResponse

post_loops_samplers(*, request)

Creates a Loops sampler

Parameters:

request (CreateLoopsSamplerRequest)

Return type:

CreateLoopsSamplerResponse

post_loops_samplers_deactivate(*, sampler_id)

Deactivates a standalone Loops sampler

Parameters:

sampler_id (str)

Return type:

DeactivateLoopsSamplerResponse

post_loops_sessions()

Creates a Loops session

Return type:

CreateLoopsSessionResponse

post_loops_trainers(*, request)

Creates a Loops trainer

Parameters:

request (CreateLoopsTrainerRequest)

Return type:

CreateLoopsRunResponse

post_models(*, request)

Creates a new model from a source

Parameters:

request (CreateModelRequest)

Return type:

CreatedModelDeployment

post_models_deployments(*, model_id, request)

Adds a new deployment to a model

Parameters:
Return type:

CreatedModelDeployment

post_models_deployments_activate(*, model_id, deployment_id)

Activates a deployment

Parameters:

  • model_id (str)

  • deployment_id (str)

Return type:

ActivateResponse

post_models_deployments_deactivate(*, model_id, deployment_id)

Deactivates a deployment

Parameters:

  • model_id (str)

  • deployment_id (str)

Return type:

DeactivateResponse

post_models_deployments_development_activate(*, model_id)

Activates a development deployment

Parameters:

model_id (str)

Return type:

ActivateResponse

post_models_deployments_development_deactivate(*, model_id)

Deactivates a development deployment

Parameters:

model_id (str)

Return type:

DeactivateResponse

post_models_deployments_development_promote(*, model_id, request)

Promotes a development deployment to production

Parameters:
Return type:

Deployment

post_models_deployments_development_retry(*, model_id)

Retries a failed development deployment

Parameters:

model_id (str)

Return type:

RetryDeploymentResponse

post_models_deployments_logs(*, model_id, deployment_id, request)

Gets the logs for a model deployment (deprecated; use GET)

Parameters:
Return type:

GetLogsResponse

post_models_deployments_patches(*, model_id, deployment_id, request)

Stages a patch against a development deployment

Parameters:
Return type:

CreateDeploymentPatchResponse

post_models_deployments_patches_sync(*, model_id, deployment_id, request)

Syncs staged patches to a development deployment

Parameters:
Return type:

SyncDeploymentPatchesResponse

post_models_deployments_production_activate(*, model_id)

Activates a production deployment

Parameters:

model_id (str)

Return type:

ActivateResponse

post_models_deployments_production_deactivate(*, model_id)

Deactivates a production deployment

Parameters:

model_id (str)

Return type:

DeactivateResponse

post_models_deployments_production_retry(*, model_id)

Retries a failed production deployment

Parameters:

model_id (str)

Return type:

RetryDeploymentResponse

post_models_deployments_promote(*, model_id, deployment_id, request)

Promotes a deployment to production

Parameters:
Return type:

Deployment

post_models_deployments_retry(*, model_id, deployment_id)

Retries a failed deployment

Parameters:

  • model_id (str)

  • deployment_id (str)

Return type:

RetryDeploymentResponse

post_models_deployments_ssh_sign(*, model_id, deployment_id, request)

Signs an SSH certificate for an inference model

Parameters:
Return type:

SignSSHCertificateResponse

post_models_environments(*, model_id, request)

Creates an environment

Parameters:
Return type:

Environment

post_models_environments_activate(*, model_id, env_name)

Activates a deployment associated with an environment

Parameters:

  • model_id (str)

  • env_name (str)

Return type:

ActivateResponse

post_models_environments_cancel_promotion(*, model_id, env_name)

Cancels a promotion to an environment

Parameters:

  • model_id (str)

  • env_name (str)

Return type:

CancelPromotionResponse

post_models_environments_deactivate(*, model_id, env_name)

Deactivates a deployment associated with an environment

Parameters:

  • model_id (str)

  • env_name (str)

Return type:

DeactivateResponse

post_models_environments_force_cancel_promotion(*, model_id, env_name)

Force cancels a rolling promotion

Parameters:

  • model_id (str)

  • env_name (str)

Return type:

SignalPromotionResponse

post_models_environments_force_roll_forward_promotion(*, model_id, env_name)

Force rolls forward a rolling promotion

Parameters:

  • model_id (str)

  • env_name (str)

Return type:

SignalPromotionResponse

post_models_environments_pause_promotion(*, model_id, env_name)

Pauses a rolling promotion

Parameters:

  • model_id (str)

  • env_name (str)

Return type:

SignalPromotionResponse

post_models_environments_promote(*, model_id, env_name, request)

Promotes a deployment to an environment

Parameters:
Return type:

Deployment

post_models_environments_resume_promotion(*, model_id, env_name)

Resumes a paused rolling promotion

Parameters:

  • model_id (str)

  • env_name (str)

Return type:

SignalPromotionResponse

post_prepare_model_upload(*, request)

Validates a model push payload and issues upload credentials

Parameters:

request (PrepareModelUploadRequest)

Return type:

PrepareModelUploadResponse

post_secrets(*, request)

Upserts a secret

Parameters:

request (UpsertSecretRequest)

Return type:

Secret

post_teams_api_keys(*, team_id, request)

Creates a team API key

Parameters:
Return type:

APIKey

post_teams_llm_models(*, team_id, request)

Creates a new BIS-LLM deployment

Parameters:
Return type:

LLMModelHandle

post_teams_loops_runs(*, team_id, request)

Creates a Loops run in a team

Parameters:
Return type:

CreateLoopsRunResponse

post_teams_loops_samplers(*, team_id, request)

Creates a Loops sampler in a team

Parameters:
Return type:

CreateLoopsSamplerResponse

post_teams_loops_sessions(*, team_id)

Creates a Loops session

Parameters:

team_id (str)

Return type:

CreateLoopsSessionResponse

post_teams_loops_trainers(*, team_id, request)

Creates a Loops trainer

Parameters:
Return type:

CreateLoopsRunResponse

post_teams_models(*, team_id, request)

Creates a new model from a source

Parameters:
Return type:

CreatedModelDeployment

post_teams_secrets(*, team_id, request)

Upserts a secret in a team

Parameters:
Return type:

Secret

post_teams_training_projects(*, team_id, request)

Upserts a training project in a specific team

Parameters:
Return type:

UpsertTrainingProjectResponse

post_token(*, request)

Creates a sandbox access token

Parameters:

request (CreateTokenRequest)

Return type:

Token

Searches training jobs

Parameters:

request (SearchTrainingJobsRequest)

Return type:

SearchTrainingJobsResponse

post_training_projects(*, request)

Upserts a training project

Parameters:

request (UpsertTrainingProjectRequest)

Return type:

UpsertTrainingProjectResponse

post_training_projects_jobs(*, training_project_id, request)

Creates a training job

Parameters:
Return type:

CreateTrainingJobResponse

post_training_projects_jobs_logs(*, training_project_id, training_job_id, request)

Gets the logs for a training job (deprecated; use GET)

Parameters:
Return type:

GetLogsResponse

post_training_projects_jobs_metrics(*, training_project_id, training_job_id, request)

Gets the metrics for a training job (deprecated; use GET)

Parameters:
Return type:

GetTrainingJobMetricsResponse

post_training_projects_jobs_recreate(*, training_project_id, training_job_id)

Recreates a training job

Parameters:

  • training_project_id (str)

  • training_job_id (str)

Return type:

RecreateTrainingJobResponse

post_training_projects_jobs_ssh_sign(*, training_project_id, training_job_id, request)

Signs an SSH certificate for a training job

Parameters:
Return type:

SignSSHCertificateResponse

post_training_projects_jobs_stop(*, training_project_id, training_job_id, request)

Stops a training job

Parameters:
Return type:

StopTrainingJobResponse

post_volumes_syncs(*, request)

Starts a volume sync

Parameters:

request (CreateVolumeSyncRequest)

Return type:

VolumeSync

post_volumes_syncs_cancel(*, volume_sync_id)

Cancels a volume sync

Parameters:

volume_sync_id (str)

Return type:

VolumeSync

post_volumes_tags(*, volume_namespace, volume_name, request)

Sets a volume tag

Parameters:
Return type:

SetVolumeTagResponse

post_volumes_token(*, request)

Creates a volume access token

Parameters:

request (CreateVolumeTokenRequest)

Return type:

CreateVolumeTokenResponse

post_volumes_versions_restore(*, volume_namespace, volume_name, volume_version, request)

Restores a deleted or expired version of a volume

Parameters:
Return type:

RestoreVolumeVersionResponse

push_image(*, params=None, request)

Push a sandbox image

Parameters:
Return type:

PushSandboxImageResponse

update_sandbox(*, sandbox_name, params=None, request)

Update a sandbox

Parameters:
Return type:

Sandbox

update_sandbox_preview(*, sandbox_name, preview_name, params=None, request)

Update a sandbox preview

Parameters:
Return type:

SandboxPreview

update_sandbox_volume(*, volume_name, params=None, request)

Update a volume

Parameters:
Return type:

SandboxVolume