Struct Assistants 

pub struct Assistants<'c, C: Config> { /* private fields */ }

👎Deprecated: Assistants API is deprecated and will be removed in August 2026. Use the Responses API.

Available on crate feature assistant only.

Build assistants that can call models and use tools to perform tasks.

Get started with the Assistants API

Implementations

impl<'c, C: Config> Assistants<'c, C>

pub fn new(client: &'c Client<C>) -> Self

pub async fn create( &self, request: CreateAssistantRequest, ) -> Result<AssistantObject, OpenAIError>

Create an assistant with a model and instructions.

pub async fn create_byot<T0: Serialize, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

Create an assistant with a model and instructions.

pub async fn retrieve( &self, assistant_id: &str, ) -> Result<AssistantObject, OpenAIError>

Retrieves an assistant.

pub async fn retrieve_byot<T0: Display, R: DeserializeOwned>( &self, assistant_id: T0, ) -> Result<R, OpenAIError>

Retrieves an assistant.

pub async fn update( &self, assistant_id: &str, request: ModifyAssistantRequest, ) -> Result<AssistantObject, OpenAIError>

Modifies an assistant.

pub async fn update_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, assistant_id: T0, request: T1, ) -> Result<R, OpenAIError>

Modifies an assistant.

pub async fn delete( &self, assistant_id: &str, ) -> Result<DeleteAssistantResponse, OpenAIError>

Delete an assistant.

pub async fn delete_byot<T0: Display, R: DeserializeOwned>( &self, assistant_id: T0, ) -> Result<R, OpenAIError>

Delete an assistant.

pub async fn list(&self) -> Result<ListAssistantsResponse, OpenAIError>

Returns a list of assistants.

pub async fn list_byot<R: DeserializeOwned>(&self) -> Result<R, OpenAIError>

Returns a list of assistants.

Trait Implementations

impl<'c, C: Config> RequestOptionsBuilder for Assistants<'c, C>

Available on crate feature _api only.

fn options_mut(&mut self) -> &mut RequestOptions

Get mutable reference to RequestOptions (for building)

fn options(&self) -> &RequestOptions

Get reference to RequestOptions

fn headers(self, headers: HeaderMap) -> Self

Add headers to RequestOptions

fn header<K, V>(self, key: K, value: V) -> Result<Self, OpenAIError>

where K: IntoHeaderName, V: TryInto<HeaderValue>, V::Error: Into<InvalidHeaderValue>,

Add a single header to RequestOptions

fn query<Q: Serialize + ?Sized>(self, query: &Q) -> Result<Self, OpenAIError>

Add query parameters to RequestOptions

fn path<P: Into<String>>(self, path: P) -> Result<Self, OpenAIError>

Add a path to RequestOptions