Sign in

v3

latestSwagger 2.02026-07-1342207288.7 KB

Gets an existing run from an existing thread.

get/threads/{threadId}/runs/{runId}

Path parameters

threadIdstring required

Identifier of the thread.

runIdstring required

Identifier of the run.

Query parameters

api-versionstring required

The API version to use for this operation.

Response

The requested information about the specified thread run.

idstring required

The identifier, which can be referenced in API endpoints.

object'thread.run' required

The object type, which is always 'thread.run'.

thread_idstring required

The ID of the thread associated with this run.

assistant_idstring required

The ID of the agent associated with the thread this run was performed against.

status'queued' | 'in_progress' | 'requires_action' | 'cancelling' | 'cancelled' | 'failed' | 'completed' | 'expired' required

Possible values for the status of an agent thread run.

modelstring required

The ID of the model to use.

instructionsstring required

The overridden system instructions used for this agent thread run.

created_atinteger required

The Unix timestamp, in seconds, representing when this object was created.

expires_atinteger nullable required

The Unix timestamp, in seconds, representing when this item expires.

started_atinteger nullable required

The Unix timestamp, in seconds, representing when this item was started.

completed_atinteger nullable required

The Unix timestamp, in seconds, representing when this completed.

cancelled_atinteger nullable required

The Unix timestamp, in seconds, representing when this was cancelled.

failed_atinteger nullable required

The Unix timestamp, in seconds, representing when this failed.

temperaturenumber float nullable

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

top_pnumber float nullable

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

max_prompt_tokensinteger nullable required

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

max_completion_tokensinteger nullable required

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

{"stackTrail":"components:schemas:AgentsToolChoiceOption","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:AgentsResponseFormatOption","oasType":"schema","type":"unknown"}
metadataobject nullable required

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

parallel_tool_callsboolean required

Determines if tools can be executed in parallel within the run.