Schemas

ActiveRunSummary

object

• id string required
• conversationId string required
• agentName string required
• status AgentRunStatus required
• startedAt Timestamp required
• updatedAt Timestamp required
• lastSequence integer required, minimum 0, maximum 9007199254740991

AddWorkspaceMemberRequest

object

• email string (email) required, pattern "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"

AdministeredCollaborationWorkspace

object

• id string required
• name string required
• createdAt Timestamp required

AdministeredUser

object

• id string required
• clientInstanceId string required
• displayLabel string required
• email string optional
• roles array of string required
• permissionRefs array of string required
• permissions array of string required
• status AdministeredUserStatus required
• createdAt Timestamp required
• updatedAt Timestamp required
• lastAuthenticatedAt Timestamp optional
• identities array of AdministeredUserIdentity required

AdministeredUserIdentity

object

• clientInstanceId string required
• userId string required
• authSource string required
• externalUserId string required
• displayLabel string optional
• email string optional
• emailVerified boolean required
• createdAt Timestamp required
• updatedAt Timestamp required
• lastAuthenticatedAt Timestamp optional

AdministeredUserPasswordSignInRequest

object

• password string required, minLength 8

AdministeredUserStatus

"active" | "disabled" | "deleting"

AgentAvailability

object

• mode "all" | "selected" required
• personalWorkspaces boolean required
• collaborationWorkspaceIds array of string required

AgentEditableField

"displayName" | "description" | "welcomeMessage" | "welcomeSubtitle" | "instructions" | "modelBindingId" | "reasoningEffort" | "maxSteps" | "toolNames" | "skillNames" | "initialPrompts"

AgentRun

object

• id string required
• clientInstanceId string required
• conversationId string required
• ownerUserId string required
• inputMessageId string required
• agentName string required
• status AgentRunStatus required
• idempotencyKey string optional
• startedAt Timestamp required
• updatedAt Timestamp required
• completedAt Timestamp optional
• cancelledAt Timestamp optional
• failedAt Timestamp optional
• lastSequence integer required, minimum 0, maximum 9007199254740991
• error AgentRunError optional
• correlationId string required
• leaseOwner string optional
• leaseExpiresAt Timestamp optional
• heartbeatAt Timestamp optional

AgentRunError

object

• code string required
• message string required
• category "app_error" | "internal_error" | "runtime_interrupted" | "abort_error" | "unknown_error" required

AgentRunProjection

object

• runId string required
• lastSequence integer required, minimum 0, maximum 9007199254740991
• status AgentRunStatus required
• durationMs integer optional, minimum 0, maximum 9007199254740991
• parts array of AgentRunProjectionPart required, default []
• text string required
• reasoning array of object required
  • id string required
  • text string required
  • open boolean required
• preparingTool object optional
  • toolCallId string required
  • toolName string required
• activeToolCalls array of object required
  • toolCallId string required
  • toolName string required
  • input any optional
  • state "input_available" | "waiting_for_permission" | "output_available" | "output_error" required
  • output any optional
  • errorText string optional
• error AgentRunError optional

AgentRunProjectionPart

object | object | object

• object
  • type "text" required
  • text string required
• object
  • type "reasoning" required
  • id string required
  • text string required
  • open boolean required
• object
  • type "tool_call" required
  • toolCallId string required
  • toolName string required
  • input any optional
  • state "input_available" | "waiting_for_permission" | "output_available" | "output_error" required
  • output any optional
  • errorText string optional

AgentRunStatus

"queued" | "running" | "waiting_for_permission" | "cancelling" | "completed" | "cancelled" | "failed"

AgentRuntimeEvent

object | object | object | object | object | object | object | object | object | object | object | object

• object
  • type "message_delta" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • delta string required
• object
  • type "reasoning_delta" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • id string required
  • delta string required
• object
  • type "message_completed" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • message object required
    • id string required
    • role "assistant" required
    • text string required
    • metadata map of any optional
• object
  • type "tool_call_preparing" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • toolCallId string required
  • toolName string required
• object
  • type "tool_call_preparation_cancelled" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • toolCallId string required
• object
  • type "tool_call_started" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • toolCallId string required
  • toolName string required
  • input any required
• object
  • type "tool_permission_requested" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • toolCallId string required
  • toolName string required
  • reason string required
  • preview map of any optional
• object
  • type "tool_call_completed" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • toolCallId string required
  • toolName string required
  • result any required
  • modelOutput string required
  • projectionNotice map of any optional
• object
  • type "tool_call_failed" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • toolCallId string required
  • toolName string required
  • result any required
  • modelOutput string required
  • projectionNotice map of any optional
• object
  • type "run_completed" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
• object
  • type "run_cancelled" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • reason string optional
• object
  • type "run_failed" required
  • runId string required
  • sequence number required
  • createdAt Timestamp required
  • error object required
    • code string required
    • message string required
    • category "app_error" | "internal_error" | "runtime_interrupted" | "abort_error" | "unknown_error" required

AgentRuntimeMessageMetadata

ApprovalDecisionMessageMetadata | UserMessageMetadata | AssistantToolCallsMessageMetadata | AssistantFinalMessageMetadata | ToolResultMessageMetadata

ApiCredential

object

• id string required
• clientInstanceId string required
• servicePrincipalId string required
• name string required
• keyPrefix string required
• scopes array of ApiCredentialScope optional
• createdAt Timestamp required
• expiresAt Timestamp optional
• revokedAt Timestamp optional
• lastUsedAt Timestamp optional

ApiCredentialScope

"config_assets:read" | "config_assets:release"

ApiErrorResponse

object

• error object required
  • code AppErrorCode required
  • message string required
  • details any optional
  • correlationId string required, minLength 1

ApiUser

object

• id string required
• externalUserId string required
• displayLabel string required
• email string optional
• emailVerified boolean optional
• roles array of string required
• permissionRefs array of string required
• permissions array of string required
• clientInstanceId string required
• authSource string required
• principal AuthPrincipal optional
• subjectUserId string optional
• delegatedActor DelegatedActor optional
• scopes array of AuthScope optional

AppErrorCode

"BAD_REQUEST" | "UNAUTHENTICATED" | "FORBIDDEN" | "NOT_FOUND" | "CONFLICT" | "TIMEOUT" | "VALIDATION_FAILED" | "RATE_LIMITED" | "POLICY_DENIED" | "GUARDRAIL_BLOCKED" | "DECLINED" | "IDEMPOTENCY_KEY_REUSED" | "OPERATION_IN_PROGRESS" | "OPERATION_EXPIRED" | "OUTPUT_NOT_RETAINED" | "INTERNAL"

ApprovalCheckResult

object

• id string required
• status "passed" | "warned" | "blocked" required
• message string required

ApprovalDecisionMessageMetadata

object

• version MessageMetadataVersion required
• kind "approval_decision" required
• requestId string required
• requestKind string required
• status "approved" | "rejected" | "changes_requested" | "superseded" | "withdrawn" | "reverted" required
• decidedBy string required
• decidedByLabel string required
• decidedAt Timestamp required
• summary string required
• comment string optional
• requestedBy string optional

ApprovalRequest

object

• id string required
• clientInstanceId string required
• kind string required
• summary string required
• payload map of any required
• requestedBy object required
  • id string required
  • displayLabel string required
• origin object optional
  • conversationId string required
  • agentRunId string required
  • toolCallId string required
  • agentName string required
• status ApprovalRequestStatus required
• decision object optional
  • approved boolean required
  • decidedBy string required
  • decidedByLabel string required
  • decidedAt Timestamp required
  • reason string optional
  • comment string optional
• reversion object optional
  • revertedBy string required
  • revertedByLabel string required
  • revertedAt Timestamp required
• checks array of ApprovalCheckResult required
• applyResult map of any optional
• createdAt Timestamp required
• updatedAt Timestamp required

ApprovalRequestStatus

"pending" | "approved" | "rejected" | "changes_requested" | "superseded" | "withdrawn" | "reverted"

ApprovalRequestView

object

• id string required
• clientInstanceId string required
• kind string required
• summary string required
• payload map of any required
• requestedBy object required
  • id string required
  • displayLabel string required
• origin object optional
  • conversationId string required
  • agentRunId string required
  • toolCallId string required
  • agentName string required
• status ApprovalRequestStatus required
• decision object optional
  • approved boolean required
  • decidedBy string required
  • decidedByLabel string required
  • decidedAt Timestamp required
  • reason string optional
  • comment string optional
• reversion object optional
  • revertedBy string required
  • revertedByLabel string required
  • revertedAt Timestamp required
• checks array of ApprovalCheckResult required
• applyResult map of any optional
• createdAt Timestamp required
• updatedAt Timestamp required
• preview map of any required
• canDecide boolean required
• canWithdraw boolean required
• canRevert boolean required

ArtifactPreviewFailedResponse

object

• status "failed" required
• artifactId string required
• errorCode string optional
• retryable boolean optional

ArtifactPreviewImagePage

object

• artifactId string required
• mimeType "image/png" | "image/jpeg" | "image/webp" required
• filename string optional
• pageNumber integer optional, maximum 9007199254740991, exclusiveMinimum 0
• slideNumber integer optional, maximum 9007199254740991, exclusiveMinimum 0
• width integer optional, maximum 9007199254740991, exclusiveMinimum 0
• height integer optional, maximum 9007199254740991, exclusiveMinimum 0

ArtifactPreviewPendingResponse

object

• status "pending" required
• artifactId string required
• queuedAt Timestamp optional

ArtifactPreviewReadyResponse

object

• status "ready" required
• artifactId string required
• type "image_pages" required
• format "png" | "webp" | "jpeg" required
• pageCount integer optional, maximum 9007199254740991, exclusiveMinimum 0
• truncated boolean optional
• pages array of ArtifactPreviewImagePage required

ArtifactPreviewResponse

ArtifactPreviewPendingResponse | ArtifactPreviewReadyResponse | ArtifactPreviewFailedResponse | ArtifactPreviewUnsupportedResponse

ArtifactPreviewUnsupportedResponse

object

• status "unsupported" required
• artifactId string required
• errorCode string optional

AssistantFinalMessageMetadata

object

• version MessageMetadataVersion required
• kind "assistant_final" required
• runId string required
• finishStatus "completed" | "cancelled" required
• cancellationReason string optional
• reasoning array of StoredReasoningSummary optional
• sources array of WebSource optional
• citations array of MessageCitation optional
• modelContext StoredModelContextSnapshot optional

AssistantToolCallsMessageMetadata

object

• version MessageMetadataVersion required
• kind "assistant_tool_calls" required
• runId string required
• toolCalls array of StoredToolCall required
• reasoning array of StoredReasoningSummary optional
• modelContext StoredModelContextSnapshot optional

AuditActivity

object

• correlationId string required
• at Timestamp required
• label string required
• tier "governance" | "workflow" | "runtime" | "telemetry" required
• outcome "success" | "failed" | "denied" | "warning" required
• actor AuditActivityActor required
• target AuditActivityTarget optional
• reason string optional
• eventCount integer required, minimum 0, maximum 9007199254740991
• repeatCount integer required, minimum 0, maximum 9007199254740991
• evidence array of AuditEvent required

AuditActivityActor

object

• kind "user" | "assistant" | "service" | "system" required
• label string required
• onBehalfOf string optional
• roles array of string optional

AuditActivityTarget

object

• kind string required
• id string required
• label string optional

AuditActor

object

• userId string optional
• externalUserId string optional
• displayLabel string required
• roles array of string required
• principalKind "user" | "service" optional
• principalId string optional
• principalDisplayLabel string optional
• credentialId string optional
• subjectUserId string optional
• delegatedActor DelegatedActor optional

AuditEvent

object

• id string required
• clientInstanceId string required
• type string required
• status string required
• actor AuditActor optional
• subject string optional
• reason string optional
• correlationId string required
• createdAt Timestamp required
• metadata map of any optional

AuthPrincipal

object

• kind "user" | "service" required
• id string required
• displayLabel string required
• clientInstanceId string required
• authSource string required
• externalUserId string optional

AuthScope

"*" | "me:read" | "me:delete" | "config:read" | "conversation:read" | "conversation:write" | "run:start" | "run:observe" | "run:cancel" | "run:command" | "collaboration_workspace:read" | "collaboration_workspace:manage" | "me:write" | "governance:read" | "governance:write" | "user_admin:read" | "user_admin:write" | "api_access:read" | "api_access:write" | "config_assets:read" | "config_assets:write" | "config_assets:release"

CancelRunRequest

object

• reason string optional, minLength 1

CancelRunResponse

object

• run AgentRun required

ChangeCurrentUserPasswordRequest

object

• currentPassword string required, minLength 1
• newPassword string required, minLength 8

ChangeCurrentUserPasswordResponse

object

• ok true required

ClientBranding

object

• localization Localization required
• clientName string required
• logoUrl string optional
• logoUrlDark string optional
• logoInvertOnDark boolean required
• faviconUrl string optional
• title string required
• welcomeMessage string required
• showAgentName boolean required
• showAgentDescriptions boolean required
• accentColor string required
• theme object required
  • accentColor string required
  • accentStrongColor string required
  • backgroundColor string required
  • surfaceColor string required
  • textColor string required
  • mutedTextColor string required
  • borderColor string required
• darkTheme object required
  • accentColor string required
  • accentStrongColor string required
  • backgroundColor string required
  • surfaceColor string required
  • textColor string required
  • mutedTextColor string required
  • borderColor string required
• defaultThemeMode "light" | "dark" | "system" required
• environment string required
• passwordResetEnabled boolean required, default false

CollaborationWorkspaceAgents

object

• defaultAgentName string optional
• items array of object required
  • name string required
  • displayName string required
  • description string optional
  • defaultModelBindingId string optional
  • selectableModels array of object required
    • bindingId string optional
    • model string required
    • compactThresholdTokens number optional
    • vendor string optional
    • description string optional
    • region ModelRegion optional
    • usageTier ModelUsageTier optional
    • reasoningEffort ReasoningEffort optional
    • selectableReasoningEfforts array of ReasoningEffort required
  • compactThresholdTokens number optional
  • welcomeMessage string optional
  • welcomeSubtitle string optional
  • initialPrompts array of object required
    • title string required
    • prompt string required
• nextCursor string optional

CollaborationWorkspaceDeletionImpact

object

• conversationCount integer required, minimum 0, maximum 9007199254740991
• memberCount integer required, minimum 0, maximum 9007199254740991
• pendingAccessRequestCount integer required, minimum 0, maximum 9007199254740991

CollaborationWorkspaceDeletionResult

object

• collaborationWorkspaceId string required
• conversationCount integer required, minimum 0, maximum 9007199254740991
• fileCount integer required, minimum 0, maximum 9007199254740991
• memberCount integer required, minimum 0, maximum 9007199254740991

CollaborationWorkspaceDirectoryItem

object

• id string required
• name string required
• description string | null required
• emoji string | null required
• accentColor WorkspaceAccentColor | null required
• accessState "member" | "request_pending" | "can_request" required
• createdAt Timestamp required

CollaborationWorkspaceWithRole

object

• id string required
• clientInstanceId string required
• kind "personal" | "shared" required
• name string required
• description string | null required
• visibility WorkspaceVisibility required
• defaultConversationVisibility ConversationVisibility required
• emoji string | null required
• accentColor WorkspaceAccentColor | null required
• personalUserId string | null required
• createdAt Timestamp required
• updatedAt Timestamp required
• role WorkspaceMembershipRole required
• membershipRole WorkspaceMembershipRole | null required
• pendingAccessRequestCount integer required, minimum 0, maximum 9007199254740991

CompletePasswordSetupRequest

object

• token string required, minLength 1
• password string required, minLength 8

CompletePasswordSetupResponse

object

• ok true required

ConfigAsset

object

• kind ConfigAssetKind required
• name string required
• revision integer required, maximum 9007199254740991, exclusiveMinimum 0
• config ConfigAssetConfig required
• updatedAt Timestamp required

ConfigAssetBundle

object

• defaultAgentName string optional, minLength 1
• agents array of ConfigAssetConfig required
• skills array of ConfigAssetConfig required

ConfigAssetConfig

map of any

ConfigAssetKind

"agent" | "skill"

ConfigAssetMutationVersionRequest

object

• baseVersion integer optional, minimum 0, maximum 9007199254740991

ConfigAssetMutationVersionResponse

object

• version integer required, maximum 9007199254740991, exclusiveMinimum 0

ConfigAssetRevision

object

• revision integer required, maximum 9007199254740991, exclusiveMinimum 0
• operation "create" | "update" | "delete" | "revert" required
• config ConfigAssetConfig | null required
• actor AuditActor | null required
• origin object optional
  • kind "approval_request" required
  • requestId string required
  • summary string required
• globalVersion integer required, maximum 9007199254740991, exclusiveMinimum 0
• createdAt Timestamp required

ConfigAssetSummary

object

• id string optional
• kind ConfigAssetKind required
• name string required
• revision integer required, maximum 9007199254740991, exclusiveMinimum 0
• updatedAt Timestamp required
• availability AgentAvailability optional

ConfigAssetsOverview

object

• version integer required, minimum 0, maximum 9007199254740991
• defaultAgentName string optional
• assets array of ConfigAssetSummary required
• references object required
  • modelProviderIds array of string required
  • modelBindingIds array of string required
  • modelBindings array of object required
    • id string required
    • model string required
  • fastModeModelBindingIds array of string required
  • reasoningEfforts array of ReasoningEffort required
  • enabledToolNames array of string required

Conversation

object

• id string required
• clientInstanceId string required
• collaborationWorkspaceId string required
• createdByUserId string required
• createdByExternalUserId string required
• visibility ConversationVisibility required
• title string required
• status string required
• createdAt Timestamp required
• updatedAt Timestamp required
• retainedUntil Timestamp required
• deletedAt Timestamp optional

ConversationListItem

object

• id string required
• clientInstanceId string required
• collaborationWorkspaceId string required
• createdByUserId string required
• createdByExternalUserId string required
• visibility ConversationVisibility required
• title string required
• status string required
• createdAt Timestamp required
• updatedAt Timestamp required
• retainedUntil Timestamp required
• deletedAt Timestamp optional
• latestMessageAt Timestamp optional
• activeRun ActiveRunSummary optional
• unread boolean optional
• lastViewedAt Timestamp optional

ConversationResourceListItem

object | object | object | object | object

• object
  • resourceId string required
  • title string required
  • subtitle string optional
  • createdAt Timestamp required
  • updatedAt Timestamp required
  • resourceType "source_file" required
  • attachmentId string required
  • mimeType string optional
  • preview object | object required
    • object
      • kind "source_file" required
      • fileId string required
    • object
      • kind "artifact" required
      • artifactId string required
      • mimeType string optional
  • download object required
    • kind "source_file" required
    • fileId string required
    • filename string required
• object
  • resourceId string required
  • title string required
  • subtitle string optional
  • createdAt Timestamp required
  • updatedAt Timestamp required
  • resourceType "generated_file" required
  • preview object required
    • kind "artifact" required
    • artifactId string required
  • download object required
    • kind "artifact" required
    • artifactId string required
    • filename string required
• object
  • resourceId string required
  • title string required
  • subtitle string optional
  • createdAt Timestamp required
  • updatedAt Timestamp required
  • resourceType "analysis" required
  • preview object required
    • kind "typed_display" required
    • display map of any required
• object
  • resourceId string required
  • title string required
  • subtitle string optional
  • createdAt Timestamp required
  • updatedAt Timestamp required
  • resourceType "structured_result" required
  • key string required
  • kind string required
  • schemaVersion integer required, maximum 9007199254740991, exclusiveMinimum 0
  • revision integer required, maximum 9007199254740991, exclusiveMinimum 0
  • preview object required
    • kind "typed_display" required
    • display map of any required
• object
  • resourceId string required
  • title string required
  • subtitle string optional
  • createdAt Timestamp required
  • updatedAt Timestamp required
  • resourceType "structured_data" required
  • preview object required
    • kind "structured_data" required
    • structuredDataResourceId string required

ConversationThreadSnapshot

object

• conversation Conversation required
• messages array of Message required
• completedRunProjections map of AgentRunProjection optional
• activeRun object optional
  • run ActiveRunSummary required
  • projection AgentRunProjection required
• modelSelection object optional
  • modelBindingId string optional, minLength 1
  • reasoningEffort ReasoningEffort optional
• userState ConversationUserState required
• serverTime Timestamp required

ConversationUserState

object

• clientInstanceId string required
• conversationId string required
• userId string required
• lastViewedAt Timestamp optional
• lastReadMessageId string optional
• lastReadRunId string optional
• lastReadRunSequence integer optional, minimum 0, maximum 9007199254740991
• updatedAt Timestamp required

ConversationVisibility

"workspace" | "private"

CreateAdministeredUserRequest

object

• displayLabel string required, minLength 1
• email string (email) optional, pattern "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
• roles array of string optional
• permissionRefs array of string optional
• permissions array of string optional
• status UserStatus optional
• passwordSignIn AdministeredUserPasswordSignInRequest optional

CreateApiCredentialRequest

object

• name string required, minLength 1
• scopes array of ApiCredentialScope optional
• expiresAt Timestamp optional

CreateApiCredentialResponse

object

• credential ApiCredential required
• secret string required

CreateCollaborationWorkspaceRequest

object

• name string required, minLength 1, maxLength 120
• description string | null optional
• visibility WorkspaceVisibility optional
• defaultConversationVisibility ConversationVisibility optional
• emoji string | null optional
• accentColor WorkspaceAccentColor | null optional

CreateConversationRequest

object

• title string optional, minLength 1
• collaborationWorkspaceId string optional, minLength 1
• locale LocaleCode optional

CreateConversationRunRequest

object

• idempotencyKey string required, minLength 1
• agentName string optional, minLength 1
• modelBindingId string optional, minLength 1
• reasoningEffort ReasoningEffort optional
• locale LocaleCode optional
• message object required
  • text string required, minLength 1
• conversation CreateConversationRequest optional

CreateNamespaceRequest

object

• prefix NamespacePrefix required
• displayName string required, minLength 1, maxLength 120
• allowedToolNames array of string | null optional
• allowedModelBindingIds array of string | null optional

CreatePermissionGrantRequestInput

object

• holderKind GrantHolderKind required
• holderId string required, minLength 1
• action string required, minLength 1
• scopeKind GrantScopeKind required
• scopeId string optional, minLength 1
• namespace string optional, minLength 1
• effect GrantEffect optional, default "allow"

CreateServicePrincipalRequest

object

• displayLabel string required, minLength 1
• description string optional, minLength 1
• status ServicePrincipalStatus optional
• permissions array of ServicePrincipalPermission optional

DecideApprovalRequest

object | object | object

• object
  • decision "approve" required
  • comment string optional
• object
  • decision "reject" required
  • comment string optional
• object
  • decision "request_changes" required
  • comment string required, minLength 1

DelegatedActor

object

• kind "service_principal" required, default "service_principal"
• id string required
• displayLabel string optional
• authSource string required

DelegatedActorInput

object

• kind "service_principal" optional, default "service_principal"
• id string required
• displayLabel string optional
• authSource string required

DeleteCollaborationWorkspaceRequest

object

• confirmName string required, minLength 1

DeleteCurrentUserResponse

object

• ok true required

DraftAttachment

object

• id string required
• conversationId string required
• fileId string required
• filename string required
• mimeType string optional
• byteSize number required
• status DraftAttachmentStatus required
• format string optional
• artifactRefs map of string required
• processingMetadata map of any required
• warnings array of object required
  • code string required
  • message string required
• error map of any optional
• createdAt Timestamp required
• updatedAt Timestamp required

DraftAttachmentStatus

"queued" | "preprocessing" | "ready" | "failed" | "unsupported" | "deleted"

DraftAttachmentUploadResponse

object

• attachment DraftAttachment required
• attachments array of DraftAttachment required
• outcome "created" | "already_available" optional

EffectivePermissions

object

• holderActive boolean required
• items array of object required
  • action string required
  • effect GrantEffect required
  • scopeKind GrantScopeKind required
  • scopeId string optional
  • namespace string optional
  • source "role" | "legacy" | "legacy_ref" | "grant" required

ExchangeApiKeyResponse

object

• accessToken string required
• expiresAt Timestamp required

ExportConfigAssetsResponse

object

• defaultAgentName string optional, minLength 1
• agents array of ConfigAssetConfig required
• skills array of ConfigAssetConfig required
• version integer required, minimum 0, maximum 9007199254740991
• perAssetConcurrency true optional
• revisions map of integer optional

GrantEffect

"allow" | "deny"

GrantHolderKind

"user" | "service_principal" | "role" | "group"

GrantScopeKind

"instance" | "workspace" | "namespace" | "asset"

IssueSessionTokenRequestInput

object

• externalUserId string required, minLength 1
• displayLabel string required, minLength 1
• email string (email) optional, pattern "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
• emailVerified boolean optional
• roles array of string optional
• permissionRefs array of string optional
• permissions array of string optional
• correlationId string optional
• scopes array of "me:read" | "me:delete" | "config:read" | "conversation:read" | "conversation:write" | "run:start" | "run:observe" | "run:cancel" | "run:command" | "collaboration_workspace:read" | "collaboration_workspace:manage" | "me:write" | "governance:read" | "governance:write" | "user_admin:read" | "user_admin:write" | "api_access:read" | "api_access:write" | "config_assets:read" | "config_assets:write" | "config_assets:release" optional
• delegatedActor DelegatedActorInput optional

IssueSessionTokenResponse

object

• chatSessionToken string required
• expiresAt Timestamp required

Job

object

• id string required
• kind string required
• status JobStatus required
• attempts integer required, minimum 0, maximum 9007199254740991
• maxAttempts integer required, minimum 1, maximum 9007199254740991
• subject string optional
• errorCode string optional
• createdAt Timestamp required
• startedAt Timestamp optional
• finishedAt Timestamp optional
• retryable boolean required

JobKindSummary

object

• kind string required
• queued integer required, minimum 0, maximum 9007199254740991
• running integer required, minimum 0, maximum 9007199254740991
• failed integer required, minimum 0, maximum 9007199254740991
• dead integer required, minimum 0, maximum 9007199254740991
• waitingSince Timestamp optional

JobStatus

"queued" | "running" | "succeeded" | "failed" | "dead" | "cancelled"

JobStatusList

string

LocaleCode

"en" | "de"

Localization

object

• locale LocaleCode required
• defaultLocale LocaleCode required
• supportedLocales array of LocaleCode required

Message

object

• id string required
• conversationId string required
• clientInstanceId string required
• role "user" | "assistant" | "system" | "tool" required
• text string required
• createdAt Timestamp required
• metadata MessageMetadata optional

MessageCitation

object

• sourceId string required
• label string optional
• quote string optional
• characterRange object optional
  • start number required
  • end number required

MessageMetadata

object

• agentRuntime AgentRuntimeMessageMetadata | map of any optional
• display any optional

MessageMetadataVersion

1

ModelRegion

"eu" | "global"

ModelUsageBillableCost

object

• status "settled" | "incomplete" | "unpriced" required
• currency string optional
• uncachedInputBillableCostMicros integer optional, minimum 0, maximum 9007199254740991
• cachedInputBillableCostMicros integer optional, minimum 0, maximum 9007199254740991
• outputBillableCostMicros integer optional, minimum 0, maximum 9007199254740991
• webSearchBillableCostMicros integer optional, minimum 0, maximum 9007199254740991
• billableCostMicros integer optional, minimum 0, maximum 9007199254740991
• complete boolean required
• webSearchCostVisible boolean required

ModelUsageBillableCostSummary

object

• status "settled" | "incomplete" | "unpriced" required
• currency string optional
• uncachedInputBillableCostMicros integer optional, minimum 0, maximum 9007199254740991
• cachedInputBillableCostMicros integer optional, minimum 0, maximum 9007199254740991
• outputBillableCostMicros integer optional, minimum 0, maximum 9007199254740991
• webSearchBillableCostMicros integer optional, minimum 0, maximum 9007199254740991
• billableCostMicros integer optional, minimum 0, maximum 9007199254740991
• complete boolean required
• webSearchCostVisible boolean required
• settledModelCallCount integer required, minimum 0, maximum 9007199254740991
• incompleteModelCallCount integer required, minimum 0, maximum 9007199254740991
• settledWebSearchCallCount integer required, minimum 0, maximum 9007199254740991
• incompleteWebSearchCallCount integer required, minimum 0, maximum 9007199254740991

ModelUsageDailyBucket

object

• start Timestamp optional
• end Timestamp optional
• modelCallCount number required
• inputTokens number required
• cachedInputTokens number required
• outputTokens number required
• totalTokens number required
• webSearchCallCount integer required, minimum 0, maximum 9007199254740991
• cost ModelUsageBillableCostSummary required
• date string required

ModelUsageEvent

object

• id string required
• clientInstanceId string required
• conversationId string optional
• agentRunId string optional
• agentName string required
• providerId string required
• model string required
• inputTokens number required
• cachedInputTokens number optional
• outputTokens number required
• totalTokens number required
• webSearchCallCount integer required, minimum 0, maximum 9007199254740991
• billedAsFast boolean required
• source "provider_reported" | "not_reported" | "estimated" required
• correlationId string required
• createdAt Timestamp required
• cost ModelUsageBillableCost required

ModelUsageMonthlyBucket

object

• start Timestamp optional
• end Timestamp optional
• modelCallCount number required
• inputTokens number required
• cachedInputTokens number required
• outputTokens number required
• totalTokens number required
• webSearchCallCount integer required, minimum 0, maximum 9007199254740991
• cost ModelUsageBillableCostSummary required
• month string required

ModelUsageTier

"low" | "moderate" | "high" | "very_high"

ModelUsageWindowSummary

object

• start Timestamp optional
• end Timestamp optional
• modelCallCount number required
• inputTokens number required
• cachedInputTokens number required
• outputTokens number required
• totalTokens number required
• webSearchCallCount integer required, minimum 0, maximum 9007199254740991
• cost ModelUsageBillableCostSummary required

MoveConversationRequest

object

• collaborationWorkspaceId string required, minLength 1
• visibility ConversationVisibility optional

Namespace

object

• prefix string required
• displayName string required
• allowedToolNames array of string | null required
• allowedModelBindingIds array of string | null required
• createdBy string optional
• createdAt Timestamp required

NamespacePrefix

string

NamespaceUsage

object

• prefix string required
• displayName string required
• allowedToolNames array of string | null required
• allowedModelBindingIds array of string | null required
• createdBy string optional
• createdAt Timestamp required
• grantCount integer required, minimum 0, maximum 9007199254740991
• assetCount integer required, minimum 0, maximum 9007199254740991

NotReady

object

• status "not_ready" required
• reason "database_unreachable" | "database_behind" required
• missing array of string optional

OpenApiDocument

object

• openapi "3.1.0" required
• info object required
  • title string required
  • version string required
  • description string required
• servers array of object required
  • url string required
  • description string required
• tags array of object required
  • name string required
• paths map of map of object required
  • operationId string required
  • summary string required
  • tags array of string required
  • security array of map of array of string required
  • parameters array of object required
    • name string required
    • in "path" | "query" | "header" required
    • description string optional
    • required boolean required
    • schema map of any required
  • requestBody object optional
    • required boolean required
    • content map of object required
      • schema map of any required
  • responses map of object | object required
    • object
      • $ref string required
    • object
      • description string required
      • headers map of object optional
        • $ref string required
      • content map of object optional
        • schema map of any required
  • x-catalyst-effect string required
  • x-catalyst-requires array of string optional
  • x-catalyst-rate-class string required
• components object required
  • securitySchemes map of object required
    • type "apiKey" | "http" required
    • description string required
    • in "cookie" | "header" optional
    • name string optional
    • scheme string optional
  • responses map of object required
    • description string required
    • headers map of object optional
      • $ref string required
    • content map of object optional
      • schema map of any required
  • headers map of object optional
    • description string required
    • schema map of any required
  • schemas map of map of any required

OperationRun

object

• id string required
• operation string required
• effect "reading" | "changing" required
• status OperationRunStatus required
• actor object required
  • kind "user" | "service_principal" required
  • id string required
  • label string required
• origin OperationRunOrigin required
• workspaceId string optional
• approvalRequestId string optional
• inputHash string required
• attempt integer required, minimum 1, maximum 9007199254740991
• decision object optional
  • mode "direct" | "confirmed" | "approved" | "declined" required
  • by string required
  • at Timestamp required
  • comment string optional
• error object optional
  • code string required
  • message string required
• correlationId string required
• createdAt Timestamp required
• startedAt Timestamp optional
• finishedAt Timestamp optional
• expiresAt Timestamp optional
• href string required

OperationRunOrigin

object | object | object | object | object | object | object

• object
  • kind "agent" required
  • agentRunId string required
  • conversationId string required
  • agentName string required
  • toolCallId string required
  • toolName string required
• object
  • kind "user" required
• object
  • kind "cli" required
• object
  • kind "mcp" required
  • clientName string optional
• object
  • kind "app" required
  • appRevisionId string required
  • actionName string required
  • pageSessionId string required
  • conversationId string optional
• object
  • kind "workflow" required
  • workflowRunId string required
  • stepRunId string required
• object
  • kind "schedule" required
  • scheduleId string required

OperationRunStatus

"running" | "pending_confirmation" | "pending_approval" | "done" | "failed" | "denied" | "expired"

PendingApprovalRequestCount

object

• count integer required, minimum 0, maximum 9007199254740991
• canReview boolean required

PermissionGrant

object

• id string required
• holderKind GrantHolderKind required
• holderId string required
• action string required
• effect GrantEffect required
• scopeKind GrantScopeKind required
• scopeId string optional
• namespace string optional
• scopeAsset object optional
  • kind string required
  • name string optional
  • active boolean required
• grantedBy string optional
• createdAt Timestamp required

PutConfigAssetRequest

object

• config ConfigAssetConfig required
• baseVersion integer optional, minimum 0, maximum 9007199254740991

PutConfigAssetResponse

object

• version integer required, maximum 9007199254740991, exclusiveMinimum 0
• revision integer required, maximum 9007199254740991, exclusiveMinimum 0

Ready

object

• status "ready" required
• migration string required

ReasoningEffort

"none" | "low" | "medium" | "high" | "xhigh" | "max"

RenameConversationRequest

object

• title string required, minLength 1, maxLength 120

ReplaceConfigAssetsRequest

object

• defaultAgentName string optional, minLength 1
• agents array of ConfigAssetConfig required
• skills array of ConfigAssetConfig required
• baseVersion integer | null required
• mode "mirror" | "merge" optional
• baseRevisions map of integer | null optional
• baseDefaultAgentName string | null optional
• deleteAssets array of object optional
  • kind ConfigAssetKind required
  • name string required

ReplaceConfigAssetsResponse

object

• version integer required, maximum 9007199254740991, exclusiveMinimum 0
• hiddenAgentNames array of string optional

RequestPasswordResetRequest

object

• email string (email) required, pattern "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"

RequestPasswordResetResponse

object

• ok true required

ResetAdministeredUserPasswordRequest

object

• password string required, minLength 8

ResetAdministeredUserPasswordResponse

object

• ok true required

RevertConfigAssetRequest

object

• revision integer required, maximum 9007199254740991, exclusiveMinimum 0
• baseVersion integer optional, minimum 0, maximum 9007199254740991

RunCommand

object | object

• object
  • type "tool_permission_decision" required
  • toolCallId string required, minLength 1
  • approved boolean required
  • reason string optional, minLength 1
• object
  • type "continue" required

RunCommandRequest

object

• command RunCommand required

RunCommandResponse

object

• run AgentRun required

RunObservation

object

• clientInstanceId string required
• runId string required
• conversationId string required
• ownerUserId string required
• sequence integer required, maximum 9007199254740991, exclusiveMinimum 0
• type string required
• payload AgentRuntimeEvent required
• createdAt Timestamp required

SafeConfig

object

• clientInstance object required
  • id string required
  • displayName string required
  • environment string required
• localization Localization required
• retention object required
  • conversationDays number required
  • expireConversations boolean required
  • extendOnActivity boolean optional
  • auditDays number required
  • allowUserDelete boolean required
• usage object required
  • safeguards UsageSafeguards required
• views object required, default {"allowedScriptSrc":[]}
  • allowedScriptSrc array of string required
• modules map of object required, default {}
  • enabled boolean required
• features object required
  • attachments object required
    • enabled boolean required
    • accept string required
  • resources object required
    • enabled boolean required
  • configAssets object required
    • enabled boolean required
    • editableAgentFields array of AgentEditableField required
    • allowAgentCreation boolean required, default false
    • allowAgentDeletion boolean required, default false
    • allowDefaultAgentChange boolean required, default false
    • allowSkillEditing boolean required, default false
    • agentSkillChanges object required, default {"enabled":false,"allowSkillCreation":false}
      • enabled boolean required
      • allowSkillCreation boolean required
  • userInvitations object required, default {"enabled":false}
    • enabled boolean required
• defaultAgentName string optional
• agents array of object required
  • name string required
  • displayName string required
  • description string optional
  • defaultModelBindingId string optional
  • selectableModels array of object required
    • bindingId string optional
    • model string required
    • compactThresholdTokens number optional
    • vendor string optional
    • description string optional
    • region ModelRegion optional
    • usageTier ModelUsageTier optional
    • reasoningEffort ReasoningEffort optional
    • selectableReasoningEfforts array of ReasoningEffort required
  • compactThresholdTokens number optional
  • welcomeMessage string optional
  • welcomeSubtitle string optional
  • initialPrompts array of object required
    • title string required
    • prompt string required
• ui object required
  • localization Localization required
  • clientName string required
  • logoUrl string optional
  • logoUrlDark string optional
  • logoInvertOnDark boolean required
  • faviconUrl string optional
  • title string required
  • welcomeMessage string required
  • showAgentName boolean required
  • showAgentDescriptions boolean required
  • accentColor string required
  • theme object required
    • accentColor string required
    • accentStrongColor string required
    • backgroundColor string required
    • surfaceColor string required
    • textColor string required
    • mutedTextColor string required
    • borderColor string required
  • darkTheme object required
    • accentColor string required
    • accentStrongColor string required
    • backgroundColor string required
    • surfaceColor string required
    • textColor string required
    • mutedTextColor string required
    • borderColor string required
  • defaultThemeMode "light" | "dark" | "system" required

SendAdministeredUserInvitationResponse

object

• ok true required

ServicePrincipal

object

• id string required
• clientInstanceId string required
• displayLabel string required
• description string optional
• status ServicePrincipalStatus required
• permissionRefs array of string required
• permissions array of ServicePrincipalPermission required
• createdByUserId string optional
• createdAt Timestamp required
• updatedAt Timestamp required
• lastUsedAt Timestamp optional

ServicePrincipalDetail

object

• principal ServicePrincipal required
• credentials array of ApiCredential required

ServicePrincipalPermission

"config_assets.read" | "config_assets.release"

ServicePrincipalStatus

"active" | "disabled"

SetConfigAgentAvailabilityRequest

object

• mode "all" | "selected" required
• personalWorkspaces boolean optional
• collaborationWorkspaceIds array of string optional

SetDefaultConfigAgentRequest

object

• agentName string optional, minLength 1
• baseVersion integer optional, minimum 0, maximum 9007199254740991

StartConversationRunRequest

object

• idempotencyKey string required, minLength 1
• agentName string optional, minLength 1
• modelBindingId string optional, minLength 1
• reasoningEffort ReasoningEffort optional
• locale LocaleCode optional
• message object required
  • text string required, minLength 1

StartConversationRunResponse

object

• conversation Conversation required
• userMessage Message required
• run AgentRun required
• thread ConversationThreadSnapshot required
• eventsUrl string required

StoredModelContextSnapshot

object

• inputTokens number required
• compactThresholdTokens number required
• compacted boolean required

StoredReasoningSummary

object

• id string required
• text string required

StoredToolCall

object

• toolCallId string required
• toolName string required
• input any required

StructuredDataResourceResponse

object

• id string required
• resourceKey string required
• title string required
• revision integer required, maximum 9007199254740991, exclusiveMinimum 0
• createdAt Timestamp required
• updatedAt Timestamp required
• sections array of object required
  • key string required
  • label string required
  • fields array of object required
    • key string required
    • label string required
    • value string | number | boolean | null required
    • attention object optional
      • reason "uncertain" | "conflicting" required
      • message string optional
    • sources array of object optional
      • attachmentId string required
      • page integer optional, maximum 9007199254740991, exclusiveMinimum 0
      • filename string required

Timestamp

string (date-time)

ToolResultMessageMetadata

object

• version MessageMetadataVersion required
• kind "tool_result" required
• runId string required
• toolCallId string required
• toolName string required
• input any required
• result any required
• modelOutput string required
• projectionNotice map of any optional

UpdateAdministeredUserRequest

object

• displayLabel string optional, minLength 1
• email string (email) | null optional
• roles array of string optional
• permissionRefs array of string optional
• permissions array of string optional
• status UserStatus optional

UpdateCollaborationWorkspaceRequest

object

• name string optional, minLength 1, maxLength 120
• description string | null optional
• visibility WorkspaceVisibility optional
• defaultConversationVisibility ConversationVisibility optional
• emoji string | null optional
• accentColor WorkspaceAccentColor | null optional

UpdateCurrentUserRequest

object

• displayLabel string required, minLength 1

UpdateNamespaceRequest

object

• displayName string optional, minLength 1, maxLength 120
• allowedToolNames array of string | null optional
• allowedModelBindingIds array of string | null optional

UpdateServicePrincipalRequest

object

• displayLabel string optional, minLength 1
• description string | null optional
• status ServicePrincipalStatus optional
• permissions array of ServicePrincipalPermission optional

UpdateWorkspaceMemberRoleRequest

object

• role WorkspaceMembershipRole required

UpsertAdministeredUserIdentityRequest

object

• authSource string required, minLength 1
• externalUserId string required, minLength 1
• displayLabel string optional, minLength 1
• email string (email) optional, pattern "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
• emailVerified boolean optional

UsageSafeguards

object

• modelCallsPerDay number optional
• tokensPerDay number optional
• tokensPerMonth number optional

UsageSpendBudget

object

• currency string optional
• dailyLimitMicros integer optional, minimum 0, maximum 9007199254740991
• monthlyLimitMicros integer optional, minimum 0, maximum 9007199254740991

UsageSummary

object

• generatedAt Timestamp required
• spendBudget UsageSpendBudget required
• safeguards UsageSafeguards required
• today ModelUsageWindowSummary required
• currentMonth ModelUsageWindowSummary required
• allTime ModelUsageWindowSummary required
• dailyUsage array of ModelUsageDailyBucket required
• monthlyUsage array of ModelUsageMonthlyBucket required
• recentEvents array of ModelUsageEvent required

UserMessageMetadata

object

• version MessageMetadataVersion required
• kind "user_message" required
• attachmentManifest any required

UserModelPreference

object

• modelBindingId string optional, minLength 1
• reasoningEfforts map of ReasoningEffort required

UserStatus

"active" | "disabled"

ValidateConfigAssetsResponse

object

• valid true required

WebSource

object

• id string required
• url string required
• title string optional
• provider "openai-native" | "serper" | "tavily" | "firecrawl" | "browserbase" | "direct" required
• query string optional
• retrievedAt Timestamp optional
• snippet string optional
• contentHash string optional
• resultPosition number optional

WorkspaceAccentColor

"garnet" | "ruby" | "mahogany" | "copper" | "amber" | "olive" | "jade" | "emerald" | "teal" | "turquoise" | "azure" | "sapphire" | "indigo" | "violet" | "magenta" | "rose" | "stone" | "slate"

WorkspaceAccessRequest

object

• id string required
• collaborationWorkspaceId string required
• clientInstanceId string required
• userId string required
• createdAt Timestamp required

WorkspaceAccessRequestItem

object

• userId string required
• displayLabel string required
• email string | null required
• createdAt Timestamp required

WorkspaceMember

object

• userId string required
• displayLabel string required
• email string | null required
• role WorkspaceMembershipRole required

WorkspaceMemberCandidate

object

• userId string required
• displayLabel string required
• email string required
• hasPendingAccessRequest boolean required

WorkspaceMembership

object

• collaborationWorkspaceId string required
• clientInstanceId string required
• userId string required
• role WorkspaceMembershipRole required
• createdAt Timestamp required
• updatedAt Timestamp required

WorkspaceMembershipRole

"owner" | "admin" | "member"

WorkspaceVisibility

"discoverable" | "private"