OMomnistack-sh
Assistants

Retrieve run step

Changed on

Retrieves a run step.

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

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}
  • Auth
    HTTP bearer

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.

metadataMetadata 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, 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.

Changes

  • 487892d3954eRevision changes
    • info

      added the optional property // to the response with the status

  • 7f654af7f94fRevision changes
    • breaking

      response property cancelled_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property completed_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property expired_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property failed_at list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property metadata list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property step_details/oneOf[subschema #2: Tool calls]/tool_calls/items/oneOf[subschema #3: Function tool call]/function/output list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      added the new auto enum value to the /////// response property for the response status

    • info

      added the non-success response with the status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status