Sign in
Assistants

Retrieves a run step.

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

Path parameters

thread_idstring required

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

run_idstring required

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

step_idstring required

The ID of the run step to retrieve.

Query parameters

include[]string[]

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.

Response

OK

idstring required

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

object'thread.run.step' required

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

created_atinteger required

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

assistant_idstring required

The ID of the assistant associated with the run step.

thread_idstring required

The ID of the thread that was run.

run_idstring required

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

type'message_creation' | 'tool_calls' required

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

status'in_progress' | 'cancelled' | 'failed' | 'completed' | 'expired' required

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

expired_atinteger nullable required

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

cancelled_atinteger nullable required

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

failed_atinteger nullable required

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

completed_atinteger nullable required

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

metadataobject nullable 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.

Changes

Changed in 1 of the 35 revisions of this API.3

  • 1dbac0e95bdb3See the full diff
    • ○

      added the new optional query request parameter include[]

      new-optional-request-parameter

    • ○

      added the optional property step_details/oneOf[subschema #2: Tool calls]/tool_calls/items/oneOf[subschema #2: File search tool call]/file_search/ranking_options to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property step_details/oneOf[subschema #2: Tool calls]/tool_calls/items/oneOf[subschema #2: File search tool call]/file_search/results to the response with the 200 status

      response-optional-property-added