# Mistral AI Provider The [Mistral AI](https://mistral.ai/) provider contains language model support for the Mistral chat API. ## Setup The Mistral provider is available in the `@ai-sdk/mistral` module. You can install it with ## Provider Instance You can import the default provider instance `mistral` from `@ai-sdk/mistral`: ```ts import { mistral } from '@ai-sdk/mistral'; ``` If you need a customized setup, you can import `createMistral` from `@ai-sdk/mistral` and create a provider instance with your settings: ```ts import { createMistral } from '@ai-sdk/mistral'; const mistral = createMistral({ // custom settings }); ``` You can use the following optional settings to customize the Mistral provider instance: - **baseURL** _string_ Use a different URL prefix for API calls, e.g. to use proxy servers. The default prefix is `https://api.mistral.ai/v1`. - **apiKey** _string_ API key that is being sent using the `Authorization` header. It defaults to the `MISTRAL_API_KEY` environment variable. - **headers** _Record<string,string>_ Custom headers to include in the requests. - **fetch** _(input: RequestInfo, init?: RequestInit) => Promise<Response>_ Custom [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) implementation. Defaults to the global `fetch` function. You can use it as a middleware to intercept requests, or to provide a custom fetch implementation for e.g. testing. ## Language Models You can create models that call the [Mistral chat API](https://docs.mistral.ai/api/#operation/createChatCompletion) using a provider instance. The first argument is the model id, e.g. `mistral-large-latest`. Some Mistral chat models support tool calls. ```ts const model = mistral('mistral-large-latest'); ``` Mistral chat models also support additional model settings that are not part of the [standard call settings](/docs/ai-sdk-core/settings). You can pass them as an options argument: ```ts const model = mistral('mistral-large-latest', { safePrompt: true, // optional safety prompt injection }); ``` The following optional settings are available for Mistral models: - **safePrompt** _boolean_ Whether to inject a safety prompt before all conversations. Defaults to `false`. ### Document OCR Mistral chat models support document OCR for PDF files. You can optionally set image and page limits using the provider options. ```ts const result = await generateText({ model: mistral('mistral-small-latest'), messages: [ { role: 'user', content: [ { type: 'text', text: 'What is an embedding model according to this document?', }, { type: 'file', data: new URL( 'https://github.com/vercel/ai/blob/main/examples/ai-core/data/ai.pdf?raw=true', ), mimeType: 'application/pdf', }, ], }, ], // optional settings: providerOptions: { mistral: { documentImageLimit: 8, documentPageLimit: 64, }, }, }); ``` ### Example You can use Mistral language models to generate text with the `generateText` function: ```ts import { mistral } from '@ai-sdk/mistral'; import { generateText } from 'ai'; const { text } = await generateText({ model: mistral('mistral-large-latest'), prompt: 'Write a vegetarian lasagna recipe for 4 people.', }); ``` Mistral language models can also be used in the `streamText`, `generateObject`, and `streamObject` functions (see [AI SDK Core](/docs/ai-sdk-core)). ### Model Capabilities | Model | Image Input | Object Generation | Tool Usage | Tool Streaming | | ---------------------- | ------------------- | ------------------- | ------------------- | ------------------- | | `pixtral-large-latest` | | | | | | `mistral-large-latest` | | | | | | `mistral-small-latest` | | | | | | `ministral-3b-latest` | | | | | | `ministral-8b-latest` | | | | | | `pixtral-12b-2409` | | | | | The table above lists popular models. Please see the [Mistral docs](https://docs.mistral.ai/getting-started/models/models_overview/) for a full list of available models. The table above lists popular models. You can also pass any available provider model ID as a string if needed. ## Embedding Models You can create models that call the [Mistral embeddings API](https://docs.mistral.ai/api/#operation/createEmbedding) using the `.embedding()` factory method. ```ts const model = mistral.embedding('mistral-embed'); ``` ### Model Capabilities | Model | Default Dimensions | | --------------- | ------------------ | | `mistral-embed` | 1024 | ## Navigation - [xAI Grok](/v4/providers/ai-sdk-providers/xai) - [Vercel](/v4/providers/ai-sdk-providers/vercel) - [OpenAI](/v4/providers/ai-sdk-providers/openai) - [Azure OpenAI](/v4/providers/ai-sdk-providers/azure) - [Anthropic](/v4/providers/ai-sdk-providers/anthropic) - [Amazon Bedrock](/v4/providers/ai-sdk-providers/amazon-bedrock) - [Groq](/v4/providers/ai-sdk-providers/groq) - [Fal](/v4/providers/ai-sdk-providers/fal) - [AssemblyAI](/v4/providers/ai-sdk-providers/assemblyai) - [DeepInfra](/v4/providers/ai-sdk-providers/deepinfra) - [Deepgram](/v4/providers/ai-sdk-providers/deepgram) - [Gladia](/v4/providers/ai-sdk-providers/gladia) - [LMNT](/v4/providers/ai-sdk-providers/lmnt) - [Google Generative AI](/v4/providers/ai-sdk-providers/google-generative-ai) - [Hume](/v4/providers/ai-sdk-providers/hume) - [Google Vertex AI](/v4/providers/ai-sdk-providers/google-vertex) - [Rev.ai](/v4/providers/ai-sdk-providers/revai) - [Mistral AI](/v4/providers/ai-sdk-providers/mistral) - [Together.ai](/v4/providers/ai-sdk-providers/togetherai) - [Cohere](/v4/providers/ai-sdk-providers/cohere) - [Fireworks](/v4/providers/ai-sdk-providers/fireworks) - [DeepSeek](/v4/providers/ai-sdk-providers/deepseek) - [Cerebras](/v4/providers/ai-sdk-providers/cerebras) - [Replicate](/v4/providers/ai-sdk-providers/replicate) - [Perplexity](/v4/providers/ai-sdk-providers/perplexity) - [Luma](/v4/providers/ai-sdk-providers/luma) - [ElevenLabs](/v4/providers/ai-sdk-providers/elevenlabs) [Full Sitemap](/sitemap.md)