api.md

Shared Types

from groq.types import ErrorObject, FunctionDefinition, FunctionParameters

Completions

Types:

from groq.types import CompletionUsage

Chat

Completions

Types:

from groq.types.chat import (
    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:

from groq.types import CreateEmbeddingResponse, Embedding

Methods:

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

Audio

Speech

Methods:

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

Transcriptions

Types:

from groq.types.audio import Transcription

Methods:

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

Translations

Types:

from groq.types.audio import Translation

Methods:

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

Models

Types:

from groq.types import Model, ModelDeleted, ModelListResponse

Methods:

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

Batches

Types:

from groq.types import (
    BatchCreateResponse,
    BatchRetrieveResponse,
    BatchListResponse,
    BatchCancelResponse,
)

Methods:

• client.batches.create(**params) -> BatchCreateResponse
• client.batches.retrieve(batch_id) -> BatchRetrieveResponse
• client.batches.list() -> BatchListResponse
• client.batches.cancel(batch_id) -> BatchCancelResponse

Files

Types:

from groq.types import FileCreateResponse, FileListResponse, FileDeleteResponse, FileInfoResponse

Methods:

• client.files.create(**params) -> FileCreateResponse
• client.files.list() -> FileListResponse
• client.files.delete(file_id) -> FileDeleteResponse
• client.files.content(file_id) -> BinaryAPIResponse
• client.files.info(file_id) -> FileInfoResponse