API referenceSchemas
Schemas
Every shape the API sends or accepts.
The 246 named shapes in the contract. The operation pages inline each one where it is used; these pages exist so a $ref has somewhere to land.
A
AgentAgentIdAgentMessageEventAgentNotFoundEncodedAgentNotPromotableEncodedAgentNotReadyEncodedAgentReasoningDeltaEventAgentSlugAgentTextDeltaEventAgentVersionNumberApiKeyIdApiKeyNotFoundEncodedAuthUser
B
C
CachePrefixEventCachingModeCachingTtlChannelClientNameChannelIdChannelTokenIssuedCompactionModeCompactionModelCompactionPreserveConnectionConnectionAuthConnectionAuthorizationRequiredEventConnectionAuthorizedEventConnectionErrorEncodedConnectionGrantConnectionHookConnectionIdConnectionNameConnectionNameTakenEncodedConnectionNotFoundEncodedConnectionTransport
D
E
EffectiveModelEnvironmentArchivedEncodedEnvironmentIdEnvironmentKindEnvironmentNotFoundEncodedEnvironmentSlugTakenEncodedEventNotFoundEncodedEventSeqExecutedBy
F
G
H
HookConnectionStatsHookDeadLetterEventHookDeliveryHookDeliveryIdHookDeliveryNotFoundEncodedHookDeliveryPageHookDeliveryStatusHookStatsHookableEventType
I
IdentityIdentityAttributesTooLargeEncodedIdentityChangedEventIdentityIdIdentityNotSwitchableEncodedIdentityPolicyIdentityRequiredEncodedIdentityScopeIdentityScopeNotAllowedEncodedIdentityScopePatternImageStateImageStatusImageStatusReportImageStepImportModeInlineHookInlineHookAuthIssuableChannelKind
L
M
McpToolAnnotationsMcpToolConfigMembershipStatusMessageMetadataMessageMetadataEventMessageModeMetadataFilterInvalidEncodedMetadataModeMetadataTooLargeEncodedMissingReferenceModelRequestCompletedEventModelRequestFailedEventModelRequestRetriedEventModelRequestStartedEventModelRetryReason
O
OAuthAuthOAuthErrorEncodedOAuthFlowIdOrganizationOrganizationIdOrganizationMembershipOverrideNotAllowedEncodedOverrides
P
PendingAuthorizationPendingDecisionPeriodPlaneSignedAuthPoliciesPreviewPreviewIdPreviewMintedPreviewNotFoundEncodedPreviewPathPreviewPortPreviewUnavailableEncodedPromotionMappingPromotionUnresolvedEncodedProviderProviderErrorEncodedProviderIdProviderInUseEncodedProviderNameProviderNameTakenEncodedProviderNotFoundEncodedProviderStateEventProviderTestResultProviderToolConfigProviderToolNameProviderToolUnsupportedEncodedProviderType
R
S
SandboxSandboxAttachedEventSandboxEgressSandboxErrorEncodedSandboxIdSandboxIdleEventSandboxImageSpecSandboxLifecycleSandboxNetworkSandboxNotFoundEncodedSandboxOnIdleSandboxPreviewSandboxPreviewAuthSandboxProviderNameSandboxReleasedEventSandboxResumeSourceSandboxResumedEventSandboxResumedFromSandboxScopeSandboxSnapshotSandboxSnapshottedEventSandboxStateSandboxStateInvalidEncodedSandboxToolPolicySandboxToolPresetScopeSecretSecretIdSecretInUseEncodedSecretMigrationFailureSecretNotFoundEncodedSessionArtifactEventSessionErrorEventSessionEventTypeSessionFilterSessionIdSessionMetadataSessionMetadataEventSessionModelOverrideSessionNotFoundEncodedSessionResumedEventSessionStartedEventSessionStatusSessionStatusEventSessionSystemOverrideSessionTraceSpanSpanAttributesSpanEventSpanIdSpanKindSpanStatusSpanStoreKindSpendCapExceedsParentEncodedSpendLimitExceededEncodedSpendMetricSpendScopeSpendWindowStopReasonStreamFormatStreamIncludeStreamIncludeInvalidEncodedStreamTokenIssuedSubagentByReferenceSubagentCompletedEventSubagentCycleEncodedSubagentMessageEventSubagentModelOverrideSubagentNameSubagentNotAllowedEncodedSubagentPolicySubagentSpawnedEventSubagentStatusEventSubagentToolOverrideSystemOverridePolicy
T
ToolCallDecisionEventToolCallErrToolCallHookToolCallIdToolCallInputDeltaEventToolCallOkToolCallOutcomeToolCallPendingEventToolCallPolicyToolCallResultToolCallRuleToolCallStartedEventToolConfigToolEntryLoadingToolLoadingModeToolLoadingPolicyTraceIdTtlTooLongEncoded