run_steps
Creates, updates, deletes, gets or lists a run_steps
resource.
Overview
Name | run_steps |
Type | Resource |
Id | openai.assistants.run_steps |
Fields
Name | Datatype | Description |
---|---|---|
id | string | The identifier of the run step, which can be referenced in API endpoints. |
assistant_id | string | The ID of the assistant associated with the run step. |
cancelled_at | integer | The Unix timestamp (in seconds) for when the run step was cancelled. |
completed_at | integer | The Unix timestamp (in seconds) for when the run step completed. |
created_at | integer | The Unix timestamp (in seconds) for when the run step was created. |
expired_at | integer | The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired. |
failed_at | integer | The Unix timestamp (in seconds) for when the run step failed. |
last_error | object | The last error associated with this run step. Will be null if there are no errors. |
metadata | object | Set 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. |
object | string | The object type, which is always thread.run.step . |
run_id | string | The ID of the run that this run step is a part of. |
status | string | The status of the run step, which can be either in_progress , cancelled , failed , completed , or expired . |
step_details | object | The details of the run step. |
thread_id | string | The ID of the thread that was run. |
type | string | The type of run step, which can be either message_creation or tool_calls . |
usage | object | Usage statistics related to the run step. This value will be null while the run step's status is in_progress . |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_run_step | SELECT | run_id, step_id, thread_id | |
list_run_steps | SELECT | run_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 }}';