Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 3.03 KB

RunObject.md

File metadata and controls

54 lines (38 loc) · 3.03 KB

RunObject

Represents an execution run on a thread.

Properties

Name Type Description Notes
id String The identifier, which can be referenced in API endpoints.
_object ObjectEnum The object type, which is always `thread.run`.
createdAt Integer The Unix timestamp (in seconds) for when the run was created.
threadId String The ID of the thread that was executed on as a part of this run.
assistantId String The ID of the assistant used for execution of this run.
status StatusEnum The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`.
requiredAction RunObjectRequiredAction [optional]
lastError RunObjectLastError [optional]
expiresAt Integer The Unix timestamp (in seconds) for when the run will expire. [optional]
startedAt Integer The Unix timestamp (in seconds) for when the run was started. [optional]
cancelledAt Integer The Unix timestamp (in seconds) for when the run was cancelled. [optional]
failedAt Integer The Unix timestamp (in seconds) for when the run failed. [optional]
completedAt Integer The Unix timestamp (in seconds) for when the run was completed. [optional]
model String The model that the assistant used for this run.
instructions String The instructions that the assistant used for this run.
tools List<AssistantObjectToolsInner> The list of tools that the assistant used for this run.
fileIds List<String> The list of File IDs the assistant used for this run.
metadata Object 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.

Enum: ObjectEnum

Name Value
THREAD_RUN "thread.run"

Enum: StatusEnum

Name Value
QUEUED "queued"
IN_PROGRESS "in_progress"
REQUIRES_ACTION "requires_action"
CANCELLING "cancelling"
CANCELLED "cancelled"
FAILED "failed"
COMPLETED "completed"
EXPIRED "expired"