List Run Steps

GET

threads

{thread_id}

runs

{run_id}

steps

curl https://api.portkey.ai/v1/threads/thread_abc123/runs/run_abc123/steps \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "Content-Type: application/json" \
  -H "OpenAI-Beta: assistants=v2"

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "thread.run.step",
      "created_at": 123,
      "assistant_id": "<string>",
      "thread_id": "<string>",
      "run_id": "<string>",
      "type": "message_creation",
      "status": "in_progress",
      "step_details": {
        "type": "message_creation",
        "message_creation": {
          "message_id": "<string>"
        }
      },
      "last_error": {
        "code": "server_error",
        "message": "<string>"
      },
      "expired_at": 123,
      "cancelled_at": 123,
      "failed_at": 123,
      "completed_at": 123,
      "metadata": {},
      "usage": {
        "completion_tokens": 123,
        "prompt_tokens": 123,
        "total_tokens": 123
      }
    }
  ],
  "first_id": "step_abc123",
  "last_id": "step_abc456",
  "has_more": false
}

Authorizations

x-portkey-api-key

string

header

required

x-portkey-virtual-key

string

header

required

Path Parameters

thread_id

string

required

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

run_id

string

required

The ID of the run the run steps belong to.

Query Parameters

limit

integer

default:20

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

order

enum<string>

default:desc

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

Available options:

asc,

desc

after

string

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.

before

string

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

Response

200 - application/json

object

string

required

Example:

"list"

data

object[]

required

Represents a step in execution of a run.

data.id

string

required

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

data.object

enum<string>

required

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

Available options:

thread.run.step

data.created_at

integer

required

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

data.assistant_id

string

required

The ID of the assistant associated with the run step.

data.thread_id

string

required

The ID of the thread that was run.

data.run_id

string

required

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

data.type

enum<string>

required

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

Available options:

message_creation,

tool_calls

data.status

enum<string>

required

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

Available options:

in_progress,

cancelled,

failed,

completed,

expired

data.step_details

object

required

The details of the run step.

data.last_error

object | null

required

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

data.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.

data.cancelled_at

integer | null

required

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

data.failed_at

integer | null

required

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

data.completed_at

integer | null

required

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

data.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.

data.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.

first_id

string

required

Example:

"step_abc123"

last_id

string

required

Example:

"step_abc456"

has_more

boolean

required

Example:

false

Was this page helpful?

Suggest edits Raise issue

Cancel Run Retrieve Run Steps

curl https://api.portkey.ai/v1/threads/thread_abc123/runs/run_abc123/steps \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -H "Content-Type: application/json" \
  -H "OpenAI-Beta: assistants=v2"

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "thread.run.step",
      "created_at": 123,
      "assistant_id": "<string>",
      "thread_id": "<string>",
      "run_id": "<string>",
      "type": "message_creation",
      "status": "in_progress",
      "step_details": {
        "type": "message_creation",
        "message_creation": {
          "message_id": "<string>"
        }
      },
      "last_error": {
        "code": "server_error",
        "message": "<string>"
      },
      "expired_at": 123,
      "cancelled_at": 123,
      "failed_at": 123,
      "completed_at": 123,
      "metadata": {},
      "usage": {
        "completion_tokens": 123,
        "prompt_tokens": 123,
        "total_tokens": 123
      }
    }
  ],
  "first_id": "step_abc123",
  "last_id": "step_abc456",
  "has_more": false
}

API Reference

Chat Completions

Portkey Prompts

Embeddings

Images

Audio

Realtime

Other APIs

Completions

Moderations

Fine-tuning

Batch

Files

Assistants

Authorizations

Path Parameters

Query Parameters

Response