List Run Steps

Supported Providers

• OpenAI

Returns a list of run steps belonging to a run.

get

Authorizations

Portkey-KeyVirtual-KeyProvider-AuthProvider-NameConfigCustom-Host

Path parameters

thread_idstringRequired

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

run_idstringRequired

The ID of the run the run steps belong to.

Query parameters

limitintegerOptional

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

Default: 20

orderstring · enumOptional

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

Default: descPossible values:

afterstringOptional

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.

beforestringOptional

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.

Responses

200

OK

application/json

get

curlpythonjavascript

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

OK

{
  "object": "list",
  "data": [
    {
      "id": "text",
      "object": "thread.run.step",
      "created_at": 1,
      "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"
      },
      "expired_at": 1,
      "cancelled_at": 1,
      "failed_at": 1,
      "completed_at": 1,
      "metadata": {},
      "usage": {
        "completion_tokens": 1,
        "prompt_tokens": 1,
        "total_tokens": 1
      }
    }
  ],
  "first_id": "step_abc123",
  "last_id": "step_abc456",
  "has_more": false
}