api.md

Beta

Jig

Types:

from together.types.beta import Deployment, DeploymentLogs, JigListResponse

Methods:

• client.beta.jig.retrieve(id) -> Deployment
• client.beta.jig.update(id, **params) -> Deployment
• client.beta.jig.list() -> JigListResponse
• client.beta.jig.deploy(**params) -> Deployment
• client.beta.jig.destroy(id) -> object
• client.beta.jig.retrieve_logs(id, **params) -> DeploymentLogs

Queue

Types:

from together.types.beta.jig import (
    QueueRetrieveResponse,
    QueueCancelResponse,
    QueueMetricsResponse,
    QueueSubmitResponse,
)

Methods:

• client.beta.jig.queue.retrieve(**params) -> QueueRetrieveResponse
• client.beta.jig.queue.cancel(**params) -> QueueCancelResponse
• client.beta.jig.queue.metrics(**params) -> QueueMetricsResponse
• client.beta.jig.queue.submit(**params) -> QueueSubmitResponse

Volumes

Types:

from together.types.beta.jig import Volume, VolumeListResponse

Methods:

• client.beta.jig.volumes.create(**params) -> Volume
• client.beta.jig.volumes.retrieve(id) -> Volume
• client.beta.jig.volumes.update(id, **params) -> Volume
• client.beta.jig.volumes.list() -> VolumeListResponse
• client.beta.jig.volumes.delete(id) -> object

Secrets

Types:

from together.types.beta.jig import Secret, SecretListResponse

Methods:

• client.beta.jig.secrets.create(**params) -> Secret
• client.beta.jig.secrets.retrieve(id) -> Secret
• client.beta.jig.secrets.update(id, **params) -> Secret
• client.beta.jig.secrets.list() -> SecretListResponse
• client.beta.jig.secrets.delete(id) -> object

Clusters

Types:

from together.types.beta import (
    Cluster,
    ClusterListResponse,
    ClusterDeleteResponse,
    ClusterListRegionsResponse,
)

Methods:

• client.beta.clusters.create(**params) -> Cluster
• client.beta.clusters.retrieve(cluster_id) -> Cluster
• client.beta.clusters.update(cluster_id, **params) -> Cluster
• client.beta.clusters.list() -> ClusterListResponse
• client.beta.clusters.delete(cluster_id) -> ClusterDeleteResponse
• client.beta.clusters.list_regions() -> ClusterListRegionsResponse

Storage

Types:

from together.types.beta.clusters import ClusterStorage, StorageListResponse, StorageDeleteResponse

Methods:

• client.beta.clusters.storage.create(**params) -> ClusterStorage
• client.beta.clusters.storage.retrieve(volume_id) -> ClusterStorage
• client.beta.clusters.storage.update(**params) -> ClusterStorage
• client.beta.clusters.storage.list() -> StorageListResponse
• client.beta.clusters.storage.delete(volume_id) -> StorageDeleteResponse

Chat

Completions

Types:

from together.types.chat import (
    ChatCompletion,
    ChatCompletionChunk,
    ChatCompletionStructuredMessageImageURL,
    ChatCompletionStructuredMessageText,
    ChatCompletionStructuredMessageVideoURL,
    ChatCompletionUsage,
    ChatCompletionWarning,
)

Methods:

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

Completions

Types:

from together.types import Completion, CompletionChunk, LogProbs, ToolChoice, Tools

Methods:

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

Embeddings

Types:

from together.types import Embedding

Methods:

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

Files

Types:

from together.types import FileList, FilePurpose, FileResponse, FileType, FileDeleteResponse

Methods:

• client.files.retrieve(id) -> FileResponse
• client.files.list() -> FileList
• client.files.delete(id) -> FileDeleteResponse
• client.files.content(id) -> BinaryAPIResponse

FineTuning

Types:

from together.types import (
    FinetuneEvent,
    FinetuneEventType,
    FinetuneResponse,
    FineTuningListResponse,
    FineTuningDeleteResponse,
    FineTuningCancelResponse,
    FineTuningEstimatePriceResponse,
    FineTuningListCheckpointsResponse,
    FineTuningListEventsResponse,
)

Methods:

• client.fine_tuning.retrieve(id) -> FinetuneResponse
• client.fine_tuning.list() -> FineTuningListResponse
• client.fine_tuning.delete(id, **params) -> FineTuningDeleteResponse
• client.fine_tuning.cancel(id) -> FineTuningCancelResponse
• client.fine_tuning.content(**params) -> BinaryAPIResponse
• client.fine_tuning.estimate_price(**params) -> FineTuningEstimatePriceResponse
• client.fine_tuning.list_checkpoints(id) -> FineTuningListCheckpointsResponse
• client.fine_tuning.list_events(id) -> FineTuningListEventsResponse

CodeInterpreter

Types:

from together.types import ExecuteResponse

Methods:

• client.code_interpreter.execute(**params) -> ExecuteResponse

Sessions

Types:

from together.types.code_interpreter import SessionListResponse

Methods:

• client.code_interpreter.sessions.list() -> SessionListResponse

Images

Types:

from together.types import ImageDataB64, ImageDataURL, ImageFile

Methods:

• client.images.generate(**params) -> ImageFile

Videos

Types:

from together.types import VideoJob

Methods:

• client.videos.create(**params) -> VideoJob
• client.videos.retrieve(id) -> VideoJob

Audio

Types:

from together.types import AudioFile, AudioSpeechStreamChunk

Speech

Methods:

• client.audio.speech.create(**params) -> BinaryAPIResponse

Voices

Types:

from together.types.audio import VoiceListResponse

Methods:

• client.audio.voices.list() -> VoiceListResponse

Transcriptions

Types:

from together.types.audio import TranscriptionCreateResponse

Methods:

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

Translations

Types:

from together.types.audio import TranslationCreateResponse

Methods:

• client.audio.translations.create(**params) -> TranslationCreateResponse

Models

Types:

from together.types import ModelObject, ModelListResponse, ModelUploadResponse

Methods:

• client.models.list(**params) -> ModelListResponse
• client.models.upload(**params) -> ModelUploadResponse

Uploads

Types:

from together.types.models import UploadStatusResponse

Methods:

• client.models.uploads.status(job_id) -> UploadStatusResponse

Endpoints

Types:

from together.types import (
    Autoscaling,
    DedicatedEndpoint,
    EndpointListResponse,
    EndpointListAvzonesResponse,
    EndpointListHardwareResponse,
)

Methods:

• client.endpoints.create(**params) -> DedicatedEndpoint
• client.endpoints.retrieve(endpoint_id) -> DedicatedEndpoint
• client.endpoints.update(endpoint_id, **params) -> DedicatedEndpoint
• client.endpoints.list(**params) -> EndpointListResponse
• client.endpoints.delete(endpoint_id) -> None
• client.endpoints.list_avzones() -> EndpointListAvzonesResponse
• client.endpoints.list_hardware(**params) -> EndpointListHardwareResponse

Rerank

Types:

from together.types import RerankCreateResponse

Methods:

• client.rerank.create(**params) -> RerankCreateResponse

Batches

Types:

from together.types import BatchJob, BatchCreateResponse, BatchListResponse

Methods:

• client.batches.create(**params) -> BatchCreateResponse
• client.batches.retrieve(id) -> BatchJob
• client.batches.list() -> BatchListResponse
• client.batches.cancel(id) -> BatchJob

Evals

Types:

from together.types import EvaluationJob, EvalCreateResponse, EvalListResponse, EvalStatusResponse

Methods:

• client.evals.create(**params) -> EvalCreateResponse
• client.evals.retrieve(id) -> EvaluationJob
• client.evals.list(**params) -> EvalListResponse
• client.evals.status(id) -> EvalStatusResponse