Firmware

AISDK provides first-class support for Firmware 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 Firmware provider feature:

cargo add aisdk --features firmware

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

Create a Provider Instance

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

use aisdk::providers::Firmware;

let firmware = Firmware::claude_haiku_4_5();

This initializes the provider with:

Model: "claude-haiku-4-5"
API key from environment (if set with FIRMWARE_API_KEY)
Firmware's default base URL (https://app.firmware.ai/api/v1)

Basic Text Generation

Example using LanguageModelRequest for text generation.

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

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

    let firmware = Firmware::claude_haiku_4_5();

    let response = LanguageModelRequest::builder()
        .model(firmware)
        .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 Firmware::builder()

API Key

let firmware = Firmware::<ClaudeHaiku45>::builder()
    .api_key("your-api-key")
    .build()?;

If not specified, AISDK uses the FIRMWARE_API_KEY environment variable.

Base URL

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

let firmware = Firmware::<ClaudeHaiku45>::builder()
    .base_url("https://app.firmware.ai/api/v1")
    .build()?;

Path (Full URL Override)

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

let firmware = Firmware::<ClaudeHaiku45>::builder()
    .path("https://full-url.example/v1/chat/completions")
    .build()?;

Provider Name

For logging, analytics, and observability.

let firmware = Firmware::<ClaudeHaiku45>::builder()
    .provider_name("Firmware")
    .build()?;

Full Custom Configuration Example

let firmware = Firmware::<ClaudeHaiku45>::builder()
    .api_key("your-api-key")
    .base_url("https://app.firmware.ai/api/v1")
    .path("https://full-url.example/v1/chat/completions")
    .provider_name("Firmware")
    .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::Firmware;

// Specify model as a string at runtime
let firmware = Firmware::model_name("claude-haiku-4-5");

Using Builder Pattern with Custom Settings

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

let firmware = Firmware::<DynamicModel>::builder()
	.model_name("claude-haiku-4-5")
	.api_key("your-api-key")
	.base_url("https://app.firmware.ai/api/v1")
	.path("https://full-url.example/v1/chat/completions")
	.provider_name("Firmware")
	.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 Firmware::claude_haiku_4_5().

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.

Firmware

On this page