Share via


AgentThreadOutput interface

Information about a single thread associated with an agent.

Properties

createdAt

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

id

The identifier, which can be referenced in API endpoints.

metadata

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.

object

The object type, which is always 'thread'.

toolResources

A set of resources that are made available to the agent's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Property Details

createdAt

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

createdAt: Date

Property Value

Date

id

The identifier, which can be referenced in API endpoints.

id: string

Property Value

string

metadata

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.

metadata: null | Record<string, string>

Property Value

null | Record<string, string>

object

The object type, which is always 'thread'.

object: "thread"

Property Value

"thread"

toolResources

A set of resources that are made available to the agent's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

toolResources: null | ToolResourcesOutput

Property Value