List Runs

Supported Providers

• OpenAI

Returns a list of runs belonging to a thread.

get

Authorizations

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

Path parameters

thread_idstringRequired

The ID of the thread the run belongs 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 \
  -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",
      "created_at": 1,
      "thread_id": "text",
      "assistant_id": "text",
      "status": "queued",
      "required_action": {
        "type": "submit_tool_outputs",
        "submit_tool_outputs": {
          "tool_calls": [
            {
              "id": "text",
              "type": "function",
              "function": {
                "name": "text",
                "arguments": "text"
              }
            }
          ]
        }
      },
      "last_error": {
        "code": "server_error",
        "message": "text"
      },
      "expires_at": 1,
      "started_at": 1,
      "cancelled_at": 1,
      "failed_at": 1,
      "completed_at": 1,
      "incomplete_details": {
        "reason": "max_completion_tokens"
      },
      "model": "text",
      "instructions": "text",
      "tools": [
        {
          "type": "code_interpreter"
        }
      ],
      "metadata": {},
      "usage": {
        "completion_tokens": 1,
        "prompt_tokens": 1,
        "total_tokens": 1
      },
      "temperature": 1,
      "top_p": 1,
      "max_prompt_tokens": 1,
      "max_completion_tokens": 1,
      "truncation_strategy": {
        "type": "auto",
        "last_messages": 1
      },
      "tool_choice": "none",
      "parallel_tool_calls": true,
      "response_format": "none"
    }
  ],
  "first_id": "run_abc123",
  "last_id": "run_abc456",
  "has_more": false
}