Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mistralai/client-ts

TS Client library for Mistral AI platform
https://github.com/mistralai/client-ts

Last synced: 19 days ago
JSON representation

TS Client library for Mistral AI platform

Awesome Lists containing this project

README 

          
# Mistral Typescript Client



> **This is v2 of the Mistral TypeScript SDK.**

>

> Key changes from v1: **ESM-only**, shorter type names, forward-compatible enums/unions, Zod v4.

> See the **[Migration Guide](https://github.com/mistralai/client-ts/blob/main/MIGRATION.md)** for full details.

>

> To pin v1: `npm install @mistralai/mistralai@^1` · **[v1 documentation and source](https://github.com/mistralai/client-ts/tree/v1)**



## Summary



Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create your account on [La Plateforme](https://console.mistral.ai) to get access and read the [docs](https://docs.mistral.ai) to learn how to use it.



## Table of Contents



* [Mistral Typescript Client](#mistral-typescript-client)

  * [SDK Installation](#sdk-installation)

  * [Requirements](#requirements)

  * [API Key Setup](#api-key-setup)

  * [SDK Example Usage](#sdk-example-usage)

  * [Providers' SDKs](#providers-sdks)

  * [Available Resources and Operations](#available-resources-and-operations)

  * [Server-sent event streaming](#server-sent-event-streaming)

  * [Pagination](#pagination)

  * [File uploads](#file-uploads)

  * [Retries](#retries)

  * [Error Handling](#error-handling)

  * [Server Selection](#server-selection)

  * [Custom HTTP Client](#custom-http-client)

  * [Authentication](#authentication)

  * [Standalone functions](#standalone-functions)

  * [Debugging](#debugging)

* [Development](#development)

  * [Contributions](#contributions)



## SDK Installation



The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.



### NPM



```bash

npm add @mistralai/mistralai

```



### PNPM



```bash

pnpm add @mistralai/mistralai

```



### Bun



```bash

bun add @mistralai/mistralai

```



### Yarn



```bash

yarn add @mistralai/mistralai

```



> [!NOTE]

> This package is published as an ES Module (ESM) only. For applications using

> CommonJS, use `await import("@mistralai/mistralai")` to import and use this package.



## Requirements



For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).



## API Key Setup



Before you begin, you will need a Mistral AI API key.



1. Get your own Mistral API Key: 

2. Set your Mistral API Key as an environment variable. You only need to do this once.



```bash

# set Mistral API Key (using zsh for example)

$ echo 'export MISTRAL_API_KEY=[your_key_here]' >> ~/.zshenv



# reload the environment (or just quit and open a new terminal)

$ source ~/.zshenv

```



## SDK Example Usage



### Create Chat Completions



This example shows how to create chat completions.



```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.chat.complete({

    model: "mistral-large-latest",

    messages: [

      {

        role: "user",

        content:

          "Who is the best French painter? Answer in one short sentence.",

      },

    ],

    responseFormat: {

      type: "text",

    },

  });



  console.log(result);

}



run();



```



### Upload a file



This example shows how to upload a file.



```typescript

import { Mistral } from "@mistralai/mistralai";

import { openAsBlob } from "node:fs";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.files.upload({

    file: await openAsBlob("example.file"),

  });



  console.log(result);

}



run();



```



### Create Agents Completions



This example shows how to create agents completions.



```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.agents.complete({

    messages: [

      {

        role: "user",

        content:

          "Who is the best French painter? Answer in one short sentence.",

      },

    ],

    responseFormat: {

      type: "text",

    },

    agentId: "",

  });



  console.log(result);

}



run();



```



### Create Embedding Request



This example shows how to create embedding request.



```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.embeddings.create({

    model: "mistral-embed",

    inputs: [

      "Embed this sentence.",

      "As well as this one.",

    ],

  });



  console.log(result);

}



run();



```



## Providers' SDKs



We have dedicated SDKs for the following providers:



- [GCP](https://github.com/mistralai/client-ts/tree/main/packages/mistralai-gcp)

- [Azure](https://github.com/mistralai/client-ts/tree/main/packages/mistralai-azure)



## Available Resources and Operations



Available methods



### [Agents](docs/sdks/agents/README.md)



* [complete](docs/sdks/agents/README.md#complete) - Agents Completion

* [stream](docs/sdks/agents/README.md#stream) - Stream Agents completion



### [Audio.Speech](docs/sdks/speech/README.md)



* [complete](docs/sdks/speech/README.md#complete) - Speech



### [Audio.Transcriptions](docs/sdks/transcriptions/README.md)



* [complete](docs/sdks/transcriptions/README.md#complete) - Create Transcription

* [stream](docs/sdks/transcriptions/README.md#stream) - Create Streaming Transcription (SSE)



### [Audio.Voices](docs/sdks/voices/README.md)



* [list](docs/sdks/voices/README.md#list) - List all voices

* [create](docs/sdks/voices/README.md#create) - Create a new voice

* [delete](docs/sdks/voices/README.md#delete) - Delete a custom voice

* [update](docs/sdks/voices/README.md#update) - Update voice metadata

* [get](docs/sdks/voices/README.md#get) - Get voice details

* [getSampleAudio](docs/sdks/voices/README.md#getsampleaudio) - Get voice sample audio



### [Batch.Jobs](docs/sdks/batchjobs/README.md)



* [list](docs/sdks/batchjobs/README.md#list) - Get Batch Jobs

* [create](docs/sdks/batchjobs/README.md#create) - Create Batch Job

* [get](docs/sdks/batchjobs/README.md#get) - Get Batch Job

* [delete](docs/sdks/batchjobs/README.md#delete) - Delete Batch Job

* [cancel](docs/sdks/batchjobs/README.md#cancel) - Cancel Batch Job



### [Beta.Agents](docs/sdks/betaagents/README.md)



* [create](docs/sdks/betaagents/README.md#create) - Create a agent that can be used within a conversation.

* [list](docs/sdks/betaagents/README.md#list) - List agent entities.

* [get](docs/sdks/betaagents/README.md#get) - Retrieve an agent entity.

* [update](docs/sdks/betaagents/README.md#update) - Update an agent entity.

* [delete](docs/sdks/betaagents/README.md#delete) - Delete an agent entity.

* [updateVersion](docs/sdks/betaagents/README.md#updateversion) - Update an agent version.

* [listVersions](docs/sdks/betaagents/README.md#listversions) - List all versions of an agent.

* [getVersion](docs/sdks/betaagents/README.md#getversion) - Retrieve a specific version of an agent.

* [createVersionAlias](docs/sdks/betaagents/README.md#createversionalias) - Create or update an agent version alias.

* [listVersionAliases](docs/sdks/betaagents/README.md#listversionaliases) - List all aliases for an agent.

* [deleteVersionAlias](docs/sdks/betaagents/README.md#deleteversionalias) - Delete an agent version alias.



### [Beta.Connectors](docs/sdks/connectors/README.md)



* [create](docs/sdks/connectors/README.md#create) - Create a new connector.

* [list](docs/sdks/connectors/README.md#list) - List all connectors.

* [getAuthUrl](docs/sdks/connectors/README.md#getauthurl) - Get the auth URL for a connector.

* [callTool](docs/sdks/connectors/README.md#calltool) - Call Connector Tool

* [listTools](docs/sdks/connectors/README.md#listtools) - List tools for a connector.

* [get](docs/sdks/connectors/README.md#get) - Get a connector.

* [update](docs/sdks/connectors/README.md#update) - Update a connector.

* [delete](docs/sdks/connectors/README.md#delete) - Delete a connector.



### [Beta.Conversations](docs/sdks/conversations/README.md)



* [start](docs/sdks/conversations/README.md#start) - Create a conversation and append entries to it.

* [list](docs/sdks/conversations/README.md#list) - List all created conversations.

* [get](docs/sdks/conversations/README.md#get) - Retrieve a conversation information.

* [delete](docs/sdks/conversations/README.md#delete) - Delete a conversation.

* [append](docs/sdks/conversations/README.md#append) - Append new entries to an existing conversation.

* [getHistory](docs/sdks/conversations/README.md#gethistory) - Retrieve all entries in a conversation.

* [getMessages](docs/sdks/conversations/README.md#getmessages) - Retrieve all messages in a conversation.

* [restart](docs/sdks/conversations/README.md#restart) - Restart a conversation starting from a given entry.

* [startStream](docs/sdks/conversations/README.md#startstream) - Create a conversation and append entries to it.

* [appendStream](docs/sdks/conversations/README.md#appendstream) - Append new entries to an existing conversation.

* [restartStream](docs/sdks/conversations/README.md#restartstream) - Restart a conversation starting from a given entry.



### [Beta.Libraries](docs/sdks/libraries/README.md)



* [list](docs/sdks/libraries/README.md#list) - List all libraries you have access to.

* [create](docs/sdks/libraries/README.md#create) - Create a new Library.

* [get](docs/sdks/libraries/README.md#get) - Detailed information about a specific Library.

* [delete](docs/sdks/libraries/README.md#delete) - Delete a library and all of it's document.

* [update](docs/sdks/libraries/README.md#update) - Update a library.



#### [Beta.Libraries.Accesses](docs/sdks/accesses/README.md)



* [list](docs/sdks/accesses/README.md#list) - List all of the access to this library.

* [updateOrCreate](docs/sdks/accesses/README.md#updateorcreate) - Create or update an access level.

* [delete](docs/sdks/accesses/README.md#delete) - Delete an access level.



#### [Beta.Libraries.Documents](docs/sdks/documents/README.md)



* [list](docs/sdks/documents/README.md#list) - List documents in a given library.

* [upload](docs/sdks/documents/README.md#upload) - Upload a new document.

* [get](docs/sdks/documents/README.md#get) - Retrieve the metadata of a specific document.

* [update](docs/sdks/documents/README.md#update) - Update the metadata of a specific document.

* [delete](docs/sdks/documents/README.md#delete) - Delete a document.

* [textContent](docs/sdks/documents/README.md#textcontent) - Retrieve the text content of a specific document.

* [status](docs/sdks/documents/README.md#status) - Retrieve the processing status of a specific document.

* [getSignedUrl](docs/sdks/documents/README.md#getsignedurl) - Retrieve the signed URL of a specific document.

* [extractedTextSignedUrl](docs/sdks/documents/README.md#extractedtextsignedurl) - Retrieve the signed URL of text extracted from a given document.

* [reprocess](docs/sdks/documents/README.md#reprocess) - Reprocess a document.



### [Beta.Observability.Campaigns](docs/sdks/campaigns/README.md)



* [create](docs/sdks/campaigns/README.md#create) - Create and start a new campaign

* [list](docs/sdks/campaigns/README.md#list) - Get all campaigns

* [fetch](docs/sdks/campaigns/README.md#fetch) - Get campaign by id

* [delete](docs/sdks/campaigns/README.md#delete) - Delete a campaign

* [fetchStatus](docs/sdks/campaigns/README.md#fetchstatus) - Get campaign status by campaign id

* [listEvents](docs/sdks/campaigns/README.md#listevents) - Get event ids that were selected by the given campaign



### [Beta.Observability.ChatCompletionEvents](docs/sdks/chatcompletionevents/README.md)



* [search](docs/sdks/chatcompletionevents/README.md#search) - Get Chat Completion Events

* [searchIds](docs/sdks/chatcompletionevents/README.md#searchids) - Alternative to /search that returns only the IDs and that can return many IDs at once

* [fetch](docs/sdks/chatcompletionevents/README.md#fetch) - Get Chat Completion Event

* [fetchSimilarEvents](docs/sdks/chatcompletionevents/README.md#fetchsimilarevents) - Get Similar Chat Completion Events

* [judge](docs/sdks/chatcompletionevents/README.md#judge) - Run Judge on an event based on the given options



#### [Beta.Observability.ChatCompletionEvents.Fields](docs/sdks/fields/README.md)



* [list](docs/sdks/fields/README.md#list) - Get Chat Completion Fields

* [fetchOptions](docs/sdks/fields/README.md#fetchoptions) - Get Chat Completion Field Options

* [fetchOptionCounts](docs/sdks/fields/README.md#fetchoptioncounts) - Get Chat Completion Field Options Counts



### [Beta.Observability.Datasets](docs/sdks/datasets/README.md)



* [create](docs/sdks/datasets/README.md#create) - Create a new empty dataset

* [list](docs/sdks/datasets/README.md#list) - List existing datasets

* [fetch](docs/sdks/datasets/README.md#fetch) - Get dataset by id

* [delete](docs/sdks/datasets/README.md#delete) - Delete a dataset

* [update](docs/sdks/datasets/README.md#update) - Patch dataset

* [listRecords](docs/sdks/datasets/README.md#listrecords) - List existing records in the dataset

* [createRecord](docs/sdks/datasets/README.md#createrecord) - Add a conversation to the dataset

* [importFromCampaign](docs/sdks/datasets/README.md#importfromcampaign) - Populate the dataset with a campaign

* [importFromExplorer](docs/sdks/datasets/README.md#importfromexplorer) - Populate the dataset with samples from the explorer

* [importFromFile](docs/sdks/datasets/README.md#importfromfile) - Populate the dataset with samples from an uploaded file

* [importFromPlayground](docs/sdks/datasets/README.md#importfromplayground) - Populate the dataset with samples from the playground

* [importFromDatasetRecords](docs/sdks/datasets/README.md#importfromdatasetrecords) - Populate the dataset with samples from another dataset

* [exportToJsonl](docs/sdks/datasets/README.md#exporttojsonl) - Export to the Files API and retrieve presigned URL to download the resulting JSONL file

* [fetchTask](docs/sdks/datasets/README.md#fetchtask) - Get status of a dataset import task

* [listTasks](docs/sdks/datasets/README.md#listtasks) - List import tasks for the given dataset



#### [Beta.Observability.Datasets.Records](docs/sdks/records/README.md)



* [fetch](docs/sdks/records/README.md#fetch) - Get the content of a given conversation from a dataset

* [delete](docs/sdks/records/README.md#delete) - Delete a record from a dataset

* [bulkDelete](docs/sdks/records/README.md#bulkdelete) - Delete multiple records from datasets

* [judge](docs/sdks/records/README.md#judge) - Run Judge on a dataset record based on the given options

* [updatePayload](docs/sdks/records/README.md#updatepayload) - Update a dataset record conversation payload

* [updateProperties](docs/sdks/records/README.md#updateproperties) - Update conversation properties



### [Beta.Observability.Judges](docs/sdks/judges/README.md)



* [create](docs/sdks/judges/README.md#create) - Create a new judge

* [list](docs/sdks/judges/README.md#list) - Get judges with optional filtering and search

* [fetch](docs/sdks/judges/README.md#fetch) - Get judge by id

* [delete](docs/sdks/judges/README.md#delete) - Delete a judge

* [update](docs/sdks/judges/README.md#update) - Update a judge

* [judgeConversation](docs/sdks/judges/README.md#judgeconversation) - Run a saved judge on a conversation



### [Chat](docs/sdks/chat/README.md)



* [complete](docs/sdks/chat/README.md#complete) - Chat Completion

* [stream](docs/sdks/chat/README.md#stream) - Stream chat completion



### [Classifiers](docs/sdks/classifiers/README.md)



* [moderate](docs/sdks/classifiers/README.md#moderate) - Moderations

* [moderateChat](docs/sdks/classifiers/README.md#moderatechat) - Chat Moderations

* [classify](docs/sdks/classifiers/README.md#classify) - Classifications

* [classifyChat](docs/sdks/classifiers/README.md#classifychat) - Chat Classifications



### [Embeddings](docs/sdks/embeddings/README.md)



* [create](docs/sdks/embeddings/README.md#create) - Embeddings



### [Events](docs/sdks/events/README.md)



* [getStreamEvents](docs/sdks/events/README.md#getstreamevents) - Get Stream Events

* [getWorkflowEvents](docs/sdks/events/README.md#getworkflowevents) - Get Workflow Events



### [Files](docs/sdks/files/README.md)



* [upload](docs/sdks/files/README.md#upload) - Upload File

* [list](docs/sdks/files/README.md#list) - List Files

* [retrieve](docs/sdks/files/README.md#retrieve) - Retrieve File

* [delete](docs/sdks/files/README.md#delete) - Delete File

* [download](docs/sdks/files/README.md#download) - Download File

* [getSignedUrl](docs/sdks/files/README.md#getsignedurl) - Get Signed Url



### [Fim](docs/sdks/fim/README.md)



* [complete](docs/sdks/fim/README.md#complete) - Fim Completion

* [stream](docs/sdks/fim/README.md#stream) - Stream fim completion



### [FineTuning.Jobs](docs/sdks/finetuningjobs/README.md)



* [list](docs/sdks/finetuningjobs/README.md#list) - Get Fine Tuning Jobs

* [create](docs/sdks/finetuningjobs/README.md#create) - Create Fine Tuning Job

* [get](docs/sdks/finetuningjobs/README.md#get) - Get Fine Tuning Job

* [cancel](docs/sdks/finetuningjobs/README.md#cancel) - Cancel Fine Tuning Job

* [start](docs/sdks/finetuningjobs/README.md#start) - Start Fine Tuning Job



### [Models](docs/sdks/models/README.md)



* [list](docs/sdks/models/README.md#list) - List Models

* [retrieve](docs/sdks/models/README.md#retrieve) - Retrieve Model

* [delete](docs/sdks/models/README.md#delete) - Delete Model

* [update](docs/sdks/models/README.md#update) - Update Fine Tuned Model

* [archive](docs/sdks/models/README.md#archive) - Archive Fine Tuned Model

* [unarchive](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model



### [Ocr](docs/sdks/ocr/README.md)



* [process](docs/sdks/ocr/README.md#process) - OCR



### [Workflows](docs/sdks/workflows/README.md)



* [getWorkflows](docs/sdks/workflows/README.md#getworkflows) - Get Workflows

* [getWorkflowRegistrations](docs/sdks/workflows/README.md#getworkflowregistrations) - Get Workflow Registrations

* [executeWorkflow](docs/sdks/workflows/README.md#executeworkflow) - Execute Workflow

* [~~executeWorkflowRegistration~~](docs/sdks/workflows/README.md#executeworkflowregistration) - Execute Workflow Registration :warning: **Deprecated**

* [getWorkflow](docs/sdks/workflows/README.md#getworkflow) - Get Workflow

* [updateWorkflow](docs/sdks/workflows/README.md#updateworkflow) - Update Workflow

* [getWorkflowRegistration](docs/sdks/workflows/README.md#getworkflowregistration) - Get Workflow Registration

* [archiveWorkflow](docs/sdks/workflows/README.md#archiveworkflow) - Archive Workflow

* [unarchiveWorkflow](docs/sdks/workflows/README.md#unarchiveworkflow) - Unarchive Workflow



#### [Workflows.Deployments](docs/sdks/deployments/README.md)



* [listDeployments](docs/sdks/deployments/README.md#listdeployments) - List Deployments

* [getDeployment](docs/sdks/deployments/README.md#getdeployment) - Get Deployment



#### [Workflows.Events](docs/sdks/workflowsevents/README.md)



* [getStreamEvents](docs/sdks/workflowsevents/README.md#getstreamevents) - Get Stream Events

* [getWorkflowEvents](docs/sdks/workflowsevents/README.md#getworkflowevents) - Get Workflow Events



#### [Workflows.Executions](docs/sdks/executions/README.md)



* [getWorkflowExecution](docs/sdks/executions/README.md#getworkflowexecution) - Get Workflow Execution

* [getWorkflowExecutionHistory](docs/sdks/executions/README.md#getworkflowexecutionhistory) - Get Workflow Execution History

* [signalWorkflowExecution](docs/sdks/executions/README.md#signalworkflowexecution) - Signal Workflow Execution

* [queryWorkflowExecution](docs/sdks/executions/README.md#queryworkflowexecution) - Query Workflow Execution

* [terminateWorkflowExecution](docs/sdks/executions/README.md#terminateworkflowexecution) - Terminate Workflow Execution

* [batchTerminateWorkflowExecutions](docs/sdks/executions/README.md#batchterminateworkflowexecutions) - Batch Terminate Workflow Executions

* [cancelWorkflowExecution](docs/sdks/executions/README.md#cancelworkflowexecution) - Cancel Workflow Execution

* [batchCancelWorkflowExecutions](docs/sdks/executions/README.md#batchcancelworkflowexecutions) - Batch Cancel Workflow Executions

* [resetWorkflow](docs/sdks/executions/README.md#resetworkflow) - Reset Workflow

* [updateWorkflowExecution](docs/sdks/executions/README.md#updateworkflowexecution) - Update Workflow Execution

* [getWorkflowExecutionTraceOtel](docs/sdks/executions/README.md#getworkflowexecutiontraceotel) - Get Workflow Execution Trace Otel

* [getWorkflowExecutionTraceSummary](docs/sdks/executions/README.md#getworkflowexecutiontracesummary) - Get Workflow Execution Trace Summary

* [getWorkflowExecutionTraceEvents](docs/sdks/executions/README.md#getworkflowexecutiontraceevents) - Get Workflow Execution Trace Events

* [stream](docs/sdks/executions/README.md#stream) - Stream



#### [Workflows.Metrics](docs/sdks/metrics/README.md)



* [getWorkflowMetrics](docs/sdks/metrics/README.md#getworkflowmetrics) - Get Workflow Metrics



#### [Workflows.Runs](docs/sdks/runs/README.md)



* [listRuns](docs/sdks/runs/README.md#listruns) - List Runs

* [getRun](docs/sdks/runs/README.md#getrun) - Get Run

* [getRunHistory](docs/sdks/runs/README.md#getrunhistory) - Get Run History



#### [Workflows.Schedules](docs/sdks/schedules/README.md)



* [getSchedules](docs/sdks/schedules/README.md#getschedules) - Get Schedules

* [scheduleWorkflow](docs/sdks/schedules/README.md#scheduleworkflow) - Schedule Workflow

* [unscheduleWorkflow](docs/sdks/schedules/README.md#unscheduleworkflow) - Unschedule Workflow



## Server-sent event streaming



[Server-sent events][mdn-sse] are used to stream content from certain

operations. These operations will expose the stream as an async iterable that

can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will

terminate when the server no longer has any events to send and closes the

underlying connection.



```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.audio.speech.complete({

    input: "",

  });



  console.log(result);

}



run();



```



[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events

[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of



## Pagination



Some of the endpoints in this SDK support pagination. To use pagination, you

make your SDK calls as usual, but the returned response object will also be an

async iterable that can be consumed using the [`for await...of`][for-await-of]

syntax.



[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of



Here's an example of one such pagination call:



```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.workflows.getWorkflows({});



  for await (const page of result) {

    console.log(page);

  }

}



run();



```



## File uploads



Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.



> [!TIP]

>

> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

>

> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).

> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.

> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `` element.

> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).



```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.audio.transcriptions.complete({

    model: "voxtral-mini-latest",

  });



  console.log(result);

}



run();



```



## Retries



Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.



To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.audio.speech.complete({

    input: "",

  }, {

    retries: {

      strategy: "backoff",

      backoff: {

        initialInterval: 1,

        maxInterval: 50,

        exponent: 1.1,

        maxElapsedTime: 100,

      },

      retryConnectionErrors: false,

    },

  });



  console.log(result);

}



run();



```



If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  retryConfig: {

    strategy: "backoff",

    backoff: {

      initialInterval: 1,

      maxInterval: 50,

      exponent: 1.1,

      maxElapsedTime: 100,

    },

    retryConnectionErrors: false,

  },

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.audio.speech.complete({

    input: "",

  });



  console.log(result);

}



run();



```



## Error Handling



[`MistralError`](./src/models/errors/mistralerror.ts) is the base class for all HTTP error responses. It has the following properties:



| Property            | Type       | Description                                                                             |

| ------------------- | ---------- | --------------------------------------------------------------------------------------- |

| `error.message`     | `string`   | Error message                                                                           |

| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |

| `error.headers`     | `Headers`  | HTTP response headers                                                                   |

| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |

| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |

| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |



### Example

```typescript

import { Mistral } from "@mistralai/mistralai";

import * as errors from "@mistralai/mistralai/models/errors";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  try {

    const result = await mistral.audio.speech.complete({

      input: "",

    });



    console.log(result);

  } catch (error) {

    // The base class for HTTP error responses

    if (error instanceof errors.MistralError) {

      console.log(error.message);

      console.log(error.statusCode);

      console.log(error.body);

      console.log(error.headers);



      // Depending on the method different errors may be thrown

      if (error instanceof errors.HTTPValidationError) {

        console.log(error.data$.detail); // ValidationError[]

      }

    }

  }

}



run();



```



### Error Classes

**Primary error:**

* [`MistralError`](./src/models/errors/mistralerror.ts): The base class for HTTP error responses.



Less common errors (8)







**Network errors:**

* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.

* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.

* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.

* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.

* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.



**Inherit from [`MistralError`](./src/models/errors/mistralerror.ts)**:

* [`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. Applicable to 103 of 168 methods.*

* [`ObservabilityError`](./src/models/errors/observabilityerror.ts): Bad Request - Invalid request parameters or data. Applicable to 41 of 168 methods.*

* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.



\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.



## Server Selection



### Select Server by Name



You can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:



| Name | Server                   | Description          |

| ---- | ------------------------ | -------------------- |

| `eu` | `https://api.mistral.ai` | EU Production server |



#### Example



```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  server: "eu",

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.audio.speech.complete({

    input: "",

  });



  console.log(result);

}



run();



```



### Override Server URL Per-Client



The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:

```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  serverURL: "https://api.mistral.ai",

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.audio.speech.complete({

    input: "",

  });



  console.log(result);

}



run();



```



## Custom HTTP Client



The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native

[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This

client is a thin wrapper around `fetch` and provides the ability to attach hooks

around the request lifecycle that can be used to modify the request or handle

errors and response.



The `HTTPClient` constructor takes an optional `fetcher` argument that can be

used to integrate a third-party HTTP client or when writing tests to mock out

the HTTP client and feed in fixtures.



The following example shows how to:

- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent

- use the `"beforeRequest"` hook to add a custom header and a timeout to requests

- use the `"requestError"` hook to log errors



```typescript

import { Mistral } from "@mistralai/mistralai";

import { ProxyAgent } from "undici";

import { HTTPClient } from "@mistralai/mistralai/lib/http";



const dispatcher = new ProxyAgent("http://proxy.example.com:8080");



const httpClient = new HTTPClient({

  // 'fetcher' takes a function that has the same signature as native 'fetch'.

  fetcher: (input, init) =>

    // 'dispatcher' is specific to undici and not part of the standard Fetch API.

    fetch(input, { ...init, dispatcher } as RequestInit),

});



httpClient.addHook("beforeRequest", (request) => {

  const nextRequest = new Request(request, {

    signal: request.signal || AbortSignal.timeout(5000)

  });



  nextRequest.headers.set("x-custom-header", "custom value");



  return nextRequest;

});



httpClient.addHook("requestError", (error, request) => {

  console.group("Request Error");

  console.log("Reason:", `${error}`);

  console.log("Endpoint:", `${request.method} ${request.url}`);

  console.groupEnd();

});



const sdk = new Mistral({ httpClient: httpClient });

```



## Authentication



### Per-Client Security Schemes



This SDK supports the following security scheme globally:



| Name     | Type | Scheme      | Environment Variable |

| -------- | ---- | ----------- | -------------------- |

| `apiKey` | http | HTTP Bearer | `MISTRAL_API_KEY`    |



To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:

```typescript

import { Mistral } from "@mistralai/mistralai";



const mistral = new Mistral({

  apiKey: process.env["MISTRAL_API_KEY"] ?? "",

});



async function run() {

  const result = await mistral.audio.speech.complete({

    input: "",

  });



  console.log(result);

}



run();



```



## Standalone functions



All the methods listed above are available as standalone functions. These

functions are ideal for use in applications running in the browser, serverless

runtimes or other environments where application bundle size is a primary

concern. When using a bundler to build your application, all unused

functionality will be either excluded from the final bundle or tree-shaken away.



To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).



Available standalone functions



- [`agentsComplete`](docs/sdks/agents/README.md#complete) - Agents Completion

- [`agentsStream`](docs/sdks/agents/README.md#stream) - Stream Agents completion

- [`audioSpeechComplete`](docs/sdks/speech/README.md#complete) - Speech

- [`audioTranscriptionsComplete`](docs/sdks/transcriptions/README.md#complete) - Create Transcription

- [`audioTranscriptionsStream`](docs/sdks/transcriptions/README.md#stream) - Create Streaming Transcription (SSE)

- [`audioVoicesCreate`](docs/sdks/voices/README.md#create) - Create a new voice

- [`audioVoicesDelete`](docs/sdks/voices/README.md#delete) - Delete a custom voice

- [`audioVoicesGet`](docs/sdks/voices/README.md#get) - Get voice details

- [`audioVoicesGetSampleAudio`](docs/sdks/voices/README.md#getsampleaudio) - Get voice sample audio

- [`audioVoicesList`](docs/sdks/voices/README.md#list) - List all voices

- [`audioVoicesUpdate`](docs/sdks/voices/README.md#update) - Update voice metadata

- [`batchJobsCancel`](docs/sdks/batchjobs/README.md#cancel) - Cancel Batch Job

- [`batchJobsCreate`](docs/sdks/batchjobs/README.md#create) - Create Batch Job

- [`batchJobsDelete`](docs/sdks/batchjobs/README.md#delete) - Delete Batch Job

- [`batchJobsGet`](docs/sdks/batchjobs/README.md#get) - Get Batch Job

- [`batchJobsList`](docs/sdks/batchjobs/README.md#list) - Get Batch Jobs

- [`betaAgentsCreate`](docs/sdks/betaagents/README.md#create) - Create a agent that can be used within a conversation.

- [`betaAgentsCreateVersionAlias`](docs/sdks/betaagents/README.md#createversionalias) - Create or update an agent version alias.

- [`betaAgentsDelete`](docs/sdks/betaagents/README.md#delete) - Delete an agent entity.

- [`betaAgentsDeleteVersionAlias`](docs/sdks/betaagents/README.md#deleteversionalias) - Delete an agent version alias.

- [`betaAgentsGet`](docs/sdks/betaagents/README.md#get) - Retrieve an agent entity.

- [`betaAgentsGetVersion`](docs/sdks/betaagents/README.md#getversion) - Retrieve a specific version of an agent.

- [`betaAgentsList`](docs/sdks/betaagents/README.md#list) - List agent entities.

- [`betaAgentsListVersionAliases`](docs/sdks/betaagents/README.md#listversionaliases) - List all aliases for an agent.

- [`betaAgentsListVersions`](docs/sdks/betaagents/README.md#listversions) - List all versions of an agent.

- [`betaAgentsUpdate`](docs/sdks/betaagents/README.md#update) - Update an agent entity.

- [`betaAgentsUpdateVersion`](docs/sdks/betaagents/README.md#updateversion) - Update an agent version.

- [`betaConnectorsCallTool`](docs/sdks/connectors/README.md#calltool) - Call Connector Tool

- [`betaConnectorsCreate`](docs/sdks/connectors/README.md#create) - Create a new connector.

- [`betaConnectorsDelete`](docs/sdks/connectors/README.md#delete) - Delete a connector.

- [`betaConnectorsGet`](docs/sdks/connectors/README.md#get) - Get a connector.

- [`betaConnectorsGetAuthUrl`](docs/sdks/connectors/README.md#getauthurl) - Get the auth URL for a connector.

- [`betaConnectorsList`](docs/sdks/connectors/README.md#list) - List all connectors.

- [`betaConnectorsListTools`](docs/sdks/connectors/README.md#listtools) - List tools for a connector.

- [`betaConnectorsUpdate`](docs/sdks/connectors/README.md#update) - Update a connector.

- [`betaConversationsAppend`](docs/sdks/conversations/README.md#append) - Append new entries to an existing conversation.

- [`betaConversationsAppendStream`](docs/sdks/conversations/README.md#appendstream) - Append new entries to an existing conversation.

- [`betaConversationsDelete`](docs/sdks/conversations/README.md#delete) - Delete a conversation.

- [`betaConversationsGet`](docs/sdks/conversations/README.md#get) - Retrieve a conversation information.

- [`betaConversationsGetHistory`](docs/sdks/conversations/README.md#gethistory) - Retrieve all entries in a conversation.

- [`betaConversationsGetMessages`](docs/sdks/conversations/README.md#getmessages) - Retrieve all messages in a conversation.

- [`betaConversationsList`](docs/sdks/conversations/README.md#list) - List all created conversations.

- [`betaConversationsRestart`](docs/sdks/conversations/README.md#restart) - Restart a conversation starting from a given entry.

- [`betaConversationsRestartStream`](docs/sdks/conversations/README.md#restartstream) - Restart a conversation starting from a given entry.

- [`betaConversationsStart`](docs/sdks/conversations/README.md#start) - Create a conversation and append entries to it.

- [`betaConversationsStartStream`](docs/sdks/conversations/README.md#startstream) - Create a conversation and append entries to it.

- [`betaLibrariesAccessesDelete`](docs/sdks/accesses/README.md#delete) - Delete an access level.

- [`betaLibrariesAccessesList`](docs/sdks/accesses/README.md#list) - List all of the access to this library.

- [`betaLibrariesAccessesUpdateOrCreate`](docs/sdks/accesses/README.md#updateorcreate) - Create or update an access level.

- [`betaLibrariesCreate`](docs/sdks/libraries/README.md#create) - Create a new Library.

- [`betaLibrariesDelete`](docs/sdks/libraries/README.md#delete) - Delete a library and all of it's document.

- [`betaLibrariesDocumentsDelete`](docs/sdks/documents/README.md#delete) - Delete a document.

- [`betaLibrariesDocumentsExtractedTextSignedUrl`](docs/sdks/documents/README.md#extractedtextsignedurl) - Retrieve the signed URL of text extracted from a given document.

- [`betaLibrariesDocumentsGet`](docs/sdks/documents/README.md#get) - Retrieve the metadata of a specific document.

- [`betaLibrariesDocumentsGetSignedUrl`](docs/sdks/documents/README.md#getsignedurl) - Retrieve the signed URL of a specific document.

- [`betaLibrariesDocumentsList`](docs/sdks/documents/README.md#list) - List documents in a given library.

- [`betaLibrariesDocumentsReprocess`](docs/sdks/documents/README.md#reprocess) - Reprocess a document.

- [`betaLibrariesDocumentsStatus`](docs/sdks/documents/README.md#status) - Retrieve the processing status of a specific document.

- [`betaLibrariesDocumentsTextContent`](docs/sdks/documents/README.md#textcontent) - Retrieve the text content of a specific document.

- [`betaLibrariesDocumentsUpdate`](docs/sdks/documents/README.md#update) - Update the metadata of a specific document.

- [`betaLibrariesDocumentsUpload`](docs/sdks/documents/README.md#upload) - Upload a new document.

- [`betaLibrariesGet`](docs/sdks/libraries/README.md#get) - Detailed information about a specific Library.

- [`betaLibrariesList`](docs/sdks/libraries/README.md#list) - List all libraries you have access to.

- [`betaLibrariesUpdate`](docs/sdks/libraries/README.md#update) - Update a library.

- [`betaObservabilityCampaignsCreate`](docs/sdks/campaigns/README.md#create) - Create and start a new campaign

- [`betaObservabilityCampaignsDelete`](docs/sdks/campaigns/README.md#delete) - Delete a campaign

- [`betaObservabilityCampaignsFetch`](docs/sdks/campaigns/README.md#fetch) - Get campaign by id

- [`betaObservabilityCampaignsFetchStatus`](docs/sdks/campaigns/README.md#fetchstatus) - Get campaign status by campaign id

- [`betaObservabilityCampaignsList`](docs/sdks/campaigns/README.md#list) - Get all campaigns

- [`betaObservabilityCampaignsListEvents`](docs/sdks/campaigns/README.md#listevents) - Get event ids that were selected by the given campaign

- [`betaObservabilityChatCompletionEventsFetch`](docs/sdks/chatcompletionevents/README.md#fetch) - Get Chat Completion Event

- [`betaObservabilityChatCompletionEventsFetchSimilarEvents`](docs/sdks/chatcompletionevents/README.md#fetchsimilarevents) - Get Similar Chat Completion Events

- [`betaObservabilityChatCompletionEventsFieldsFetchOptionCounts`](docs/sdks/fields/README.md#fetchoptioncounts) - Get Chat Completion Field Options Counts

- [`betaObservabilityChatCompletionEventsFieldsFetchOptions`](docs/sdks/fields/README.md#fetchoptions) - Get Chat Completion Field Options

- [`betaObservabilityChatCompletionEventsFieldsList`](docs/sdks/fields/README.md#list) - Get Chat Completion Fields

- [`betaObservabilityChatCompletionEventsJudge`](docs/sdks/chatcompletionevents/README.md#judge) - Run Judge on an event based on the given options

- [`betaObservabilityChatCompletionEventsSearch`](docs/sdks/chatcompletionevents/README.md#search) - Get Chat Completion Events

- [`betaObservabilityChatCompletionEventsSearchIds`](docs/sdks/chatcompletionevents/README.md#searchids) - Alternative to /search that returns only the IDs and that can return many IDs at once

- [`betaObservabilityDatasetsCreate`](docs/sdks/datasets/README.md#create) - Create a new empty dataset

- [`betaObservabilityDatasetsCreateRecord`](docs/sdks/datasets/README.md#createrecord) - Add a conversation to the dataset

- [`betaObservabilityDatasetsDelete`](docs/sdks/datasets/README.md#delete) - Delete a dataset

- [`betaObservabilityDatasetsExportToJsonl`](docs/sdks/datasets/README.md#exporttojsonl) - Export to the Files API and retrieve presigned URL to download the resulting JSONL file

- [`betaObservabilityDatasetsFetch`](docs/sdks/datasets/README.md#fetch) - Get dataset by id

- [`betaObservabilityDatasetsFetchTask`](docs/sdks/datasets/README.md#fetchtask) - Get status of a dataset import task

- [`betaObservabilityDatasetsImportFromCampaign`](docs/sdks/datasets/README.md#importfromcampaign) - Populate the dataset with a campaign

- [`betaObservabilityDatasetsImportFromDatasetRecords`](docs/sdks/datasets/README.md#importfromdatasetrecords) - Populate the dataset with samples from another dataset

- [`betaObservabilityDatasetsImportFromExplorer`](docs/sdks/datasets/README.md#importfromexplorer) - Populate the dataset with samples from the explorer

- [`betaObservabilityDatasetsImportFromFile`](docs/sdks/datasets/README.md#importfromfile) - Populate the dataset with samples from an uploaded file

- [`betaObservabilityDatasetsImportFromPlayground`](docs/sdks/datasets/README.md#importfromplayground) - Populate the dataset with samples from the playground

- [`betaObservabilityDatasetsList`](docs/sdks/datasets/README.md#list) - List existing datasets

- [`betaObservabilityDatasetsListRecords`](docs/sdks/datasets/README.md#listrecords) - List existing records in the dataset

- [`betaObservabilityDatasetsListTasks`](docs/sdks/datasets/README.md#listtasks) - List import tasks for the given dataset

- [`betaObservabilityDatasetsRecordsBulkDelete`](docs/sdks/records/README.md#bulkdelete) - Delete multiple records from datasets

- [`betaObservabilityDatasetsRecordsDelete`](docs/sdks/records/README.md#delete) - Delete a record from a dataset

- [`betaObservabilityDatasetsRecordsFetch`](docs/sdks/records/README.md#fetch) - Get the content of a given conversation from a dataset

- [`betaObservabilityDatasetsRecordsJudge`](docs/sdks/records/README.md#judge) - Run Judge on a dataset record based on the given options

- [`betaObservabilityDatasetsRecordsUpdatePayload`](docs/sdks/records/README.md#updatepayload) - Update a dataset record conversation payload

- [`betaObservabilityDatasetsRecordsUpdateProperties`](docs/sdks/records/README.md#updateproperties) - Update conversation properties

- [`betaObservabilityDatasetsUpdate`](docs/sdks/datasets/README.md#update) - Patch dataset

- [`betaObservabilityJudgesCreate`](docs/sdks/judges/README.md#create) - Create a new judge

- [`betaObservabilityJudgesDelete`](docs/sdks/judges/README.md#delete) - Delete a judge

- [`betaObservabilityJudgesFetch`](docs/sdks/judges/README.md#fetch) - Get judge by id

- [`betaObservabilityJudgesJudgeConversation`](docs/sdks/judges/README.md#judgeconversation) - Run a saved judge on a conversation

- [`betaObservabilityJudgesList`](docs/sdks/judges/README.md#list) - Get judges with optional filtering and search

- [`betaObservabilityJudgesUpdate`](docs/sdks/judges/README.md#update) - Update a judge

- [`chatComplete`](docs/sdks/chat/README.md#complete) - Chat Completion

- [`chatStream`](docs/sdks/chat/README.md#stream) - Stream chat completion

- [`classifiersClassify`](docs/sdks/classifiers/README.md#classify) - Classifications

- [`classifiersClassifyChat`](docs/sdks/classifiers/README.md#classifychat) - Chat Classifications

- [`classifiersModerate`](docs/sdks/classifiers/README.md#moderate) - Moderations

- [`classifiersModerateChat`](docs/sdks/classifiers/README.md#moderatechat) - Chat Moderations

- [`embeddingsCreate`](docs/sdks/embeddings/README.md#create) - Embeddings

- [`eventsGetStreamEvents`](docs/sdks/events/README.md#getstreamevents) - Get Stream Events

- [`eventsGetStreamEvents`](docs/sdks/workflowsevents/README.md#getstreamevents) - Get Stream Events

- [`eventsGetWorkflowEvents`](docs/sdks/events/README.md#getworkflowevents) - Get Workflow Events

- [`eventsGetWorkflowEvents`](docs/sdks/workflowsevents/README.md#getworkflowevents) - Get Workflow Events

- [`filesDelete`](docs/sdks/files/README.md#delete) - Delete File

- [`filesDownload`](docs/sdks/files/README.md#download) - Download File

- [`filesGetSignedUrl`](docs/sdks/files/README.md#getsignedurl) - Get Signed Url

- [`filesList`](docs/sdks/files/README.md#list) - List Files

- [`filesRetrieve`](docs/sdks/files/README.md#retrieve) - Retrieve File

- [`filesUpload`](docs/sdks/files/README.md#upload) - Upload File

- [`fimComplete`](docs/sdks/fim/README.md#complete) - Fim Completion

- [`fimStream`](docs/sdks/fim/README.md#stream) - Stream fim completion

- [`fineTuningJobsCancel`](docs/sdks/finetuningjobs/README.md#cancel) - Cancel Fine Tuning Job

- [`fineTuningJobsCreate`](docs/sdks/finetuningjobs/README.md#create) - Create Fine Tuning Job

- [`fineTuningJobsGet`](docs/sdks/finetuningjobs/README.md#get) - Get Fine Tuning Job

- [`fineTuningJobsList`](docs/sdks/finetuningjobs/README.md#list) - Get Fine Tuning Jobs

- [`fineTuningJobsStart`](docs/sdks/finetuningjobs/README.md#start) - Start Fine Tuning Job

- [`modelsArchive`](docs/sdks/models/README.md#archive) - Archive Fine Tuned Model

- [`modelsDelete`](docs/sdks/models/README.md#delete) - Delete Model

- [`modelsList`](docs/sdks/models/README.md#list) - List Models

- [`modelsRetrieve`](docs/sdks/models/README.md#retrieve) - Retrieve Model

- [`modelsUnarchive`](docs/sdks/models/README.md#unarchive) - Unarchive Fine Tuned Model

- [`modelsUpdate`](docs/sdks/models/README.md#update) - Update Fine Tuned Model

- [`ocrProcess`](docs/sdks/ocr/README.md#process) - OCR

- [`workflowsArchiveWorkflow`](docs/sdks/workflows/README.md#archiveworkflow) - Archive Workflow

- [`workflowsDeploymentsGetDeployment`](docs/sdks/deployments/README.md#getdeployment) - Get Deployment

- [`workflowsDeploymentsListDeployments`](docs/sdks/deployments/README.md#listdeployments) - List Deployments

- [`workflowsExecuteWorkflow`](docs/sdks/workflows/README.md#executeworkflow) - Execute Workflow

- [`workflowsExecutionsBatchCancelWorkflowExecutions`](docs/sdks/executions/README.md#batchcancelworkflowexecutions) - Batch Cancel Workflow Executions

- [`workflowsExecutionsBatchTerminateWorkflowExecutions`](docs/sdks/executions/README.md#batchterminateworkflowexecutions) - Batch Terminate Workflow Executions

- [`workflowsExecutionsCancelWorkflowExecution`](docs/sdks/executions/README.md#cancelworkflowexecution) - Cancel Workflow Execution

- [`workflowsExecutionsGetWorkflowExecution`](docs/sdks/executions/README.md#getworkflowexecution) - Get Workflow Execution

- [`workflowsExecutionsGetWorkflowExecutionHistory`](docs/sdks/executions/README.md#getworkflowexecutionhistory) - Get Workflow Execution History

- [`workflowsExecutionsGetWorkflowExecutionTraceEvents`](docs/sdks/executions/README.md#getworkflowexecutiontraceevents) - Get Workflow Execution Trace Events

- [`workflowsExecutionsGetWorkflowExecutionTraceOtel`](docs/sdks/executions/README.md#getworkflowexecutiontraceotel) - Get Workflow Execution Trace Otel

- [`workflowsExecutionsGetWorkflowExecutionTraceSummary`](docs/sdks/executions/README.md#getworkflowexecutiontracesummary) - Get Workflow Execution Trace Summary

- [`workflowsExecutionsQueryWorkflowExecution`](docs/sdks/executions/README.md#queryworkflowexecution) - Query Workflow Execution

- [`workflowsExecutionsResetWorkflow`](docs/sdks/executions/README.md#resetworkflow) - Reset Workflow

- [`workflowsExecutionsSignalWorkflowExecution`](docs/sdks/executions/README.md#signalworkflowexecution) - Signal Workflow Execution

- [`workflowsExecutionsStream`](docs/sdks/executions/README.md#stream) - Stream

- [`workflowsExecutionsTerminateWorkflowExecution`](docs/sdks/executions/README.md#terminateworkflowexecution) - Terminate Workflow Execution

- [`workflowsExecutionsUpdateWorkflowExecution`](docs/sdks/executions/README.md#updateworkflowexecution) - Update Workflow Execution

- [`workflowsGetWorkflow`](docs/sdks/workflows/README.md#getworkflow) - Get Workflow

- [`workflowsGetWorkflowRegistration`](docs/sdks/workflows/README.md#getworkflowregistration) - Get Workflow Registration

- [`workflowsGetWorkflowRegistrations`](docs/sdks/workflows/README.md#getworkflowregistrations) - Get Workflow Registrations

- [`workflowsGetWorkflows`](docs/sdks/workflows/README.md#getworkflows) - Get Workflows

- [`workflowsMetricsGetWorkflowMetrics`](docs/sdks/metrics/README.md#getworkflowmetrics) - Get Workflow Metrics

- [`workflowsRunsGetRun`](docs/sdks/runs/README.md#getrun) - Get Run

- [`workflowsRunsGetRunHistory`](docs/sdks/runs/README.md#getrunhistory) - Get Run History

- [`workflowsRunsListRuns`](docs/sdks/runs/README.md#listruns) - List Runs

- [`workflowsSchedulesGetSchedules`](docs/sdks/schedules/README.md#getschedules) - Get Schedules

- [`workflowsSchedulesScheduleWorkflow`](docs/sdks/schedules/README.md#scheduleworkflow) - Schedule Workflow

- [`workflowsSchedulesUnscheduleWorkflow`](docs/sdks/schedules/README.md#unscheduleworkflow) - Unschedule Workflow

- [`workflowsUnarchiveWorkflow`](docs/sdks/workflows/README.md#unarchiveworkflow) - Unarchive Workflow

- [`workflowsUpdateWorkflow`](docs/sdks/workflows/README.md#updateworkflow) - Update Workflow

- ~~[`workflowsExecuteWorkflowRegistration`](docs/sdks/workflows/README.md#executeworkflowregistration)~~ - Execute Workflow Registration :warning: **Deprecated**



## Debugging



You can setup your SDK to emit debug logs for SDK requests and responses.



You can pass a logger that matches `console`'s interface as an SDK option.



> [!WARNING]

> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.



```typescript

import { Mistral } from "@mistralai/mistralai";



const sdk = new Mistral({ debugLogger: console });

```



You can also enable a default debug logger by setting an environment variable `MISTRAL_DEBUG` to true.



# Development



## Contributions



While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 

We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.