Skip to main content

run_steps

Creates, updates, deletes, gets or lists a run_steps resource.

Overview

Namerun_steps
TypeResource
Idopenai.assistants.run_steps

Fields

NameDatatypeDescription
idstringThe identifier of the run step, which can be referenced in API endpoints.
assistant_idstringThe ID of the assistant associated with the run step.
cancelled_atintegerThe Unix timestamp (in seconds) for when the run step was cancelled.
completed_atintegerThe Unix timestamp (in seconds) for when the run step completed.
created_atintegerThe Unix timestamp (in seconds) for when the run step was created.
expired_atintegerThe Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.
failed_atintegerThe Unix timestamp (in seconds) for when the run step failed.
last_errorobjectThe last error associated with this run step. Will be null if there are no errors.
metadataobjectSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.
objectstringThe object type, which is always thread.run.step.
run_idstringThe ID of the run that this run step is a part of.
statusstringThe status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
step_detailsobjectThe details of the run step.
thread_idstringThe ID of the thread that was run.
typestringThe type of run step, which can be either message_creation or tool_calls.
usageobjectUsage statistics related to the run step. This value will be null while the run step's status is in_progress.

Methods

NameAccessible byRequired ParamsDescription
get_run_stepSELECTrun_id, step_id, thread_id
list_run_stepsSELECTrun_id, thread_id

SELECT examples

SELECT
id,
assistant_id,
cancelled_at,
completed_at,
created_at,
expired_at,
failed_at,
last_error,
metadata,
object,
run_id,
status,
step_details,
thread_id,
type,
usage
FROM openai.assistants.run_steps
WHERE run_id = '{{ run_id }}'
AND thread_id = '{{ thread_id }}';