Returns a list of run steps belonging to a run.

GET

/threads/{thread_id}/runs/{run_id}/steps

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

thread_id

required

string

The ID of the thread the run and run steps belong to.

run_id

required

string

The ID of the run the run steps belong to.

Query Parameters

limit

integer

default: 20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order

string

default: desc

Allowed values: asc desc

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

after

string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

before

string

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

include[]

Array<string>

Allowed values: step_details.tool_calls[*].file_search.results[*].content

A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.

See the file search tool documentation for more information.

Responses

200

OK

object

object

required

string

list

data

required

Array<object>

Represents a step in execution of a run.

object

id

required

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

string

object

required

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

string

Allowed values: thread.run.step

created_at

required

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

integer

assistant_id

required

The ID of the assistant associated with the run step.

string

thread_id

required

The ID of the thread that was run.

string

run_id

required

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

string

type

required

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

string

Allowed values: message_creation tool_calls

status

required

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

string

Allowed values: in_progress cancelled failed completed expired

step_details

required

One of:

Message creation

Details of the message creation by the run step.

object

type

required

Always message_creation.

string

Allowed values: message_creation

message_creation

required

object

message_id

required

The ID of the message that was created by this run step.

string

Tool calls

Details of the tool call.

object

type

required

Always tool_calls.

string

Allowed values: tool_calls

tool_calls

required

An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.

Array

One of:

Code Interpreter tool call

Details of the Code Interpreter tool call the run step was involved in.

object

id

required

The ID of the tool call.

string

type

required

The type of tool call. This is always going to be code_interpreter for this type of tool call.

string

Allowed values: code_interpreter

code_interpreter

required

The Code Interpreter tool call definition.

object

input

required

The input to the Code Interpreter tool call.

string

outputs

required

The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.

Array<object>

One of:

Code Interpreter log output

Text output from the Code Interpreter tool call as part of a run step.

object

type

required

Always logs.

string

Allowed values: logs

logs

required

The text output from the Code Interpreter tool call.

string

Code Interpreter image output

object

type

required

Always image.

string

Allowed values: image

image

required

object

file_id

required

The file ID of the image.

string

File search tool call

object

id

required

The ID of the tool call object.

string

type

required

The type of tool call. This is always going to be file_search for this type of tool call.

string

Allowed values: file_search

file_search

required

For now, this is always going to be an empty object.

object

ranking_options

The ranking options for the file search.

object

ranker

required

The ranker used for the file search.

string

Allowed values: default_2024_08_21

score_threshold

required

The score threshold for the file search. All values must be a floating point number between 0 and 1.

number

<= 1

results

The results of the file search.

Array<object>

A result instance of the file search.

object

file_id

required

The ID of the file that result was found in.

string

file_name

required

The name of the file that result was found in.

string

score

required

The score of the result. All values must be a floating point number between 0 and 1.

number

<= 1

content

The content of the result that was found. The content is only included if requested via the include query parameter.

Array<object>

object

type

The type of the content.

string

Allowed values: text

text

The text content of the file.

string

Function tool call

object

id

required

The ID of the tool call object.

string

type

required

The type of tool call. This is always going to be function for this type of tool call.

string

Allowed values: function

function

required

The definition of the function that was called.

object

name

required

The name of the function.

string

arguments

required

The arguments passed to the function.

string

output

required

The output of the function. This will be null if the outputs have not been submitted yet.

string

nullable

last_error

required

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

object

code

required

One of server_error or rate_limit_exceeded.

string

Allowed values: server_error rate_limit_exceeded

message

required

A human-readable description of the error.

string

expired_at

required

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

integer

nullable

cancelled_at

required

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

integer

nullable

failed_at

required

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

integer

nullable

completed_at

required

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

integer

nullable

metadata

required

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

usage

required

Usage statistics related to the run step. This value will be null while the run step’s status is in_progress.

object

completion_tokens

required

Number of completion tokens used over the course of the run step.

integer

prompt_tokens

required

Number of prompt tokens used over the course of the run step.

integer

total_tokens

required

Total number of tokens used (prompt + completion).

integer

first_id

required

string

step_abc123

last_id

required

string

step_abc456

has_more

required

boolean