API reference
Stateless functions
Operation helpers that create a provider client for a single call.
completion(params)
function completion(params: DirectCompletionParams & { stream?: false }): Promise<ChatCompletion>;
function completion(
params: DirectCompletionParams & { stream: true },
): Promise<AsyncIterable<ChatCompletionChunk>>;responses(params)
function responses(params: DirectResponsesParams & { stream?: false }): Promise<Response>;
function responses(
params: DirectResponsesParams & { stream: true },
): Promise<AsyncIterable<ResponseStreamEvent>>;Other operations
function embedding(params: DirectEmbeddingParams): Promise<EmbeddingResponse>;
function listModels(params: DirectProviderOptions & { provider: string }): Promise<Model[]>;
function imageGeneration(params: DirectImageGenerationParams): Promise<ImageGenerationResponse>;
function transcription(params: DirectTranscriptionParams): Promise<Transcription>;
function speech(params: DirectSpeechParams): Promise<Uint8Array>;
function moderation(params: DirectModerationParams): Promise<ModerationResponse>;
function messages(params: DirectMessagesParams): Promise<MessageResponse>;
function rerank(params: DirectRerankParams): Promise<RerankResponse>;
function createBatch(params: DirectCreateBatchParams): Promise<Batch>;
function retrieveBatch(params: DirectBatchParams): Promise<Batch>;
function cancelBatch(params: DirectBatchParams): Promise<Batch>;
function listBatches(params: DirectListBatchesParams): Promise<Batch[]>;
function retrieveBatchResults(params: DirectBatchParams): Promise<BatchResult>;
function uploadFile(params: DirectUploadFileParams): Promise<FileMetadata>;
function listFiles(params: DirectListFilesParams): Promise<FilePage>;
function retrieveFile(params: DirectFileResourceParams): Promise<FileMetadata>;
function deleteFile(params: DirectFileResourceParams): Promise<FileDeleted>;
function downloadFile(params: DirectDownloadFileParams): Promise<FileDownload>;Direct provider options
Stateless operation parameters extend the operation's common parameter type with:
Prop
Type
For model-based operations, omit provider only when model uses provider:model syntax.
listModels() has no model from which to infer a provider, so its provider field is required.
moderation() is the exception: it defaults to openai when the provider is omitted.