Class Runs

steps

cancel

• cancel(threadId, runId, options?): APIPromise<Run>

• Cancels a run that is in_progress.

  Parameters

  • threadId: string

  • runId: string

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<Run>

create

• create(threadId, body, options?): APIPromise<Run>

• Create a run.

  Parameters

  • threadId: string

  • body: RunCreateParams

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<Run>

list

• list(threadId, query?, options?): PagePromise<RunsPage, Run>

• Returns a list of runs belonging to a thread.

  Parameters

  • threadId: string

  • Optional query: RunListParams

  • Optional options: RequestOptions<unknown>

  Returns PagePromise<RunsPage, Run>
• list(threadId, options?): PagePromise<RunsPage, Run>

• Parameters

  • threadId: string

  • Optional options: RequestOptions<unknown>

  Returns PagePromise<RunsPage, Run>

retrieve

• retrieve(threadId, runId, options?): APIPromise<Run>

• Retrieves a run.

  Parameters

  • threadId: string

  • runId: string

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<Run>

submitToolOutputs

• submitToolOutputs(threadId, runId, body, options?): APIPromise<Run>

• When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, 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.

  Parameters

  • threadId: string

  • runId: string

  • body: RunSubmitToolOutputsParams

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<Run>

update

• update(threadId, runId, body, options?): APIPromise<Run>

• Modifies a run.

  Parameters

  • threadId: string

  • runId: string

  • body: RunUpdateParams

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<Run>