list Run

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 belongs to.

Query Parameters

limit

integer

default:

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

data

object[]

required

data.assistant_id

string

required

The ID of the assistant used for execution of this run.

data.cancelled_at

integer | null

required

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

data.completed_at

integer | null

required

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

data.created_at

integer

required

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

data.expires_at

integer | null

required

The Unix timestamp (in seconds) for when the run will expire.

data.failed_at

integer | null

required

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

data.id

string

required

The identifier, which can be referenced in API endpoints.

data.incomplete_details

object | null

required

Details on why the run is incomplete. Will be null if the run is not incomplete.

data.instructions

string

required

The instructions that the assistant used for this run.

data.last_error

object | null

required

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

data.max_completion_tokens

integer | null

required

The maximum number of completion tokens specified to have been used over the course of the run.

Required range: x > 256

data.max_prompt_tokens

integer | null

required

The maximum number of prompt tokens specified to have been used over the course of the run.

Required range: x > 256

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

string

required

The model that the assistant used for this run.

data.object

enum<string>

required

The object type, which is always thread.run.

Available options:

thread.run

data.parallel_tool_calls

boolean

default:

true

required

Whether to enable parallel function calling during tool use.

data.required_action

object | null

required

Details on the action required to continue the run. Will be null if no action is required.

data.response_format

required

Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON.

Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

Available options:

none,

auto

data.started_at

integer | null

required

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

data.status

enum<string>

required

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

Available options:

queued,

in_progress,

requires_action,

cancelling,

cancelled,

failed,

completed,

incomplete,

expired

data.thread_id

string

required

The ID of the thread that was executed on as a part of this run.

data.tool_choice

required

Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

Available options:

none,

auto,

required

data.tools

object[]

required

The list of tools that the assistant used for this run.

data.truncation_strategy

object

required

Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.

data.usage

object | null

required

Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).

data.temperature

number | null

The sampling temperature used for this run. If not set, defaults to 1.

data.top_p

number | null

The nucleus sampling value used for this run. If not set, defaults to 1.

first_id

string

required

has_more

boolean

required

last_id

string

required

object

string

required

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