Struct ThreadsApi 

pub struct ThreadsApi { /* private fields */ }

OpenAI Threads API client for managing conversation threads and messages

Implementations

impl ThreadsApi

pub fn with_base_url<S: Into<String>>(api_key: S, base_url: S) -> Result<Self>

Creates a new Threads API client with custom base URL

Arguments

• api_key - Your OpenAI API key
• base_url - Custom base URL for the API

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};

let api = ThreadsApi::with_base_url("your-api-key", "https://custom-api.example.com")?;

impl ThreadsApi

pub async fn list_message_files( &self, thread_id: impl Into<String>, message_id: impl Into<String>, ) -> Result<ListMessageFilesResponse>

List files attached to a message

Arguments

• thread_id - The ID of the thread that contains the message
• message_id - The ID of the message to list files for

Returns

Returns a list of message file objects

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};

let api = ThreadsApi::new("your-api-key")?;
let files = api.list_message_files("thread_abc123", "msg_abc123").await?;
println!("Found {} files", files.data.len());

pub async fn retrieve_message_file( &self, thread_id: impl Into<String>, message_id: impl Into<String>, file_id: impl Into<String>, ) -> Result<MessageFile>

Retrieve a specific file attached to a message

Arguments

• thread_id - The ID of the thread that contains the message
• message_id - The ID of the message that contains the file
• file_id - The ID of the file to retrieve

Returns

Returns the message file object

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};

let api = ThreadsApi::new("your-api-key")?;
let file = api.retrieve_message_file("thread_abc123", "msg_abc123", "file_abc123").await?;
println!("File created at: {}", file.created_at);

impl ThreadsApi

pub async fn create_message( &self, thread_id: impl Into<String>, request: MessageRequest, ) -> Result<Message>

Create a message in a thread

Arguments

• thread_id - The ID of the thread to add the message to
• request - The message creation request

Returns

Returns the created message object

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};
use openai_rust_sdk::models::threads::{MessageRequest, MessageRole};

let api = ThreadsApi::new("your-api-key")?;
let message_request = MessageRequest::builder()
    .role(MessageRole::User)
    .content("Hello, I need help with my account.")
    .build()?;

let message = api.create_message("thread_abc123", message_request).await?;
println!("Created message: {}", message.id);

pub async fn retrieve_message( &self, thread_id: impl Into<String>, message_id: impl Into<String>, ) -> Result<Message>

Retrieve a message from a thread

Arguments

• thread_id - The ID of the thread that contains the message
• message_id - The ID of the message to retrieve

Returns

Returns the message object

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};

let api = ThreadsApi::new("your-api-key")?;
let message = api.retrieve_message("thread_abc123", "msg_abc123").await?;
println!("Message content: {:?}", message.content);

pub async fn modify_message( &self, thread_id: impl Into<String>, message_id: impl Into<String>, request: MessageRequest, ) -> Result<Message>

Modify a message’s metadata

Arguments

• thread_id - The ID of the thread that contains the message
• message_id - The ID of the message to modify
• request - The message modification request

Returns

Returns the modified message object

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};
use openai_rust_sdk::models::threads::{MessageRequest, MessageRole};

let api = ThreadsApi::new("your-api-key")?;
let message_request = MessageRequest::builder()
    .role(MessageRole::User)
    .content("Updated content")
    .metadata_pair("priority", "high")
    .build()?;

let message = api.modify_message("thread_abc123", "msg_abc123", message_request).await?;
println!("Modified message: {}", message.id);

pub async fn list_messages( &self, thread_id: impl Into<String>, params: Option<ListMessagesParams>, ) -> Result<ListMessagesResponse>

List messages in a thread

Arguments

• thread_id - The ID of the thread to list messages from
• params - Optional parameters for pagination and filtering

Returns

Returns a list of message objects with pagination information

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};
use openai_rust_sdk::models::threads::{ListMessagesParams, SortOrder};

let api = ThreadsApi::new("your-api-key")?;
let params = ListMessagesParams::new()
    .limit(10)
    .order(SortOrder::Desc);

let messages = api.list_messages("thread_abc123", Some(params)).await?;
println!("Found {} messages", messages.data.len());

impl ThreadsApi

pub async fn create_thread(&self, request: ThreadRequest) -> Result<Thread>

Create a new conversation thread

Arguments

• request - The thread creation request

Returns

Returns the created thread object

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};
use openai_rust_sdk::models::threads::ThreadRequest;

let api = ThreadsApi::new("your-api-key")?;
let thread_request = ThreadRequest::builder()
    .metadata_pair("purpose", "customer_support")
    .build();

let thread = api.create_thread(thread_request).await?;
println!("Created thread: {}", thread.id);

pub async fn retrieve_thread( &self, thread_id: impl Into<String>, ) -> Result<Thread>

Retrieve a thread by its ID

Arguments

• thread_id - The ID of the thread to retrieve

Returns

Returns the thread object

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};

let api = ThreadsApi::new("your-api-key")?;
let thread = api.retrieve_thread("thread_abc123").await?;
println!("Thread metadata: {:?}", thread.metadata);

pub async fn modify_thread( &self, thread_id: impl Into<String>, request: ThreadRequest, ) -> Result<Thread>

Modify a thread’s metadata

Arguments

• thread_id - The ID of the thread to modify
• request - The thread modification request

Returns

Returns the modified thread object

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};
use openai_rust_sdk::models::threads::ThreadRequest;

let api = ThreadsApi::new("your-api-key")?;
let thread_request = ThreadRequest::builder()
    .metadata_pair("status", "resolved")
    .build();

let thread = api.modify_thread("thread_abc123", thread_request).await?;
println!("Modified thread: {}", thread.id);

pub async fn delete_thread( &self, thread_id: impl Into<String>, ) -> Result<DeletionStatus>

Delete a thread

Arguments

• thread_id - The ID of the thread to delete

Returns

Returns the deletion status

Example

use openai_rust_sdk::api::{threads::ThreadsApi, common::ApiClientConstructors};

let api = ThreadsApi::new("your-api-key")?;
let deleted = api.delete_thread("thread_abc123").await?;
println!("Deleted: {}", deleted.deleted);

Trait Implementations

impl ApiClientConstructors for ThreadsApi

fn from_http_client(http_client: HttpClient) -> Self

Create a new instance with the HTTP client

fn new<S: Into<String>>(api_key: S) -> Result<Self>

Creates a new API client

fn new_with_base_url<S: Into<String>>(api_key: S, base_url: S) -> Result<Self>

Creates a new API client with custom base URL

impl Clone for ThreadsApi

fn clone(&self) -> ThreadsApi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThreadsApi

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.