List Run Steps

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

cURL

cURL

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"

200

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created_at": 123,
      "assistant_id": "<string>",
      "thread_id": "<string>",
      "run_id": "<string>",
      "step_details": {
        "message_creation": {
          "message_id": "<string>"
        }
      },
      "last_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

Portkey-Key & Virtual-KeyPortkey-Key & Provider-Auth & Provider-NamePortkey-Key & ConfigPortkey-Key & Provider-Auth & Provider-Name & Custom-Host

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

OK

object · string · required

Example:

"list"

data · Run steps · object[] · required

Show child attributes

first_id · string · required

Example:

"step_abc123"

last_id · string · required

Example:

"step_abc456"

has_more · boolean · required

Example:

false