runs_cancel_run_request: API runs: cancel a run

In oaii: 'OpenAI' API R Interface

API runs: cancel a run

Description

Cancels a run that is "in_progress". To get more details, visit https://platform.openai.com/docs/api-reference/runs/cancelRun https://platform.openai.com/docs/assistants

Usage

runs_cancel_run_request(thread_id, run_id, api_key = api_get_key())

Arguments

thread_id	string, the ID of the thread (https://platform.openai.com/docs/api-reference/threads) to which this run belongs
run_id	string, the ID of the run to cancel
api_key	string, OpenAI API key (see https://platform.openai.com/account/api-keys)

Value

content of the httr response object or SimpleError (conditions) enhanced with two additional fields: 'status_code' (response$status_code) and 'message_long' (built on response content)

oaii documentation built on May 29, 2024, 5:25 a.m.