api.md

Shared

Types:

• ErrorObject
• FunctionDefinition
• FunctionParameters

Completions

Types:

• CompletionUsage

Chat

Completions

Types:

• ChatCompletion
• ChatCompletionAssistantMessageParam
• ChatCompletionChunk
• ChatCompletionContentPart
• ChatCompletionContentPartImage
• ChatCompletionContentPartText
• ChatCompletionFunctionCallOption
• ChatCompletionFunctionMessageParam
• ChatCompletionMessage
• ChatCompletionMessageParam
• ChatCompletionMessageToolCall
• ChatCompletionNamedToolChoice
• ChatCompletionRole
• ChatCompletionSystemMessageParam
• ChatCompletionTokenLogprob
• ChatCompletionTool
• ChatCompletionToolChoiceOption
• ChatCompletionToolMessageParam
• ChatCompletionUserMessageParam

Methods:

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

Embeddings

Types:

• CreateEmbeddingResponse
• Embedding

Methods:

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

Audio

Speech

Methods:

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

Transcriptions

Types:

• Transcription

Methods:

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

Translations

Types:

• Translation

Methods:

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

Models

Types:

• Model
• ModelDeleted
• ModelListResponse

Methods:

• client.models.retrieve(model) -> Model
• client.models.list() -> ModelListResponse
• client.models.delete(model) -> ModelDeleted

Batches

Types:

• BatchCreateResponse
• BatchRetrieveResponse
• BatchListResponse
• BatchCancelResponse

Methods:

• client.batches.create({ ...params }) -> BatchCreateResponse
• client.batches.retrieve(batchID) -> BatchRetrieveResponse
• client.batches.list() -> BatchListResponse
• client.batches.cancel(batchID) -> BatchCancelResponse

Files

Types:

• FileCreateResponse
• FileListResponse
• FileDeleteResponse
• FileInfoResponse

Methods:

• client.files.create({ ...params }) -> FileCreateResponse
• client.files.list() -> FileListResponse
• client.files.delete(fileID) -> FileDeleteResponse
• client.files.content(fileID) -> Response
• client.files.info(fileID) -> FileInfoResponse