NAME

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

DESCRIPTION

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

PATHS

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

Retrieves a run step.

Operation ID

getRunStep

$client->getRunStep( ... );

Parameters

• thread_id (in path) (Required) - The ID of the thread to which the run and run step belongs.

  Type: string

• run_id (in path) (Required) - The ID of the run to which the run step belongs.

  Type: string

• step_id (in path) (Required) - The ID of the run step to retrieve.

  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):

  {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }

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.