OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-steps(3)

NAME
OpenAPI::Client::OpenAI::Path::threads-thread_id-runs-run_id-steps - Documentation for the /threads/{thread_id}/runs/{run_id}/steps path.

DESCRIPTION
This document describes the API endpoint at "/threads/{thread_id}/runs/{run_id}/steps".

PATHS

  "GET /threads/{thread_id}/runs/{run_id}/steps"
Returns a list of run steps belonging to a run.

Operation ID

"listRunSteps"

    $client->listRunSteps( ... );

Parameters

•   "thread_id" (in path) (Required) - The ID of the thread the run and run steps belong to.

    Type: "string"

•   "run_id" (in path) (Required) - The ID of the run the run steps belong to.

    Type: "string"

•   "limit" (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

    Type: "integer"

    Default: 20

•   "order" (in query) (Optional) - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

    Type: "string"

    Allowed values: "asc, desc"

    Default: "desc"

•   "after" (in query) (Optional) - 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.

    Type: "string"

•   "before" (in query) (Optional) - 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.

    Type: "string"

•   "include[]" (in query) (Optional) - 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](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.

    Type: "array"

Responses

Status Code: 200

OK

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "data" : [
              "{\n  \"id\": \"step_abc123\",\n  \"object\": \"thread.run.step\",\n  \"created_at\": 1699063291,\n  \"run_id\": \"run_abc123\",\n  \"assistant_id\": \"asst_abc123\",\n  \"thread_id\": \"thread_abc123\",\n  \"type\": \"message_creation\",\n  \"status\": \"completed\",\n  \"cancelled_at\": null,\n  \"completed_at\": 1699063291,\n  \"expired_at\": null,\n  \"failed_at\": null,\n  \"last_error\": null,\n  \"step_details\": {\n    \"type\": \"message_creation\",\n    \"message_creation\": {\n      \"message_id\": \"msg_abc123\"\n    }\n  },\n  \"usage\": {\n    \"prompt_tokens\": 123,\n    \"completion_tokens\": 456,\n    \"total_tokens\": 579\n  }\n}\n"
           ],
           "first_id" : "step_abc123",
           "has_more" : false,
           "last_id" : "step_abc456",
           "object" : "list"
        }

SEE ALSO
OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.