RunCompletionUsage
objectUsage 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.).
Number of completion tokens used over the course of the run.
Number of prompt tokens used over the course of the run.
Total number of tokens used (prompt + completion).
A run on a thread
objectRepresents an execution run on a thread.
The identifier, which can be referenced in API endpoints.
The object type, which is always thread.run.
Allowed values:thread.run
The Unix timestamp (in seconds) for when the run was created.
The ID of the thread that was executed on as a part of this run.
The ID of the assistant used for execution of this run.
The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.
Allowed values:queuedin_progressrequires_actioncancellingcancelledfailedcompletedincompleteexpired
Details on the action required to continue the run. Will be null if no action is required.
Show Child Parameters
The last error associated with this run. Will be null if there are no errors.
Show Child Parameters
The Unix timestamp (in seconds) for when the run will expire.
The Unix timestamp (in seconds) for when the run was started.
The Unix timestamp (in seconds) for when the run was cancelled.
The Unix timestamp (in seconds) for when the run failed.
The Unix timestamp (in seconds) for when the run was completed.
Details on why the run is incomplete. Will be null if the run is not incomplete.
Show Child Parameters
The model that the assistant used for this run.
The instructions that the assistant used for this run.
One OfThe list of tools that the assistant used for this run.
Default:[]
<= 20 items
Show Child Parameters
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, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
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.).
Show Child Parameters
The sampling temperature used for this run. If not set, defaults to 1.
The nucleus sampling value used for this run. If not set, defaults to 1.
The maximum number of prompt tokens specified to have been used over the course of the run.
>= 256
The maximum number of completion tokens specified to have been used over the course of the run.
>= 256
Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.
Show Child Parameters
One Ofnone means the model will not call any tools and instead generates a message. auto 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.
Allowed values:noneautorequired
Whether to enable parallel function calling during tool use.
Default:true
One Ofauto is the default value
Allowed values:auto
RunStepCompletionUsage
objectUsage statistics related to the run step. This value will be null while the run step’s status is in_progress.
Number of completion tokens used over the course of the run step.
Number of prompt tokens used over the course of the run step.
Total number of tokens used (prompt + completion).
Run step delta object
objectRepresents a run step delta i.e. any changed fields on a run step during streaming.
The identifier of the run step, which can be referenced in API endpoints.
The object type, which is always thread.run.step.delta.
Allowed values:thread.run.step.delta
The delta containing the fields that have changed on the run step.
Show Child Parameters
Message creation
objectDetails of the message creation by the run step.
Always message_creation.
Allowed values:message_creation