Path parameters

• thread_id string Required

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

• run_id string Required

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

• step_id string Required

  The ID of the run step to retrieve.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id string Required

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

  • object string Required

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

    Value is thread.run.step.

  • created_at integer Required

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

  • assistant_id string Required

    The ID of the assistant associated with the run step.

  • thread_id string Required

    The ID of the thread that was run.

  • run_id string Required

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

  • type string Required

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

    Values are message_creation or tool_calls.

  • status string Required

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

    Values are in_progress, cancelled, failed, completed, or expired.

  • step_details object Required

    One of:

    Message creation object Tool calls object

    Details of the message creation by the run step.

    Hide attributes Show attributes

    • type string Required

      Always message_creation.

      Value is message_creation.

    • message_creation object Required
      Hide message_creation attribute Show message_creation attribute object

      • message_id string Required

        The ID of the message that was created by this run step.

    Details of the tool call.

    Hide attributes Show attributes

    • type string Required

      Always tool_calls.

      Value is tool_calls.

    • tool_calls array[object] Required

      An array of tool calls the run step was involved in. These can be associated with one of three types of tools: code_interpreter, file_search, or function.

      One of:

      Code Interpreter tool call object File search tool call object Function tool call object

      Details of the Code Interpreter tool call the run step was involved in.

      Hide attributes Show attributes

      • id string Required

        The ID of the tool call.

      • type string Required

        The type of tool call. This is always going to be code_interpreter for this type of tool call.

        Value is code_interpreter.

      • code_interpreter object Required

        The Code Interpreter tool call definition.

        Hide code_interpreter attributes Show code_interpreter attributes object

        • input string Required

          The input to the Code Interpreter tool call.

        • outputs array[object] Required

          The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (logs) or images (image). Each of these are represented by a different object type.

          One of:

          Code Interpreter log output object Code Interpreter image output object

          Text output from the Code Interpreter tool call as part of a run step.

          Hide attributes Show attributes

          • type string Required

            Always logs.

            Value is logs.

          • logs string Required

            The text output from the Code Interpreter tool call.

          Hide attributes Show attributes

          • type string Required

            Always image.

            Value is image.

          • image object Required
            Hide image attribute Show image attribute object

            • file_id string Required

              The file ID of the image.

      Hide attributes Show attributes

      • id string Required

        The ID of the tool call object.

      • type string Required

        The type of tool call. This is always going to be file_search for this type of tool call.

        Value is file_search.

      • file_search object Required

        For now, this is always going to be an empty object.

      Hide attributes Show attributes

      • id string Required

        The ID of the tool call object.

      • type string Required

        The type of tool call. This is always going to be function for this type of tool call.

        Value is function.

      • function object Required

        The definition of the function that was called.

        Hide function attributes Show function attributes object

        • name string Required

          The name of the function.

        • arguments string Required

          The arguments passed to the function.

        • output string | null Required

          The output of the function. This will be null if the outputs have not been submitted yet.

  • last_error object | null Required

    The last error associated with this run step. Will be null if there are no errors.

    Hide last_error attributes Show last_error attributes object | null

    • code string Required

      One of server_error or rate_limit_exceeded.

      Values are server_error or rate_limit_exceeded.

    • message string Required

      A human-readable description of the error.

  • expired_at integer | null Required

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

  • cancelled_at integer | null Required

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

  • failed_at integer | null Required

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

  • completed_at integer | null Required

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

  • metadata object | null 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 maxium of 512 characters long.

  • usage object | null Required

    Usage statistics related to the run step. This value will be null while the run step's status is in_progress.

    Hide usage attributes Show usage attributes object | null

    • completion_tokens integer Required

      Number of completion tokens used over the course of the run step.

    • prompt_tokens integer Required

      Number of prompt tokens used over the course of the run step.

    • total_tokens integer Required

      Total number of tokens used (prompt + completion).