Types:
from together.types import WhoamiResponseMethods:
client.whoami() -> WhoamiResponse
Types:
from together.types.beta.organization import (
BillingUsageLineItem,
BillingUsageReport,
BillingUsageWindow,
)Types:
from together.types.beta import (
AbMember,
DeploymentAutoscaling,
DeploymentMetrics,
DeploymentPlacementConfig,
DeploymentStatus,
Endpoint,
EndpointDeployment,
EndpointDeploymentSummary,
EndpointTrafficSplitEntry,
ErrorMetrics,
LatencyMetrics,
MetricsTimeRange,
RequestMetrics,
ResourceUtilization,
RuntimeInfo,
ScalingMetric,
ScalingPolicy,
ScalingRules,
ShadowAdaptiveKeyBasedSampling,
ShadowAdaptiveKeyBasedSamplingResponse,
ShadowAdaptiveUniformSampling,
ShadowAdaptiveUniformSamplingResponse,
ShadowEndpointSource,
ShadowEndpointSourceResponse,
ShadowKeyBasedSampling,
ShadowKeyBasedSamplingResponse,
ShadowSource,
ShadowSourceResponse,
ShadowUniformSampling,
ShadowUniformSamplingResponse,
ThroughputMetrics,
TimeSeriesDataPoint,
TokenMetrics,
EndpointDeleteResponse,
EndpointAnalyticsResponse,
EndpointListEventsResponse,
)Methods:
client.beta.endpoints.create(*, project_id, **params) -> Endpointclient.beta.endpoints.retrieve(id, *, project_id) -> Endpointclient.beta.endpoints.update(id, *, project_id, **params) -> Endpointclient.beta.endpoints.list(*, project_id, **params) -> SyncCursorPagination[Endpoint]client.beta.endpoints.delete(id, *, project_id, **params) -> EndpointDeleteResponseclient.beta.endpoints.analytics(id, *, project_id, **params) -> EndpointAnalyticsResponseclient.beta.endpoints.list_events(id, *, project_id, **params) -> SyncCursorPagination[EndpointListEventsResponse]client.beta.endpoints.list_org_scoped(organization_id, **params) -> SyncCursorPagination[Endpoint]
Types:
from together.types.beta.endpoints import PlacementProfileMethods:
client.beta.endpoints.placement_profiles.retrieve(id, *, project_id) -> PlacementProfileclient.beta.endpoints.placement_profiles.list(*, project_id, **params) -> SyncCursorPagination[PlacementProfile]
Types:
from together.types.beta.endpoints import AbExperiment, AbExperimentDeleteResponseMethods:
client.beta.endpoints.ab_experiments.create(endpoint_id, *, project_id, **params) -> AbExperimentclient.beta.endpoints.ab_experiments.retrieve(id, *, project_id, endpoint_id) -> AbExperimentclient.beta.endpoints.ab_experiments.update(id, *, project_id, endpoint_id, **params) -> AbExperimentclient.beta.endpoints.ab_experiments.list(endpoint_id, *, project_id, **params) -> SyncCursorPagination[AbExperiment]client.beta.endpoints.ab_experiments.delete(id, *, project_id, endpoint_id, **params) -> AbExperimentDeleteResponse
Types:
from together.types.beta.endpoints import ShadowExperiment, ShadowExperimentDeleteResponseMethods:
client.beta.endpoints.shadow_experiments.create(endpoint_id, *, project_id, **params) -> ShadowExperimentclient.beta.endpoints.shadow_experiments.retrieve(id, *, project_id, endpoint_id) -> ShadowExperimentclient.beta.endpoints.shadow_experiments.update(id, *, project_id, endpoint_id, **params) -> ShadowExperimentclient.beta.endpoints.shadow_experiments.list(endpoint_id, *, project_id, **params) -> SyncCursorPagination[ShadowExperiment]client.beta.endpoints.shadow_experiments.delete(id, *, project_id, endpoint_id, **params) -> ShadowExperimentDeleteResponse
Types:
from together.types.beta.endpoints.shadow_experiments import (
ShadowExperimentTarget,
TargetDeleteResponse,
)Methods:
client.beta.endpoints.shadow_experiments.targets.create(*, project_id, endpoint_id, experiment_id, **params) -> ShadowExperimentTargetclient.beta.endpoints.shadow_experiments.targets.retrieve(id, *, project_id, endpoint_id, experiment_id) -> ShadowExperimentTargetclient.beta.endpoints.shadow_experiments.targets.update(id, *, project_id, endpoint_id, experiment_id, **params) -> ShadowExperimentTargetclient.beta.endpoints.shadow_experiments.targets.list(endpoint_id, experiment_id, *, project_id, **params) -> SyncCursorPagination[ShadowExperimentTarget]client.beta.endpoints.shadow_experiments.targets.delete(id, *, project_id, endpoint_id, experiment_id, **params) -> TargetDeleteResponse
Types:
from together.types.beta.endpoints import (
BlueGreenConfig,
CanaryConfig,
MetricResult,
MetricRule,
PauseInfo,
RegressionCheck,
RollingConfig,
Rollout,
RolloutCondition,
RolloutDefaultsPreview,
RolloutStatus,
RolloutStep,
RolloutStepStatus,
ThresholdCheck,
RolloutDeleteResponse,
)Methods:
client.beta.endpoints.rollouts.create(endpoint_id, *, project_id, **params) -> Rolloutclient.beta.endpoints.rollouts.retrieve(id, *, project_id, endpoint_id) -> Rolloutclient.beta.endpoints.rollouts.list(endpoint_id, *, project_id, **params) -> SyncCursorPagination[Rollout]client.beta.endpoints.rollouts.delete(id, *, project_id, endpoint_id, **params) -> RolloutDeleteResponseclient.beta.endpoints.rollouts.cancel(id, *, project_id, endpoint_id, **params) -> Rolloutclient.beta.endpoints.rollouts.pause(id, *, project_id, endpoint_id, **params) -> Rolloutclient.beta.endpoints.rollouts.preview_defaults(endpoint_id, *, project_id, **params) -> RolloutDefaultsPreviewclient.beta.endpoints.rollouts.promote(id, *, project_id, endpoint_id, **params) -> Rolloutclient.beta.endpoints.rollouts.resume(id, *, project_id, endpoint_id, **params) -> Rolloutclient.beta.endpoints.rollouts.start(id, *, project_id, endpoint_id) -> Rollout
Types:
from together.types.beta.endpoints import InferenceInstanceType, HardwareListResponseMethods:
client.beta.endpoints.hardware.retrieve(id) -> InferenceInstanceTypeclient.beta.endpoints.hardware.list() -> HardwareListResponse
Types:
from together.types.beta.endpoints import (
DeploymentAdapterStatus,
AdapterCreateResponse,
AdapterRetrieveResponse,
AdapterUpdateResponse,
AdapterListResponse,
AdapterDeleteResponse,
)Methods:
client.beta.endpoints.adapters.create(*, project_id, endpoint_id, deployment_id, **params) -> AdapterCreateResponseclient.beta.endpoints.adapters.retrieve(id, *, project_id, endpoint_id, deployment_id) -> AdapterRetrieveResponseclient.beta.endpoints.adapters.update(id, *, project_id, endpoint_id, deployment_id, **params) -> AdapterUpdateResponseclient.beta.endpoints.adapters.list(endpoint_id, deployment_id, *, project_id, **params) -> SyncCursorPagination[AdapterListResponse]client.beta.endpoints.adapters.delete(id, *, project_id, endpoint_id, deployment_id, **params) -> AdapterDeleteResponse
Types:
from together.types.beta.endpoints import DeploymentDeleteResponseMethods:
client.beta.endpoints.deployments.create(endpoint_id, *, project_id, **params) -> EndpointDeploymentclient.beta.endpoints.deployments.retrieve(id, *, project_id, endpoint_id) -> EndpointDeploymentclient.beta.endpoints.deployments.update(id, *, project_id, endpoint_id, **params) -> EndpointDeploymentclient.beta.endpoints.deployments.list(endpoint_id, *, project_id, **params) -> SyncCursorPagination[EndpointDeployment]client.beta.endpoints.deployments.delete(id, *, project_id, endpoint_id, **params) -> DeploymentDeleteResponse
Types:
from together.types.beta import (
Model,
ModelDtypeCount,
ModelParameters,
ModelWeights,
SupportedModel,
SupportedModelDeploymentProfile,
SupportedModelPerformanceBenchmarks,
ModelDeleteResponse,
ModelListFilesResponse,
ModelListRevisionsResponse,
)Methods:
client.beta.models.create(*, project_id, **params) -> Modelclient.beta.models.retrieve(id, *, project_id) -> Modelclient.beta.models.update(id, *, project_id, **params) -> Modelclient.beta.models.list(*, project_id, **params) -> SyncCursorPagination[Model]client.beta.models.delete(id, *, project_id) -> ModelDeleteResponseclient.beta.models.list_files(id, *, project_id, **params) -> ModelListFilesResponseclient.beta.models.list_org_scoped(organization_id, **params) -> SyncCursorPagination[Model]client.beta.models.list_revisions(id, *, project_id) -> ModelListRevisionsResponseclient.beta.models.list_supported(**params) -> SyncCursorPagination[SupportedModel]client.beta.models.retrieve_supported(id) -> SupportedModel
Types:
from together.types.beta.models import (
RemoteUploadCreateResponse,
RemoteUploadRetrieveResponse,
RemoteUploadListResponse,
RemoteUploadEventsResponse,
)Methods:
client.beta.models.remote_uploads.create(*, project_id, **params) -> RemoteUploadCreateResponseclient.beta.models.remote_uploads.retrieve(id, *, project_id) -> RemoteUploadRetrieveResponseclient.beta.models.remote_uploads.list(*, project_id, **params) -> SyncCursorPagination[RemoteUploadListResponse]client.beta.models.remote_uploads.events(id, *, project_id, **params) -> RemoteUploadEventsResponse
Types:
from together.types.beta.models import Certification, Config, SelectorMethods:
client.beta.models.configs.retrieve(id, *, project_id) -> Configclient.beta.models.configs.list(*, project_id, **params) -> SyncCursorPagination[Config]
Types:
from together.types.beta.rl import (
InferenceCheckpoint,
LoraConfig,
Session,
SessionError,
SessionErrorCode,
SessionMetadata,
SessionStatus,
SessionsListResponse,
TrainingCheckpoint,
WandbMetadata,
)Methods:
client.beta.rl.sessions.create(**params) -> Sessionclient.beta.rl.sessions.retrieve(session_id) -> Sessionclient.beta.rl.sessions.update(session_id, **params) -> Sessionclient.beta.rl.sessions.list(**params) -> SessionsListResponseclient.beta.rl.sessions.stop(session_id) -> Session
Types:
from together.types.beta.rl import (
AdamParams,
CispoLossParams,
CrossEntropyLossParams,
CustomForwardBackwardOperation,
CustomForwardBackwardResult,
DType,
DppoLossParams,
DroLossParams,
EncodedTextChunk,
ForwardBackwardOperation,
ForwardBackwardResult,
GrpoLossAggregationType,
GrpoLossParams,
GrpoLossRatioType,
InferenceCheckpointOperation,
InferenceCheckpointResult,
LossConfig,
LossFnOutput,
LossType,
ModelInput,
ModelInputChunk,
MuonParams,
OperationError,
OperationErrorCode,
OperationStatus,
OptimStepOperation,
OptimStepResult,
PolicyVersionSegment,
PpoLossParams,
PromptTopLogprobs,
SampleOperation,
SampleResult,
SampledSequence,
SamplingParams,
StopReason,
TensorData,
TrainingCheckpointOperation,
TrainingCheckpointResult,
WeightSyncType,
WeightsSyncOperation,
WeightsSyncResult,
)Methods:
client.beta.rl.operations.create_inference_checkpoint(session_id) -> InferenceCheckpointOperationclient.beta.rl.operations.create_training_checkpoint(session_id) -> TrainingCheckpointOperationclient.beta.rl.operations.custom_forward_backward(session_id, **params) -> CustomForwardBackwardOperationclient.beta.rl.operations.forward_backward(session_id, **params) -> ForwardBackwardOperationclient.beta.rl.operations.optim_step(session_id, **params) -> OptimStepOperationclient.beta.rl.operations.retrieve_custom_forward_backward(operation_id, *, session_id) -> CustomForwardBackwardOperationclient.beta.rl.operations.retrieve_forward_backward(operation_id, *, session_id) -> ForwardBackwardOperationclient.beta.rl.operations.retrieve_inference_checkpoint(operation_id, *, session_id) -> InferenceCheckpointOperationclient.beta.rl.operations.retrieve_optim_step(operation_id, *, session_id) -> OptimStepOperationclient.beta.rl.operations.retrieve_sample(operation_id, *, session_id) -> SampleOperationclient.beta.rl.operations.retrieve_training_checkpoint(operation_id, *, session_id) -> TrainingCheckpointOperationclient.beta.rl.operations.retrieve_weights_sync(operation_id, *, session_id) -> WeightsSyncOperationclient.beta.rl.operations.sample(session_id, **params) -> SampleOperationclient.beta.rl.operations.weights_sync(session_id, **params) -> WeightsSyncOperation
Types:
from together.types.beta.rl import (
Checkpoint,
CheckpointDownloadResponse,
CheckpointFile,
CheckpointType,
CheckpointVariant,
CheckpointsListResponse,
)Methods:
client.beta.rl.checkpoints.retrieve(id) -> Checkpointclient.beta.rl.checkpoints.list(**params) -> CheckpointsListResponseclient.beta.rl.checkpoints.download(id, **params) -> CheckpointDownloadResponse
Types:
from together.types.beta.rl import (
QuantizationEstimate,
QuantizationEvent,
QuantizationJob,
QuantizationResults,
ShapingJobStatus,
ShapingJobType,
PrepareForFp4InferenceListResponse,
PrepareForFp4InferenceListEventsResponse,
)Methods:
client.beta.rl.prepare_for_fp4_inference.create(**params) -> QuantizationJobclient.beta.rl.prepare_for_fp4_inference.retrieve(id) -> QuantizationJobclient.beta.rl.prepare_for_fp4_inference.list() -> PrepareForFp4InferenceListResponseclient.beta.rl.prepare_for_fp4_inference.cancel(id) -> QuantizationJobclient.beta.rl.prepare_for_fp4_inference.estimate_cost(**params) -> QuantizationEstimateclient.beta.rl.prepare_for_fp4_inference.list_events(id) -> PrepareForFp4InferenceListEventsResponse
Types:
from together.types.beta.rl import (
AdamConfig,
ModelResources,
ModelResourcesError,
ModelResourcesErrorCode,
ModelResourcesEstimateCostResponse,
ModelResourcesListResponse,
ModelResourcesStatus,
MuonConfig,
MuonScalingStrategy,
OptimizerConfig,
)Methods:
client.beta.rl.model_resources.create(**params) -> ModelResourcesclient.beta.rl.model_resources.retrieve(model_resources_id) -> ModelResourcesclient.beta.rl.model_resources.list(**params) -> ModelResourcesListResponseclient.beta.rl.model_resources.estimate_cost(**params) -> ModelResourcesEstimateCostResponseclient.beta.rl.model_resources.stop(model_resources_id, **params) -> ModelResources
Types:
from together.types.beta.rl import RlSupportedModel, RlSupportedModelsMethods:
client.beta.rl.supported_models.get() -> RlSupportedModels
Types:
from together.types.beta import (
ContainerDeploymentStatus,
Deployment,
DeploymentLogs,
DeploymentRevision,
DeploymentRevisionEvent,
DeploymentRevisionEventList,
JigListResponse,
)Methods:
client.beta.jig.retrieve(id) -> Deploymentclient.beta.jig.update(id, **params) -> Deploymentclient.beta.jig.list() -> JigListResponseclient.beta.jig.deploy(**params) -> Deploymentclient.beta.jig.destroy(id) -> objectclient.beta.jig.list_revisions(id, **params) -> DeploymentRevisionEventListclient.beta.jig.retrieve_logs(id, **params) -> DeploymentLogsclient.beta.jig.retrieve_revision(revision_identifier, *, id) -> DeploymentRevisionclient.beta.jig.rollback(id, **params) -> Deployment
Types:
from together.types.beta.jig import (
QueueRetrieveResponse,
QueueCancelResponse,
QueueClearResponse,
QueueMetricsResponse,
QueueSubmitResponse,
)Methods:
client.beta.jig.queue.retrieve(**params) -> QueueRetrieveResponseclient.beta.jig.queue.cancel(**params) -> QueueCancelResponseclient.beta.jig.queue.clear(**params) -> QueueClearResponseclient.beta.jig.queue.metrics(**params) -> QueueMetricsResponseclient.beta.jig.queue.submit(**params) -> QueueSubmitResponse
Types:
from together.types.beta.jig import S3Origin, Volume, VolumeOrigin, VolumeStatus, VolumeListResponseMethods:
client.beta.jig.volumes.create(**params) -> Volumeclient.beta.jig.volumes.retrieve(id, **params) -> Volumeclient.beta.jig.volumes.update(id, **params) -> Volumeclient.beta.jig.volumes.list() -> VolumeListResponseclient.beta.jig.volumes.delete(id) -> object
Types:
from together.types.beta.jig import Secret, SecretListResponseMethods:
client.beta.jig.secrets.create(**params) -> Secretclient.beta.jig.secrets.retrieve(id) -> Secretclient.beta.jig.secrets.update(id, **params) -> Secretclient.beta.jig.secrets.list() -> SecretListResponseclient.beta.jig.secrets.delete(id) -> object
Types:
from together.types import (
Cluster,
ClusterListResponse,
ClusterDeleteResponse,
ClusterListRegionsResponse,
)Methods:
client.clusters.create(**params) -> Clusterclient.clusters.retrieve(cluster_id) -> Clusterclient.clusters.update(cluster_id, **params) -> Clusterclient.clusters.list(**params) -> ClusterListResponseclient.clusters.delete(cluster_id) -> ClusterDeleteResponseclient.clusters.list_regions() -> ClusterListRegionsResponse
Types:
from together.types.clusters import Remediation, RemediationListResponseMethods:
client.clusters.remediations.create(instance_id, *, cluster_id, **params) -> Remediationclient.clusters.remediations.retrieve(remediation_id, *, cluster_id, instance_id) -> Remediationclient.clusters.remediations.list(instance_id, *, cluster_id, **params) -> RemediationListResponseclient.clusters.remediations.approve(remediation_id, *, cluster_id, instance_id, **params) -> Remediationclient.clusters.remediations.cancel(remediation_id, *, cluster_id, instance_id) -> Remediationclient.clusters.remediations.reject(remediation_id, *, cluster_id, instance_id, **params) -> Remediation
Types:
from together.types.clusters import ClusterStorage, StorageListResponse, StorageDeleteResponseMethods:
client.clusters.storage.create(**params) -> ClusterStorageclient.clusters.storage.retrieve(volume_id) -> ClusterStorageclient.clusters.storage.update(**params) -> ClusterStorageclient.clusters.storage.list(**params) -> StorageListResponseclient.clusters.storage.delete(volume_id) -> StorageDeleteResponse
Types:
from together.types.chat import (
ChatCompletion,
ChatCompletionChunk,
ChatCompletionPrompt,
ChatCompletionStructuredMessageImageURL,
ChatCompletionStructuredMessageText,
ChatCompletionStructuredMessageVideoURL,
ChatCompletionUsage,
ChatCompletionWarning,
)Methods:
client.chat.completions.create(**params) -> ChatCompletion
Types:
from together.types import Completion, CompletionChunk, LogProbs, ToolChoice, ToolsMethods:
client.completions.create(**params) -> Completion
Types:
from together.types import EmbeddingMethods:
Types:
from together.types import FileList, FilePurpose, FileResponse, FileType, FileDeleteResponseMethods:
client.files.retrieve(id) -> FileResponseclient.files.list() -> FileListclient.files.delete(id) -> FileDeleteResponseclient.files.content(id) -> BinaryAPIResponse
Types:
from together.types import (
FineTunePreviewResponse,
FineTunePreviewRow,
FineTuneTokenizedDatasetRetrieveResponse,
FinetuneEvent,
FinetuneEventType,
FinetuneModelLimits,
FinetuneResponse,
FineTuningListResponse,
FineTuningDeleteResponse,
FineTuningCancelResponse,
FineTuningEstimatePriceResponse,
FineTuningListCheckpointsResponse,
FineTuningListEventsResponse,
FineTuningListMetricsResponse,
FineTuningModelLimitsResponse,
)Methods:
client.fine_tuning.retrieve(id) -> FinetuneResponseclient.fine_tuning.list() -> FineTuningListResponseclient.fine_tuning.delete(id, **params) -> FineTuningDeleteResponseclient.fine_tuning.cancel(id) -> FineTuningCancelResponseclient.fine_tuning.content(**params) -> BinaryAPIResponseclient.fine_tuning.estimate_price(**params) -> FineTuningEstimatePriceResponseclient.fine_tuning.list_checkpoints(id) -> FineTuningListCheckpointsResponseclient.fine_tuning.list_events(id) -> FineTuningListEventsResponseclient.fine_tuning.list_metrics(id, **params) -> FineTuningListMetricsResponseclient.fine_tuning.model_limits(**params) -> FinetuneModelLimitsclient.fine_tuning.preview(**params) -> FineTunePreviewResponseclient.fine_tuning.retrieve_tokenized_dataset(id) -> FineTuneTokenizedDatasetRetrieveResponse
Types:
from together.types import ExecuteResponseMethods:
client.code_interpreter.execute(**params) -> ExecuteResponse
Types:
from together.types.code_interpreter import SessionListResponseMethods:
client.code_interpreter.sessions.list() -> SessionListResponse
Types:
from together.types import ImageDataB64, ImageDataURL, ImageFileMethods:
Types:
from together.types import VideoJobMethods:
Types:
from together.types import AudioFile, AudioSpeechStreamChunkMethods:
Types:
from together.types.audio import VoiceListResponseMethods:
client.audio.voices.list() -> VoiceListResponse
Types:
from together.types.audio import TranscriptionCreateResponseMethods:
client.audio.transcriptions.create(**params) -> TranscriptionCreateResponse
Types:
from together.types.audio import TranslationCreateResponseMethods:
client.audio.translations.create(**params) -> TranslationCreateResponse
Types:
from together.types import ModelObject, ModelListResponse, ModelUploadResponseMethods:
client.models.list(**params) -> ModelListResponseclient.models.upload(**params) -> ModelUploadResponse
Types:
from together.types.models import UploadStatusResponseMethods:
client.models.uploads.status(job_id) -> UploadStatusResponse
Types:
from together.types import (
Autoscaling,
DedicatedEndpoint,
EndpointListResponse,
EndpointListAvzonesResponse,
EndpointListHardwareResponse,
)Methods:
client.endpoints.create(**params) -> DedicatedEndpointclient.endpoints.retrieve(endpoint_id) -> DedicatedEndpointclient.endpoints.update(endpoint_id, **params) -> DedicatedEndpointclient.endpoints.list(**params) -> EndpointListResponseclient.endpoints.delete(endpoint_id) -> Noneclient.endpoints.list_avzones() -> EndpointListAvzonesResponseclient.endpoints.list_hardware(**params) -> EndpointListHardwareResponse
Types:
from together.types.endpoints import AdapterListResponse, AdapterAddResponse, AdapterRemoveResponseMethods:
client.endpoints.adapters.list(endpoint_id) -> AdapterListResponseclient.endpoints.adapters.add(endpoint_id, **params) -> AdapterAddResponseclient.endpoints.adapters.remove(endpoint_id, **params) -> AdapterRemoveResponse
Types:
from together.types import ProjectMethods:
client.projects.list(**params) -> SyncCursorPagination[Project]
Types:
from together.types import RerankCreateResponseMethods:
client.rerank.create(**params) -> RerankCreateResponse
Types:
from together.types import BatchJob, BatchCreateResponse, BatchListResponseMethods:
client.batches.create(**params) -> BatchCreateResponseclient.batches.retrieve(id) -> BatchJobclient.batches.list() -> BatchListResponseclient.batches.cancel(id) -> BatchJob
Types:
from together.types import EvaluationJob, EvalCreateResponse, EvalListResponse, EvalStatusResponseMethods:
client.evals.create(**params) -> EvalCreateResponseclient.evals.retrieve(id) -> EvaluationJobclient.evals.list(**params) -> EvalListResponseclient.evals.status(id) -> EvalStatusResponse