Get Run Step

Retrieves a run step.

Options

OpenAI Beta

Calls to the Assistants API require that you pass a beta HTTP header.

Thread Id

The ID of the thread to which the run and run step belongs.

Run Id

The ID of the run to which the run step belongs.

Step Id

The ID of the run step to retrieve.

Set Include[]

Enable to set the optional field Include[]

Include[]

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.

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Id: The identifier of the run step, which can be referenced in API endpoints.
• Object: The object type, which is always thread.run.step.
• Created At: The Unix timestamp (in seconds) for when the run step was created.
• Assistant Id: The ID of the assistant associated with the run step.
• Thread Id: The ID of the thread that was run.
• Run Id: The ID of the run that this run step is a part of.
• Type: The type of run step, which can be either message_creation or tool_calls.
• Status: The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
• Step Details: The details of the run step.
• Last Error: The last error associated with this run step. Will be null if there are no errors.
• 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: The Unix timestamp (in seconds) for when the run step was cancelled.
• Failed At: The Unix timestamp (in seconds) for when the run step failed.
• Completed At: The Unix timestamp (in seconds) for when the run step completed.
• Metadata:

  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, and querying for objects via API or the dashboard.

  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

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

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers