data class MessageCreationStep( val id: RunStepId, val createdAt: Int, val assistantId: AssistantId, val threadId: ThreadId, val runId: RunId, val status: Status, val stepDetails: MessageCreationStepDetails, val lastError: LastError? = null, val expiredAt: Int? = null, val cancelledAt: Int? = null, val failedAt: Int? = null, val completedAt: Int? = null, val metadata: Map<String, String>? = null) : RunStep

MessageCreationStepDetails

@Serializable

@SerialName(value = "message_creation")

data class MessageCreationStepDetails(val messageCreation: MessageCreation) : RunStepDetails

Details of the message creation by the run step.

MessageDelta

@Serializable

data class MessageDelta(val id: MessageId, val object: String, val delta: MessageDeltaData)

Represents a message delta i.e. any changed fields on a message during streaming.

MessageDeltaData

@Serializable

data class MessageDeltaData(val role: Role, val content: MessageContent)

The delta containing the fields that have changed on the message.

RequiredAction

@Serializable

sealed interface RequiredAction

Details on the action required to continue the run.

Run

@Serializable

data class Run( val id: RunId, val createdAt: Int, val threadId: ThreadId, val assistantId: AssistantId, val status: Status, val requiredAction: RequiredAction? = null, val lastError: LastError? = null, val expiresAt: Int? = null, val startedAt: Int? = null, val cancelledAt: Int? = null, val failedAt: Int? = null, val completedAt: Int? = null, val model: ModelId, val instructions: String? = null, val tools: List<AssistantTool>? = null, val fileIds: List<String>? = null, val metadata: Map<String, String>? = null, val usage: Usage? = null, val temperature: Double? = null, val topP: Double? = null, val maxPromptTokens: Int? = null, val maxCompletionTokens: Int? = null)

Represents an execution run on a thread.

RunId

@Serializable

@JvmInline

value class RunId(val id: String)

A run id.

RunRequest

@Serializable

data class RunRequest( val assistantId: AssistantId, val model: ModelId? = null, val instructions: String? = null, val additionalInstructions: String? = null, val tools: List<AssistantTool>? = null, val metadata: Map<String, String>? = null, val stream: Boolean = false)

Create a run request.

RunRequestBuilder

class RunRequestBuilder

Builder for RunRequest.

RunStep

@Serializable

sealed interface RunStep

RunStepDelta

@Serializable

data class RunStepDelta(val id: RunStepId, val object: String, val delta: RunStepDeltaData)

Represents a run step delta i.e. any changed fields on a run step during streaming.

RunStepDeltaData

@Serializable

data class RunStepDeltaData(val stepDetails: RunStepDetails)

The delta containing the fields that have changed on the run step.

RunStepDetails

@Serializable

sealed interface RunStepDetails

A run step object.

RunStepId

@Serializable

@JvmInline

value class RunStepId(val id: String)

A run step id.

ThreadRunRequest

@Serializable

data class ThreadRunRequest( val assistantId: AssistantId, val thread: ThreadRequest? = null, val model: ModelId? = null, val instructions: String? = null, val tools: List<AssistantTool>? = null, val metadata: Map<String, String>? = null, val stream: Boolean = false)

Create a thread and run it in one request.

ThreadRunRequestBuilder

class ThreadRunRequestBuilder

Create a thread and run it in one request.

ToolCallsStep

@Serializable

@SerialName(value = "tool_calls")

data class ToolCallsStep( val id: RunStepId, val createdAt: Int, val assistantId: AssistantId, val threadId: ThreadId, val runId: RunId, val status: Status, val stepDetails: ToolCallStepDetails, val lastError: LastError? = null, val expiredAt: Int? = null, val cancelledAt: Int? = null, val failedAt: Int? = null, val completedAt: Int? = null, val metadata: Map<String, String>? = null) : RunStep

ToolCallStep

@Serializable

sealed interface ToolCallStep

ToolCallStepDetails

@Serializable

@SerialName(value = "tool_calls")

data class ToolCallStepDetails(val toolCalls: List<ToolCallStep>? = null) : RunStepDetails

Details of the tool call.

ToolCallStepId

@JvmInline

@Serializable

value class ToolCallStepId(val id: String)