AgentsUpdateOptionalParams interface

Optional parameters.

Extends

Properties

blueprintReference

The blueprint reference for the agent.

description

A human-readable description of the agent.

foundryFeatures

Opt in to preview features in the agent definition. Realtime/cascaded voice definitions, delegate subagents, and phone system tools do not require a flag. GPT Live, Handoff/inline subagents, SIP transfer destinations, and post_call require VoiceAgents=V1Preview. The transfer tool's require_handoff summary setting remains GA.

metadata

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.

Inherited Properties

abortSignal

The signal which can be used to abort requests.

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

requestOptions

Options used when creating and sending HTTP requests for this operation.

tracingOptions

Options used when tracing is enabled.

Property Details

blueprintReference

The blueprint reference for the agent.

blueprintReference?: AgentBlueprintReferenceUnion

Property Value

description

A human-readable description of the agent.

description?: string

Property Value

string

foundryFeatures

Opt in to preview features in the agent definition. Realtime/cascaded voice definitions, delegate subagents, and phone system tools do not require a flag. GPT Live, Handoff/inline subagents, SIP transfer destinations, and post_call require VoiceAgents=V1Preview. The transfer tool's require_handoff summary setting remains GA.

foundryFeatures?: AgentDefinitionOptInKeys

Property Value

metadata

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.

metadata?: Record<string, string>

Property Value

Record<string, string>

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From OperationOptions.tracingOptions