Runs

interface Runs

Represents an execution run on a thread.

Inheritors

Functions

Link copied to clipboard
abstract suspend fun cancel(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Cancels a run that is Status.InProgress.

Link copied to clipboard
abstract suspend fun createRun(threadId: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create a run.

Link copied to clipboard
abstract suspend fun createStreamingRun(threadId: <Error class: unknown class>, request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Flow<<Error class: unknown class>>

Create a run with event streaming.

Link copied to clipboard
abstract suspend fun createStreamingThreadRun(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): Flow<<Error class: unknown class>>

Create a thread and run it in one request with event streaming.

Link copied to clipboard
abstract suspend fun createThreadRun(request: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Create a thread and run it in one request.

Link copied to clipboard
abstract suspend fun getRun(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Retrieves a run.

Link copied to clipboard
abstract suspend fun runs(threadId: <Error class: unknown class>, limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Returns a list of runs belonging to a thread.

Link copied to clipboard
abstract suspend fun runStep(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, stepId: <Error class: unknown class>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Retrieves a run step.

Link copied to clipboard
abstract suspend fun runSteps(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, limit: Int? = null, order: <Error class: unknown class>? = null, after: <Error class: unknown class>? = null, before: <Error class: unknown class>? = null, requestOptions: <Error class: unknown class>? = null): List<<Error class: unknown class>>

Retrieves a run step.

Link copied to clipboard
abstract suspend fun submitStreamingToolOutput(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, output: List<<Error class: unknown class>>, requestOptions: <Error class: unknown class>? = null): Flow<<Error class: unknown class>>

When a run has the status: Status.RequiresAction and required action is RequiredAction.SubmitToolOutputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request using event streaming.

Link copied to clipboard
abstract suspend fun submitToolOutput(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, output: List<<Error class: unknown class>>, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

When a run has the status: Status.RequiresAction and required action is RequiredAction.SubmitToolOutputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.

Link copied to clipboard
abstract suspend fun updateRun(threadId: <Error class: unknown class>, runId: <Error class: unknown class>, metadata: Map<String, String>? = null, requestOptions: <Error class: unknown class>? = null): <Error class: unknown class>

Modifies a run.