Lmstudio

AISDK provides first-class support for Lmstudio with fully typed model APIs. Model capabilities are enforced at compile time using Rust's type system. This prevents model capability mismatches and guarantees the selected model is valid for the task (e.g. tool calling).

Installation

Enable the Lmstudio provider feature:

cargo add aisdk --features lmstudio

This installs AISDK with the Lmstudio provider enabled. Once you have enabled the Lmstudio provider, you can use all aisdk features with it.

Create a Provider Instance

To create a provider instance, call Lmstudio::model_name(), where model_name is the Lmstudio model you want to use. Model names are exposed as snake-case methods.

use aisdk::providers::Lmstudio;

let lmstudio = Lmstudio::openai_gpt_oss_20b();

This initializes the provider with:

Model: "openai/gpt-oss-20b"
API key from environment (if set with LMSTUDIO_API_KEY)
Lmstudio's default base URL (http://127.0.0.1:1234/v1)

Basic Text Generation

Example using LanguageModelRequest for text generation.

use aisdk::{
    core::LanguageModelRequest,
    providers::Lmstudio,
};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {

    let lmstudio = Lmstudio::openai_gpt_oss_20b();

    let response = LanguageModelRequest::builder()
        .model(lmstudio)
        .prompt("Write a short poem about Rust.")
        .build()
        .generate_text()
        .await?;

    println!("Response text: {:?}", response.text());
    Ok(())
}

Provider Settings

You can customize provider configuration using Lmstudio::builder()

API Key

let lmstudio = Lmstudio::<OpenaiGptOss20b>::builder()
    .api_key("your-api-key")
    .build()?;

If not specified, AISDK uses the LMSTUDIO_API_KEY environment variable.

Base URL

Useful when routing through a proxy, gateway, or self-hosted compatible endpoint.

let lmstudio = Lmstudio::<OpenaiGptOss20b>::builder()
    .base_url("http://127.0.0.1:1234/v1")
    .build()?;

Path (Full URL Override)

Use .path(...) to override the full request URL instead of only the base URL.

let lmstudio = Lmstudio::<OpenaiGptOss20b>::builder()
    .path("https://full-url.example/v1/chat/completions")
    .build()?;

Provider Name

For logging, analytics, and observability.

let lmstudio = Lmstudio::<OpenaiGptOss20b>::builder()
    .provider_name("Lmstudio")
    .build()?;

Full Custom Configuration Example

let lmstudio = Lmstudio::<OpenaiGptOss20b>::builder()
    .api_key("your-api-key")
    .base_url("http://127.0.0.1:1234/v1")
    .path("https://full-url.example/v1/chat/completions")
    .provider_name("Lmstudio")
    .build()?;

Dynamic Model Selection

For runtime model selection (e.g., loading models from config files), use DynamicModel:

Using model_name() Method with Default Settings

use aisdk::providers::Lmstudio;

// Specify model as a string at runtime
let lmstudio = Lmstudio::model_name("openai/gpt-oss-20b");

Using Builder Pattern with Custom Settings

use aisdk::{
    core::DynamicModel,
    providers::Lmstudio,
};

let lmstudio = Lmstudio::<DynamicModel>::builder()
	.model_name("openai/gpt-oss-20b")
	.api_key("your-api-key")
	.base_url("http://127.0.0.1:1234/v1")
	.path("https://full-url.example/v1/chat/completions")
	.provider_name("Lmstudio")
	.build()?;

Warning: When using DynamicModel, model capabilities are not validated at compile time. This means there's no guarantee the model supports requested features (e.g., tool calls, structured output). For compile-time safety, use the typed methods like Lmstudio::openai_gpt_oss_20b().

Next Steps

Take a deeper look at text generation features Generating Text / Streaming Text
Explore Structured Output for reliable agent data.
Learn how to create Custom Tools.
Learn more about Agents.

Lmstudio

On this page