Mistral Typescript Client

Summary

Mistral AI API: Our Chat Completion and Embeddings APIs specification. Create your account on La Plateforme to get access and read the docs to learn how to use it.

Table of Contents

* Mistral Typescript Client
* SDK Installation
* Requirements
* API Key Setup
* SDK Example Usage
* Providers' SDKs
* Available Resources and Operations
* Server-sent event streaming
* File uploads
* Retries
* Error Handling
* Server Selection
* Custom HTTP Client
* Authentication
* Providers Support
* Standalone functions
* Debugging
* Development
* Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

$3

``bash
npm add @mistralai/mistralai
`

$3

`bash
pnpm add @mistralai/mistralai
`

$3

`bash
bun add @mistralai/mistralai
`

$3

`bash
yarn add @mistralai/mistralai
`





Requirements

For supported JavaScript runtimes, please consult 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

$3

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: [
{
content:
"Who is the best French painter? Answer in one short sentence.",
role: "user",
},
],
responseFormat: {
type: "text",
},
});

console.log(result);
}

run();

`

$3

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();

`

$3

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: [
{
content:
"Who is the best French painter? Answer in one short sentence.",
role: "user",
},
],
agentId: "",
});

console.log(result);
}

run();

`

$3

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
- Azure




Available Resources and Operations

Available methods

$3

* complete - Agents Completion
* stream - Stream Agents completion

$3

* complete - Create Transcription
* stream - Create Streaming Transcription (SSE)

$3

* list - Get Batch Jobs
* create - Create Batch Job
* get - Get Batch Job
* cancel - Cancel Batch Job

$3

* create - Create a agent that can be used within a conversation.
* list - List agent entities.
* get - Retrieve an agent entity.
* update - Update an agent entity.
* delete - Delete an agent entity.
* updateVersion - Update an agent version.
* listVersions - List all versions of an agent.
* getVersion - Retrieve a specific version of an agent.
* createVersionAlias - Create or update an agent version alias.
* listVersionAliases - List all aliases for an agent.

$3

* start - Create a conversation and append entries to it.
* list - List all created conversations.
* get - Retrieve a conversation information.
* delete - Delete a conversation.
* append - Append new entries to an existing conversation.
* getHistory - Retrieve all entries in a conversation.
* getMessages - Retrieve all messages in a conversation.
* restart - Restart a conversation starting from a given entry.
* startStream - Create a conversation and append entries to it.
* appendStream - Append new entries to an existing conversation.
* restartStream - Restart a conversation starting from a given entry.

$3

* list - List all libraries you have access to.
* create - Create a new Library.
* get - Detailed information about a specific Library.
* delete - Delete a library and all of it's document.
* update - Update a library.

#### Beta.Libraries.Accesses

* list - List all of the access to this library.
* updateOrCreate - Create or update an access level.
* delete - Delete an access level.

#### Beta.Libraries.Documents

* list - List documents in a given library.
* upload - Upload a new document.
* get - Retrieve the metadata of a specific document.
* update - Update the metadata of a specific document.
* delete - Delete a document.
* textContent - Retrieve the text content of a specific document.
* status - Retrieve the processing status of a specific document.
* getSignedUrl - Retrieve the signed URL of a specific document.
* extractedTextSignedUrl - Retrieve the signed URL of text extracted from a given document.
* reprocess - Reprocess a document.

$3

* complete - Chat Completion
* stream - Stream chat completion

$3

* moderate - Moderations
* moderateChat - Chat Moderations
* classify - Classifications
* classifyChat - Chat Classifications

$3

* create - Embeddings

$3

* upload - Upload File
* list - List Files
* retrieve - Retrieve File
* delete - Delete File
* download - Download File
* getSignedUrl - Get Signed Url

$3

* complete - Fim Completion
* stream - Stream fim completion

$3

* list - Get Fine Tuning Jobs
* create - Create Fine Tuning Job
* get - Get Fine Tuning Job
* cancel - Cancel Fine Tuning Job
* start - Start Fine Tuning Job

$3

* list - List Models
* retrieve - Retrieve Model
* delete - Delete Model
* update - Update Fine Tuned Model
* archive - Archive Fine Tuned Model
* unarchive - Unarchive Fine Tuned Model

$3

* process - OCR

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.beta.conversations.startStream({
inputs: [
{
object: "entry",
type: "agent.handoff",
previousAgentId: "",
previousAgentName: "",
nextAgentId: "",
nextAgentName: "",
},
],
completionArgs: {
responseFormat: {
type: "text",
},
},
});

for await (const event of result) {
console.log(event);
}
}

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





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.
> - Bun: The native 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 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.

`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.beta.libraries.documents.upload({
libraryId: "a02150d9-5ee0-4877-b62c-28b1fcdf3b76",
requestBody: {
file: await openAsBlob("example.file"),
},
});

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.models.list({
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.models.list();

console.log(result);
}

run();

`





Error Handling

MistralError 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. |

$3


`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.models.retrieve({
modelId: "ft:open-mistral-7b:587a6b29:20240514:7e773925",
});

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();

`

$3


Primary error:
* MistralError: The base class for HTTP error responses.

Less common errors (7)

Network errors:
* ConnectionError: HTTP client was unable to make a request to a server.
* RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
* RequestAbortedError: HTTP request was aborted by the client.
* InvalidRequestError: Any input used to create a request is invalid.
* UnexpectedClientError: Unrecognised or unexpected error.


Inherit from MistralError:
HTTPValidationError: Validation Error. Status code 422. Applicable to 52 of 74 methods.
* ResponseValidationError: 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 to see if the error is applicable.





Server Selection

$3

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.models.list();

console.log(result);
}

run();

`

$3

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.models.list();

console.log(result);
}

run();

`





Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native
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 use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:

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

const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native fetch.
fetcher: (request) => {
return fetch(request);
}
});

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

$3

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.models.list();

console.log(result);
}

run();

`


Providers Support

We also provide provider specific SDK for:

- GCP
- Azure




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.

Available standalone functions

- agentsComplete - Agents Completion
- agentsStream - Stream Agents completion
- audioTranscriptionsComplete - Create Transcription
- audioTranscriptionsStream - Create Streaming Transcription (SSE)
- batchJobsCancel - Cancel Batch Job
- batchJobsCreate - Create Batch Job
- batchJobsGet - Get Batch Job
- batchJobsList - Get Batch Jobs
- betaAgentsCreate - Create a agent that can be used within a conversation.
- betaAgentsCreateVersionAlias - Create or update an agent version alias.
- betaAgentsDelete - Delete an agent entity.
- betaAgentsGet - Retrieve an agent entity.
- betaAgentsGetVersion - Retrieve a specific version of an agent.
- betaAgentsList - List agent entities.
- betaAgentsListVersionAliases - List all aliases for an agent.
- betaAgentsListVersions - List all versions of an agent.
- betaAgentsUpdate - Update an agent entity.
- betaAgentsUpdateVersion - Update an agent version.
- betaConversationsAppend - Append new entries to an existing conversation.
- betaConversationsAppendStream - Append new entries to an existing conversation.
- betaConversationsDelete - Delete a conversation.
- betaConversationsGet - Retrieve a conversation information.
- betaConversationsGetHistory - Retrieve all entries in a conversation.
- betaConversationsGetMessages - Retrieve all messages in a conversation.
- betaConversationsList - List all created conversations.
- betaConversationsRestart - Restart a conversation starting from a given entry.
- betaConversationsRestartStream - Restart a conversation starting from a given entry.
- betaConversationsStart - Create a conversation and append entries to it.
- betaConversationsStartStream - Create a conversation and append entries to it.
- betaLibrariesAccessesDelete - Delete an access level.
- betaLibrariesAccessesList - List all of the access to this library.
- betaLibrariesAccessesUpdateOrCreate - Create or update an access level.
- betaLibrariesCreate - Create a new Library.
- betaLibrariesDelete - Delete a library and all of it's document.
- betaLibrariesDocumentsDelete - Delete a document.
- betaLibrariesDocumentsExtractedTextSignedUrl - Retrieve the signed URL of text extracted from a given document.
- betaLibrariesDocumentsGet - Retrieve the metadata of a specific document.
- betaLibrariesDocumentsGetSignedUrl - Retrieve the signed URL of a specific document.
- betaLibrariesDocumentsList - List documents in a given library.
- betaLibrariesDocumentsReprocess - Reprocess a document.
- betaLibrariesDocumentsStatus - Retrieve the processing status of a specific document.
- betaLibrariesDocumentsTextContent - Retrieve the text content of a specific document.
- betaLibrariesDocumentsUpdate - Update the metadata of a specific document.
- betaLibrariesDocumentsUpload - Upload a new document.
- betaLibrariesGet - Detailed information about a specific Library.
- betaLibrariesList - List all libraries you have access to.
- betaLibrariesUpdate - Update a library.
- chatComplete - Chat Completion
- chatStream - Stream chat completion
- classifiersClassify - Classifications
- classifiersClassifyChat - Chat Classifications
- classifiersModerate - Moderations
- classifiersModerateChat - Chat Moderations
- embeddingsCreate - Embeddings
- filesDelete - Delete File
- filesDownload - Download File
- filesGetSignedUrl - Get Signed Url
- filesList - List Files
- filesRetrieve - Retrieve File
- filesUpload - Upload File
- fimComplete - Fim Completion
- fimStream - Stream fim completion
- fineTuningJobsCancel - Cancel Fine Tuning Job
- fineTuningJobsCreate - Create Fine Tuning Job
- fineTuningJobsGet - Get Fine Tuning Job
- fineTuningJobsList - Get Fine Tuning Jobs
- fineTuningJobsStart - Start Fine Tuning Job
- modelsArchive - Archive Fine Tuned Model
- modelsDelete - Delete Model
- modelsList - List Models
- modelsRetrieve - Retrieve Model
- modelsUnarchive - Unarchive Fine Tuned Model
- modelsUpdate - Update Fine Tuned Model
- ocrProcess - OCR

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.