api.md

Beta

Jig

Types:

• Deployment
• DeploymentLogs
• JigListResponse
• JigDestroyResponse

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) -> unknown
• client.beta.jig.retrieveLogs(id, { ...params }) -> DeploymentLogs

Queue

Types:

• 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:

• Volume
• VolumeListResponse
• VolumeDeleteResponse

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) -> unknown

Secrets

Types:

• Secret
• SecretListResponse
• SecretDeleteResponse

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) -> unknown

Clusters

Types:

• Cluster
• ClusterListResponse
• ClusterDeleteResponse
• ClusterListRegionsResponse

Methods:

• client.beta.clusters.create({ ...params }) -> Cluster
• client.beta.clusters.retrieve(clusterID) -> Cluster
• client.beta.clusters.update(clusterID, { ...params }) -> Cluster
• client.beta.clusters.list() -> ClusterListResponse
• client.beta.clusters.delete(clusterID) -> ClusterDeleteResponse
• client.beta.clusters.listRegions() -> ClusterListRegionsResponse

Storage

Types:

• ClusterStorage
• StorageListResponse
• StorageDeleteResponse

Methods:

• client.beta.clusters.storage.create({ ...params }) -> ClusterStorage
• client.beta.clusters.storage.retrieve(volumeID) -> ClusterStorage
• client.beta.clusters.storage.update({ ...params }) -> ClusterStorage
• client.beta.clusters.storage.list() -> StorageListResponse
• client.beta.clusters.storage.delete(volumeID) -> StorageDeleteResponse

Chat

Completions

Types:

• ChatCompletion
• ChatCompletionAssistantMessageParam
• ChatCompletionChunk
• ChatCompletionPrompt
• ChatCompletionFunctionMessageParam
• ChatCompletionMessage
• ChatCompletionMessageParam
• ChatCompletionSystemMessageParam
• ChatCompletionTool
• ChatCompletionToolMessageParam
• ChatCompletionStructuredMessageImageURL
• ChatCompletionStructuredMessageText
• ChatCompletionStructuredMessageVideoURL
• ChatCompletionUsage
• ChatCompletionWarning

Methods:

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

Completions

Types:

• Completion
• CompletionChunk
• LogProbs
• ToolChoice
• Tools

Methods:

• client.completions.create({ ...params }) -> Completion

Embeddings

Types:

• Embedding

Methods:

• client.embeddings.create({ ...params }) -> Embedding

Files

Types:

• FileList
• FilePurpose
• FileResponse
• FileType
• FileDeleteResponse

Methods:

• client.files.retrieve(id) -> FileResponse
• client.files.list() -> FileList
• client.files.delete(id) -> FileDeleteResponse
• client.files.content(id) -> Response
• client.files.upload({ ...params }) -> FileResponse

FineTuning

Types:

• FinetuneEvent
• FinetuneEventType
• FinetuneResponse
• FineTuningCreateResponse
• FineTuningListResponse
• FineTuningDeleteResponse
• FineTuningCancelResponse
• FineTuningEstimatePriceResponse
• FineTuningListCheckpointsResponse
• FineTuningListEventsResponse

Methods:

• client.fineTuning.create({ ...params }) -> FineTuningCreateResponse
• client.fineTuning.retrieve(id) -> FinetuneResponse
• client.fineTuning.list() -> FineTuningListResponse
• client.fineTuning.delete(id, { ...params }) -> FineTuningDeleteResponse
• client.fineTuning.cancel(id) -> FineTuningCancelResponse
• client.fineTuning.content({ ...params }) -> Response
• client.fineTuning.estimatePrice({ ...params }) -> FineTuningEstimatePriceResponse
• client.fineTuning.listCheckpoints(id) -> FineTuningListCheckpointsResponse
• client.fineTuning.listEvents(id) -> FineTuningListEventsResponse

CodeInterpreter

Types:

• ExecuteResponse

Methods:

• client.codeInterpreter.execute({ ...params }) -> ExecuteResponse

Sessions

Types:

• SessionListResponse

Methods:

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

Images

Types:

• ImageDataB64
• ImageDataURL
• ImageFile

Methods:

• client.images.generate({ ...params }) -> ImageFile

Videos

Types:

• VideoJob

Methods:

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

Audio

Types:

• AudioFile
• AudioSpeechStreamChunk

Speech

Methods:

• client.audio.speech.create({ ...params }) -> Response

Voices

Types:

• VoiceListResponse

Methods:

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

Transcriptions

Types:

• TranscriptionCreateResponse

Methods:

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

Translations

Types:

• TranslationCreateResponse

Methods:

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

Models

Types:

• ModelObject
• ModelListResponse
• ModelUploadResponse

Methods:

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

Uploads

Types:

• UploadStatusResponse

Methods:

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

Endpoints

Types:

• Autoscaling
• DedicatedEndpoint
• EndpointListResponse
• EndpointListAvzonesResponse
• EndpointListHardwareResponse

Methods:

• client.endpoints.create({ ...params }) -> DedicatedEndpoint
• client.endpoints.retrieve(endpointID) -> DedicatedEndpoint
• client.endpoints.update(endpointID, { ...params }) -> DedicatedEndpoint
• client.endpoints.list({ ...params }) -> EndpointListResponse
• client.endpoints.delete(endpointID) -> void
• client.endpoints.listAvzones() -> EndpointListAvzonesResponse
• client.endpoints.listHardware({ ...params }) -> EndpointListHardwareResponse

Rerank

Types:

• RerankCreateResponse

Methods:

• client.rerank.create({ ...params }) -> RerankCreateResponse

Batches

Types:

• 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:

• 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