Assistants

Returns a list of run steps belonging to a run.

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

Request

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

Path parameters

thread_idstring required

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

run_idstring required

The ID of the run the run steps belong to.

Query parameters

limitinteger

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

order'asc' | 'desc'

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

afterstring

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.

beforestring

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, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

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

objectstring required
first_idstring required
last_idstring required
has_moreboolean required

Changes

    • info

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      response property data/items/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