Skip to main content

Get Run Step

Retrieves a run step.

Path Parameters
thread_id Thread Id REQUIRED
run_id Run Id REQUIRED
step_id Step Id REQUIRED
Responses
200

Successful Response

Schema OPTIONAL
_id Id OPTIONAL

MongoDB document ObjectID

id Id

The identifier of the run step, which can be referenced in API endpoints.

object Object27

Possible values: [thread.run.step]

The object type, which is always `thread.run.step``.

created_at Created At

The Unix timestamp (in seconds) for when the run step was created.

assistant_id Assistant Id

The ID of the assistant associated with the run step.

thread_id Thread Id

The ID of the thread that was run.

run_id Run Id

The ID of the run that this run step is a part of.

type Type16

Possible values: [message_creation, tool_calls]

The type of run step, which can be either message_creation or tool_calls.

status Status3

Possible values: [in_progress, cancelled, failed, completed, expired]

The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.

step_details Step Details

The details of the run step.

last_error object

The last error associated with this run step. Will be null if there are no errors.

code Code1

Possible values: [server_error, rate_limit_exceeded]

One of server_error or rate_limit_exceeded.

message Message

A human-readable description of the error.

expired_at Expired At

The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.

cancelled_at Cancelled At

The Unix timestamp (in seconds) for when the run step was cancelled.

failed_at Failed At

The Unix timestamp (in seconds) for when the run step failed.

completed_at Completed At

The Unix timestamp (in seconds) for when the run step completed.

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 maxium of 512 characters long.

422

Validation Error

Schema OPTIONAL
detail object[] OPTIONAL
loc undefined[]
msg Message
type Error Type