Retrieve Run Steps

Retrieves a run step.

GEThttps://api.portkey.ai/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}

Path parameters

thread_id*string

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

run_id*string

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

step_id*string

The ID of the run step to retrieve.

Response

200

OK

Body

application/json

id*string

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

object*enum

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

thread.run.step

created_at*integer

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

assistant_id*string

The ID of the assistant associated with the run step.

thread_id*string

The ID of the thread that was run.

run_id*string

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

type*enum

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

message_creationtool_calls

status*enum

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

in_progresscancelledfailedcompletedexpired

step_details*object

The details of the run step.

Message creationTool calls

last_error*nullable object

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

expired_at*nullable integer

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

cancelled_at*nullable integer

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

failed_at*nullable integer

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

completed_at*nullable integer

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

metadata*nullable object

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*nullable RunStepCompletionUsage (object)

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

Response

{
  "id": "text",
  "object": "thread.run.step",
  "assistant_id": "text",
  "thread_id": "text",
  "run_id": "text",
  "type": "message_creation",
  "status": "in_progress",
  "step_details": {
    "type": "message_creation",
    "message_creation": {
      "message_id": "text"
    }
  },
  "last_error": {
    "code": "server_error",
    "message": "text"
  },
  "usage": {}
}