Shared API types

These support types provide event identity and structured errors where the linked operations and events use them. They are not a universal HTTP error envelope: an error from another operation, authentication layer or upstream can have a different body.

Support types and actual uses

Type	Used by
ErrorDetails	Send a message and wait for the result; Submit client-side tool results and wait for the next segment; Submit client-side tool execution results; llm.generation_completed
ErrorInfo	Send a message and wait for the result; Submit client-side tool results and wait for the next segment; Submit client-side tool execution results; llm.generation_completed
EventContext	llm.generation_completed; llm.generation_started; llm.message_published; llm.tool_call_approval_required; llm.tool_call_completed; llm.tool_call_started
FieldViolation	Send a message and wait for the result; Submit client-side tool results and wait for the next segment; Submit client-side tool execution results; llm.generation_completed
HelpLink	Send a message and wait for the result; Submit client-side tool results and wait for the next segment; Submit client-side tool execution results; llm.generation_completed
ModelError	Send a message and wait for the result; Submit client-side tool results and wait for the next segment; Submit client-side tool execution results; llm.generation_completed
RetryInfo	Send a message and wait for the result; Submit client-side tool results and wait for the next segment; Submit client-side tool execution results; llm.generation_completed
RpcError	Send a message and wait for the result; Submit client-side tool results and wait for the next segment; Submit client-side tool execution results; llm.generation_completed
UpstreamError	Send a message and wait for the result; Submit client-side tool results and wait for the next segment; Submit client-side tool execution results; llm.generation_completed

Models reused across APIs

Reusable domain models stay with their owning capability. The following types are reached by operations in more than one API bundle; their pages show the exact operation and payload profiles.

Model	API bundles
Backoff	agent-profiles; conversations; end-users
FileResolutionConfig	agent-profiles; conversations; end-users
GenerationConfig	agent-profiles; conversations; end-users
MCPServerReference	agent-profiles; conversations
MemoryConfig	agent-profiles; conversations; end-users
ModelRoutingFilter	agent-profiles; conversations; end-users
PercentileThreshold	agent-profiles; conversations; end-users
PluginConfig	agent-profiles; conversations; end-users
PluginPDFConfig	agent-profiles; conversations; end-users
PluginWebConfig	agent-profiles; conversations; end-users
ProviderMaxPrice	agent-profiles; conversations; end-users
ProviderPreferences	agent-profiles; conversations; end-users
ReasoningOptions	agent-profiles; conversations; end-users
ResponseFormat	agent-profiles; conversations; end-users
StopOnFailureRule	agent-profiles; conversations; end-users
TimeAwareConfig	agent-profiles; conversations; end-users
TimeoutPolicy	agent-profiles; conversations; end-users
ToolChoice	agent-profiles; conversations; end-users
ToolDefinition	agent-profiles; conversations; end-users
ToolExecutionOrderRule	agent-profiles; conversations; end-users
ToolExecutionPolicy	agent-profiles; conversations; end-users
TurnContextConfig	agent-profiles; conversations; end-users
UsageOptions	agent-profiles; conversations; end-users
WebSearchOptions	agent-profiles; conversations; end-users

See the event catalog for outgoing payloads and the API reference for operation-specific request and response bodies.

Document: DOC-API-shared-types.