OpenAI

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

cargo add aisdk --features openai

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

Create a Provider Instance

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

use aisdk::providers::OpenAI;

let openai = OpenAI::gpt_5();

This initializes the provider with:

Model: "gpt-5"
API key from environment (if set with OPENAI_API_KEY)
OpenAI's default base URL (https://api.openai.com)

Basic Text Generation

Example using LanguageModelRequest for text generation.

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

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

    let openai = OpenAI::gpt_5();

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

API Key

let openai = OpenAI::<Gpt5>::builder()
    .api_key("your-api-key")
    .build()?;

If not specified, AISDK uses the OPENAI_API_KEY environment variable.

Base URL

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

let openai = OpenAI::<Gpt5>::builder()
    .base_url("https://api.openai.com")
    .build()?;

Provider Name

For logging, analytics, and observability.

let openai = OpenAI::<Gpt5>::builder()
    .provider_name("OpenAI")
    .build()?;

Full Custom Configuration Example

let openai = OpenAI::<Gpt5>::builder()
    .api_key("your-api-key")
    .base_url("https://api.openai.com")
    .provider_name("OpenAI")
    .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::OpenAI;

// Specify model as a string at runtime
let openai = OpenAI::model_name("gpt-5");

Using Builder Pattern with Custom Settings

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

let openai = OpenAI::<DynamicModel>::builder()
    .model_name("gpt-5")
    .api_key("your-api-key")
		.base_url("https://api.openai.com")
    .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 OpenAI::gpt_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.

OpenAI

On this page