Schemas

Scout API 1.0.0 — shared component schemas.

AddAssistantContentRequest

Field	Type	Required	Description
`chunks`	array\<Chunk>	no	Chunks

AddKnowledgeBaseLinkBody

Field	Type	Required	Description
`url`	string	yes	Url

AddProjectMembersBody

Field	Type	Required	Description
`role`	string	no	Role
`user_ids`	array\<string (uuid)>	yes	User Ids

AddProjectMembersResponse

Field	Type	Required	Description
`added`	array\<ProjectMemberResponse>	yes	Added
`failed`	array\<FailedProjectMemberResponse>	yes	Failed

AdminAuditLogResponse

Field	Type	Required	Description
`action_type`	string	yes	Action Type
`actor_email`	string	yes	Actor Email
`actor_first_name`	string	yes	Actor First Name
`actor_last_name`	string	yes	Actor Last Name
`actor_user_account_id`	string \| null	yes	Actor User Account Id
`created_at`	string	yes	Created At
`id`	string	yes	Id
`new_value`	object\<string, any> \| null	yes	New Value
`previous_value`	object\<string, any> \| null	yes	Previous Value
`resource_id`	string \| null	yes	Resource Id
`tenant_id`	string \| null	yes	Tenant Id

AdoptionManifestBody

Field	Type	Required	Description
`manifest_url`	string	yes	Manifest Url

AdoptionMatchResponse

Field	Type	Required	Description
`entity_id`	string	yes	Entity Id
`entity_name`	string	yes	Entity Name
`package_id`	string	yes	Package Id
`status`	string	yes	Status
`tenant_id`	string	yes	Tenant Id
`tenant_name`	string	yes	Tenant Name
`type`	string	yes	Type

AdoptionScanResponse

Field	Type	Required	Description
`matches`	array\<AdoptionMatchResponse>	yes	Matches

AiCodeBoxBuildRequestBody

Field	Type	Required	Description
`description`	string	yes	Description
`externalServices`	array\<string>	no	Externalservices
`inputSchema`	object\<string, string>	no	Inputschema
`skillFilename`	string \| null	no	Skillfilename
`stepId`	string	yes	Stepid

AiCodeBoxBuildResponse

Field	Type	Required	Description
`jobId`	string	yes	Jobid
`skillFilename`	string \| null	no	Skillfilename

AllowedAvatarContentTypesResponse

Field	Type	Required	Description
`allowed_content_types`	array\<string>	yes	Allowed Content Types

AnthropicCompatibleModel

Field	Type	Required	Description
`created_at`	string	yes	Created At
`display_name`	string	yes	Display Name
`id`	string	yes	Id
`max_input_tokens`	integer \| null	no	Max Input Tokens
`type`	string	no	Type

AnthropicCompatibleModelsResponse

Field	Type	Required	Description
`data`	array\<AnthropicCompatibleModel>	yes	Data
`first_id`	string \| null	no	First Id
`has_more`	boolean	no	Has More
`last_id`	string \| null	no	Last Id

AnthropicMessagesRequest

Field	Type	Required	Description
`max_tokens`	integer	yes	Max Tokens
`messages`	array\<object\<string, any>>	yes	Messages
`model`	string	yes	Model
`stream`	boolean	no	Stream

AnthropicMessagesResponse

(no properties)

ApiTokenExpiryPresetResponse

Field	Type	Required	Description
`default`	boolean	yes	Default
`id`	string	yes	Id
`label_key`	string	yes	Label Key

ApiTokenScopeResponse

Field	Type	Required	Description
`default_on`	boolean	yes	Default On
`description_key`	string	yes	Description Key
`id`	string	yes	Id
`label_key`	string	yes	Label Key
`sensitive`	boolean	yes	Sensitive

ApiTokenScopesResponse

Field	Type	Required	Description
`expiry_presets`	array\<ApiTokenExpiryPresetResponse>	yes	Expiry Presets
`scopes`	array\<ApiTokenScopeResponse>	yes	Scopes

ApiTokensResponse

Field	Type	Required	Description
`tokens`	array\<ApiTokensTokenResponse>	yes	Tokens

ApiTokensTokenResponse

Field	Type	Required	Description
`allowed_assistant_ids`	array\<string> \| null	no	Allowed Assistant Ids
`created_at`	string	yes	Created At
`description`	string	yes	Description
`expires_at`	string \| null	no	Expires At
`external_services`	array\<string> \| null	no	External Services
`id`	string	yes	Id
`scope_names`	array\<string> \| null	no	Scope Names
`value`	string \| null	no	Value

ApproveExternalServicesRequest

Field	Type	Required	Description
`approved_external_services`	array\<string>	yes	Approved External Services

AssistantActionResult

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`error`	string \| null	no	Error
`success`	boolean	yes	Success

AssistantCustomFunction

Field	Type	Required	Description
`description`	string	yes	Description
`function_name`	string	yes	Function Name
`output_schema`	object\<string, any> \| null	no	Output Schema
`parameters`	object\<string, any>	yes	Parameters
`skill_filename`	string \| null	no	Skill Filename

AssistantCustomFunctionsResponse

Field	Type	Required	Description
`functions`	array\<AssistantCustomFunction>	yes	Functions

AssistantDataRequestItem

Field	Type	Required	Description
`content`	string \| null	no	Content
`embedding`	array\<any> \| null	no	Embedding
`metadata`	object\<string, any> \| null	no	Metadata

AssistantDataResponseItem

Field	Type	Required	Description
`content`	string	yes	Content
`id`	string	yes	Id
`metadata`	object\<string, any> \| null	yes	Metadata

AssistantFile

Field	Type	Required	Description
`content_type`	string	no	Content Type
`description`	string	no	Description
`filename`	string	no	Filename
`functions_schema`	object\<string, any> \| null	no	Functions Schema
`id`	string	no	Id
`protected_url`	string	no	Protected Url
`status`	string	no	Status
`type`	string	no	Type

AssistantFileList

(no properties)

AssistantFileMessageResponse

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`file_id`	string \| null	no	File Id
`message`	string	yes	Message

AssistantFileUploadResponse

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`file_id`	string	yes	File Id
`message`	string	yes	Message

AssistantFilterMode

(no properties)

AssistantMessageResponse

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`message`	string	yes	Message

AssistantPublicResponse

Field	Type	Required	Description
`avatar_url`	string \| null	no	Avatar Url
`catalog_package_id`	string \| null	no	Catalog Package Id
`catalog_package_version`	string \| null	no	Catalog Package Version
`delegation_assistant_ids`	array\<string>	no	Delegation Assistant Ids
`deleted_at`	string \| null	no	Deleted At
`description`	string	yes	Description
`has_skills`	boolean	yes	Has Skills
`id`	string	yes	Id
`instructions`	string	yes	Instructions
`is_collaborator`	boolean	yes	Is Collaborator
`is_favourite`	boolean	yes	Is Favourite
`is_owner`	boolean	yes	Is Owner
`model`	string \| null	no	Model
`name`	string	yes	Name
`owner_name`	string	yes	Owner Name
`owner_type`	string	yes	Owner Type
`prompt_starters`	array\<string>	yes	Prompt Starters
`type`	string	yes	Type
`ui_url`	string \| null	no	Ui Url
`visibility`	string	yes	Visibility

AssistantPublicResponseList

(no properties)

AssistantResponse

Field	Type	Required	Description
`allowed_external_services`	array\<string> \| null	no	Allowed External Services
`allowed_functions`	array\<string> \| null	no	Allowed Functions
`approved_external_services`	array\<string> \| null	no	Approved External Services
`avatar_url`	string \| null	no	Avatar Url
`catalog_package_id`	string \| null	no	Catalog Package Id
`catalog_package_version`	string \| null	no	Catalog Package Version
`content_retrieving_strategy`	ContentRetrievingStrategy	yes
`delegations`	array\<DelegationResponse>	yes	Delegations
`description`	string	yes	Description
`disabled`	boolean	yes	Disabled
`id`	string	yes	Id
`instructions`	string	yes	Instructions
`is_owner`	boolean	yes	Is Owner
`llm_args`	object\<string, any> \| null	no	Llm Args
`mcp_servers`	array\<McpServer> \| null	no	Mcp Servers
`model`	string \| null	no	Model
`name`	string	yes	Name
`prompt_starters`	array\<string>	yes	Prompt Starters
`secrets`	array\<string>	yes	Secrets
`type`	string	yes	Type
`ui_url`	string \| null	no	Ui Url
`use_system_prompt`	boolean	yes	Use System Prompt
`variables`	object\<string, string>	yes	Variables
`visibility`	ModelVisibilityResponse	yes

AssistantSearchResult

Field	Type	Required	Description
`assistant_type`	string \| null	no	Assistant Type
`avatar_url`	string \| null	no	Avatar Url
`description`	string	yes	Description
`id`	string (uuid)	yes	Id
`is_owner`	boolean	yes	Is Owner
`name`	string	yes	Name
`type`	string	no	Type
`ui_url`	string \| null	no	Ui Url

AssistantSkillResponse

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`message`	string	yes	Message
`skill_id`	string	yes	Skill Id

AssistantType

(no properties)

AssistantUIUrlResponse

Field	Type	Required	Description
`url`	string	yes	Url

AssistantUploadImageResponse

Field	Type	Required	Description
`content_type`	string	yes	Content Type
`protected_url`	string	yes	Protected Url

AssistantUserDataMessageResponse

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`key`	string	yes	Key
`message`	string	yes	Message

AssistantUserDataResponse

Field	Type	Required	Description
`data`	any	no	Data

AssistantUserTokenRequest

Field	Type	Required	Description
`assistant_ui_url`	string \| null	no	Assistant Ui Url
`consented_external_services`	array\<string> \| null	no	Consented External Services
`embed_source`	EmbedSource	no

AssistantUserTokenResponse

Field	Type	Required	Description
`access_token`	string	yes	Access Token
`assistant_id`	string	yes	Assistant Id
`expiry`	integer	yes	Expiry
`user`	UserResponse	yes

AssistantUsingSkillResponse

Field	Type	Required	Description
`id`	string	yes	Id
`name`	string	yes	Name

AssistantUsingSkillResponseList

(no properties)

AssistantVisibilityRequest

Field	Type	Required	Description
`collaborator_group_ids`	array\<string> \| null	no	Collaborator Group Ids
`collaborator_team_ids`	array\<string> \| null	no	Collaborator Team Ids
`collaborators`	array\<string> \| null	no	Collaborators
`group_ids`	array\<string> \| null	no	Group Ids
`team_ids`	array\<string> \| null	no	Team Ids
`type`	VisibilityType	yes
`user_emails`	array\<string> \| null	no	User Emails

AsyncJobResponse

Field	Type	Required	Description
`run_protected_url`	string	yes	Run Protected Url

AsyncJobStatus

(no properties)

AudioModelResponse

Field	Type	Required	Description
`capabilities_tags`	array\<string> \| null	no	Capabilities Tags
`description`	string \| null	no	Description
`displayName`	string	yes	Displayname
`id`	string	yes	Id
`info_tags`	array\<string> \| null	no	Info Tags
`provider`	string	yes	Provider
`release_date`	string \| null	no	Release Date
`tags`	array\<string> \| null	no	Tags
`usage_pricing`	object\<string, any>	no	Usage Pricing

AudioModelResponseList

(no properties)

AudioTranscriptionResponse

Field	Type	Required	Description
`data`	object\<string, any>	yes	Data
`transcript`	string	yes	Transcript

AuditLogsListResponse

Field	Type	Required	Description
`logs`	array\<AdminAuditLogResponse>	yes	Logs
`page`	integer	yes	Page
`page_size`	integer	yes	Page Size
`total`	integer	yes	Total

AuthTokenResourcesRights

Field	Type	Required	Description
`api_resources`	array\<array\<any>>	yes	Api Resources
`external_services`	array\<string>	yes	External Services

AutomationPayload

Field	Type	Required	Description
`function`	string \| null	no	Function
`message`	string \| null	no	Message
`parameters`	object\<string, any> \| null	no	Parameters
`type`	AutomationPayloadType	yes

AutomationPayloadRequest

Field	Type	Required	Description
`function`	string \| null	no	Function
`message`	string \| null	no	Message
`parameters`	object\<string, any> \| null	no	Parameters
`type`	AutomationPayloadType	yes

AutomationPayloadType

(no properties)

AutomationResponse

Field	Type	Required	Description
`assistant_avatar_url`	string \| null	no	Assistant Avatar Url
`assistant_description`	string	yes	Assistant Description
`assistant_id`	string	yes	Assistant Id
`assistant_name`	string	yes	Assistant Name
`created_at`	string	yes	Created At
`external_services`	array\<string>	yes	External Services
`id`	string	yes	Id
`last_run_date`	string \| null	no	Last Run Date
`last_run_status`	string \| null	no	Last Run Status
`name`	string	yes	Name
`payload`	AutomationPayload	yes
`runs_count`	integer	yes	Runs Count
`schedules`	SchedulesResponse	yes
`updated_at`	string	yes	Updated At
`user_id`	string	yes	User Id

AutomationResponseList

(no properties)

AutomationRunResponse

Field	Type	Required	Description
`automation_id`	string	yes	Automation Id
`created_at`	string	yes	Created At
`function_progress_key`	string \| null	yes	Function Progress Key
`function_progress_url`	string \| null	yes	Function Progress Url
`id`	string	yes	Id
`result`	object\<string, any> \| null	yes	Result
`status`	string	yes	Status
`updated_at`	string	yes	Updated At

AutomationRunResponseList

(no properties)

AvailableFunctionsResponse

(no properties)

AvailableGroupResponse

Field	Type	Required	Description
`exists_locally`	boolean	yes	Exists Locally
`is_required`	boolean	yes	Is Required
`is_selected`	boolean	yes	Is Selected
`member_count`	integer	yes	Member Count
`name`	string	yes	Name
`remote_id`	string	yes	Remote Id

AvailableGroupsResponse

Field	Type	Required	Description
`groups`	array\<AvailableGroupResponse>	yes	Groups
`limit`	integer	yes	Limit
`offset`	integer	yes	Offset
`total`	integer	yes	Total

BackendConfigBody

(no properties)

BackendConfigResponse

(no properties)

BrowseSourceBody

Field	Type	Required	Description
`config`	object\<string, any>	no	Config
`cursor`	string \| null	no	Cursor
`parent_path`	string \| null	no	Parent Path

BuildSkillAsyncResponse

Field	Type	Required	Description
`function_progress_url`	string	yes	Function Progress Url
`run_protected_url`	string	yes	Run Protected Url

BuildSkillRequest

Field	Type	Required	Description
`conversation_id`	string (uuid) \| null	no	Conversation that scopes generated files and the build session. When omitted, files attach to the assistant.
`external_services`	array\<string>	no	List of external services the skill needs
`input_files`	array\<string>	no	List of input files for the skill builder
`instructions`	string	yes	Instructions for building the skill
`skill_filename`	string \| null	no	Existing skill filename to edit (for edit mode)
`skill_name`	string \| null	no	Short descriptive name for the skill (3-5 words)

BulkAssistantActionResponse

Field	Type	Required	Description
`results`	array\<AssistantActionResult>	yes	Results

BulkDeleteConversationsRequest

Field	Type	Required	Description
`conversation_ids`	array\<string (uuid)>	yes	Conversation Ids

BulkDeleteConversationsResponse

(no properties)

BulkDisableAssistantBody

Field	Type	Required	Description
`assistant_ids`	array\<string (uuid)>	yes	Assistant Ids
`reason`	string	yes	Reason

BulkEnableAssistantBody

Field	Type	Required	Description
`assistant_ids`	array\<string (uuid)>	yes	Assistant Ids

BulkTransferAssistantOwnershipBody

Field	Type	Required	Description
`assistant_ids`	array\<string (uuid)>	yes	Assistant Ids
`owner_team_id`	string (uuid) \| null	no	Owner Team Id
`owner_user_id`	string (uuid) \| null	no	Owner User Id

BulkUpdateAssistantDataRequest

Field	Type	Required	Description
`metadata`	object\<string, any>	no	Metadata
`where`	object\<string, any>	no	Where

BulkUpdateExternalServiceVisibilityRequest

Field	Type	Required	Description
`services`	array\<ServiceVisibilityUpdate>	yes	Services

CanvasRequiredConsentResponse

Field	Type	Required	Description
`display_name`	string	yes	Display Name
`icon_url`	string	yes	Icon Url
`name`	string	yes	Name

CanvasRequiredConsentResponseList

(no properties)

CatalogPackageResponse

Field	Type	Required	Description
`description`	object\<string, string> \| null	no	Description
`forra_version`	string	yes	Forra Version
`icon_url`	string \| null	no	Icon Url
`installed_version`	string \| null	no	Installed Version
`latest_compatible_version`	string \| null	no	Latest Compatible Version
`name`	object\<string, string>	yes	Name
`package_id`	string	yes	Package Id
`type`	string	yes	Type
`versions`	array\<PackageVersionResponse>	yes	Versions

CatalogPackageSummaryResponse

Field	Type	Required	Description
`description`	object\<string, string> \| null	no	Description
`icon_url`	string \| null	no	Icon Url
`installed_entity_id`	string \| null	no	Installed Entity Id
`installed_version`	string \| null	no	Installed Version
`latest_compatible_version`	string \| null	no	Latest Compatible Version
`name`	object\<string, string>	yes	Name
`package_id`	string	yes	Package Id
`type`	string	yes	Type

CatalogPackageSummaryResponseList

(no properties)

ChatCompletionBody

Field	Type	Required	Description
`allowed_tools`	array\<string> \| null	no	Allowed Tools
`assistant_id`	string (uuid) \| null	no	Assistant Id
`context`	ConversationContext	no
`function_permissions`	array\<FunctionPermission> \| null	no	Function Permissions
`inject_system_prompt`	boolean	no	Inject System Prompt
`llm_args`	object\<string, any>	no	Llm Args
`messages`	array\<ConversationMessage>	yes	Messages
`model`	string	yes	Model
`response_format`	object\<string, any> \| null	no	Response Format
`response_interface`	string \| null	no	Response Interface
`skill_ids`	array\<string> \| null	no	Skill Ids
`stream`	boolean	no	Stream

ChatCompletionResponse

(no properties)

Chunk

Field	Type	Required	Description
`chunk_to_embed`	string	yes	Chunk To Embed
`content_to_return`	string	yes	Content To Return
`metadata`	ChunkMetadata \| null	no

ChunkDocumentResponse

(no properties)

ChunkMetadata

Field	Type	Required	Description
`hierarchy`	array\<string> \| string \| null	no	Hierarchy
`line_end`	integer \| null	no	Line End
`line_start`	integer \| null	no	Line Start
`page_end`	integer \| null	no	Page End
`page_start`	integer \| null	no	Page Start
`parent`	ChunkMetadata \| null	no

CodingAgentConfigExportQuery

Field	Type	Required	Description
`model_ids`	array\<string> \| null	no	Model Ids
`only_favorites`	boolean	no	Only Favorites

CodingAgentConfigExportResponse

(no properties)

ConfigValidationResponse

Field	Type	Required	Description
`valid`	boolean	yes	Valid
`warnings`	array\<ValidationWarning>	no	Warnings

ConnectedServiceResponse

Field	Type	Required	Description
`name`	string	yes	Name

ConnectedServicesResponse

Field	Type	Required	Description
`services`	array\<ConnectedServiceResponse>	yes	Services

ContentRetrievingStrategy

Field	Type	Required	Description
`filter_results`	boolean	no	Filter Results
`keyword_search_count`	integer	no	Keyword Search Count
`max_result_count`	integer	no	Max Result Count
`min_score`	number	no	Min Score

ContractInfoResponse

Field	Type	Required	Description
`admin_fee_percentage`	number	no	Admin Fee Percentage
`allowed_providers`	array\<string> \| null	no	Allowed Providers
`harvest_client_id`	integer \| null	no	Harvest Client Id
`monthly_additional_fees`	number	no	Monthly Additional Fees
`price_per_seat`	number	no	Price Per Seat
`required_tags`	array\<string> \| null	no	Required Tags
`seat_limit`	integer \| null	no	Seat Limit
`token_monthly_budget`	number	no	Token Monthly Budget

ControlTowerEntityStatus

(no properties)

ControlTowerExportQuery

Field	Type	Required	Description
`from_date`	string (date-time) \| null	no	From Date
`to_date`	string (date-time) \| null	no	To Date

ControlTowerKpisResponse

Field	Type	Required	Description
`active_assistants`	integer	yes	Active Assistants
`active_assistants_previous`	integer	yes	Active Assistants Previous
`active_users`	integer	yes	Active Users
`active_users_previous`	integer	yes	Active Users Previous
`conversations`	integer	yes	Conversations
`conversations_previous`	integer	yes	Conversations Previous
`monthly_budget`	number \| null	yes	Monthly Budget
`monthly_cost`	number	yes	Monthly Cost
`monthly_cost_previous`	number	yes	Monthly Cost Previous
`total_assistants`	integer	yes	Total Assistants

ControlTowerModelItemResponse

Field	Type	Required	Description
`conversation_count`	integer	yes	Conversation Count
`model_name`	string	yes	Model Name
`percent_of_total`	number	yes	Percent Of Total
`provider_key`	string	yes	Provider Key
`total_cost`	number	yes	Total Cost
`total_tokens`	integer	yes	Total Tokens

ControlTowerModelsQuery

Field	Type	Required	Description
`from_date`	string (date-time) \| null	no	From Date
`limit`	integer	no	Limit
`offset`	integer	no	Offset
`search`	string \| null	no	Search
`sort_by`	string	no	Sort By
`sort_order`	string	no	Sort Order
`to_date`	string (date-time) \| null	no	To Date

ControlTowerModelsResponse

Field	Type	Required	Description
`items`	array\<ControlTowerModelItemResponse>	yes	Items
`total`	integer	yes	Total

ControlTowerOverviewItemDetailResponse

Field	Type	Required	Description
`assistant_type`	string	yes	Assistant Type
`automation_count`	integer	yes	Automation Count
`avatar_url`	string \| null	yes	Avatar Url
`avg_cost_per_conversation`	number	yes	Avg Cost Per Conversation
`conversation_count`	integer	yes	Conversation Count
`cost`	number	yes	Cost
`created_at`	string	yes	Created At
`created_by_name`	string \| null	yes	Created By Name
`description`	string	yes	Description
`id`	string	yes	Id
`instructions`	string	yes	Instructions
`name`	string	yes	Name
`owner_avatar_url`	string \| null	yes	Owner Avatar Url
`owner_email`	string \| null	yes	Owner Email
`owner_name`	string	yes	Owner Name
`owner_type`	string	yes	Owner Type
`skills`	array\<SkillSummaryResponse>	yes	Skills
`status`	ControlTowerEntityStatus	yes
`updated_at`	string	yes	Updated At
`user_count`	integer	yes	User Count

ControlTowerOverviewItemQuery

Field	Type	Required	Description
`from_date`	string (date-time) \| null	no	From Date
`to_date`	string (date-time) \| null	no	To Date

ControlTowerOverviewItemResponse

Field	Type	Required	Description
`assistant_type`	string	yes	Assistant Type
`avatar_url`	string \| null	yes	Avatar Url
`conversation_count`	integer	yes	Conversation Count
`cost`	number	yes	Cost
`id`	string	yes	Id
`last_active_at`	string \| null	yes	Last Active At
`name`	string	yes	Name
`owner_name`	string	yes	Owner Name
`owner_type`	string	yes	Owner Type
`status`	ControlTowerEntityStatus	yes
`user_count`	integer	yes	User Count

ControlTowerOverviewQuery

Field	Type	Required	Description
`from_date`	string (date-time) \| null	no	From Date
`limit`	integer	no	Limit
`offset`	integer	no	Offset
`search`	string \| null	no	Search
`sort_by`	string	no	Sort By
`sort_order`	string	no	Sort Order
`to_date`	string (date-time) \| null	no	To Date

ControlTowerOverviewResponse

Field	Type	Required	Description
`items`	array\<ControlTowerOverviewItemResponse>	yes	Items
`total`	integer	yes	Total

ControlTowerUserItemResponse

Field	Type	Required	Description
`avatar_url`	string \| null	yes	Avatar Url
`builder_cost`	number \| null	yes	Builder Cost
`conversation_count`	integer	yes	Conversation Count
`display_name`	string	yes	Display Name
`email`	string	yes	Email
`is_inactive`	boolean	yes	Is Inactive
`last_active_at`	string \| null	yes	Last Active At
`monthly_usage_percent`	number \| null	yes	Monthly Usage Percent
`total_cost`	number	yes	Total Cost
`user_id`	string	yes	User Id

ControlTowerUserUsageQuery

Field	Type	Required	Description
`month`	string	yes	Month

ControlTowerUserUsageResponse

Field	Type	Required	Description
`by_api_key`	array\<UsageApiKeyBreakdownResponse>	yes	By Api Key
`by_feature`	array\<UsageFeatureBreakdownResponse>	yes	By Feature
`by_provider`	array\<UsageProviderBreakdownResponse>	yes	By Provider
`daily_limit`	number \| null	yes	Daily Limit
`daily_provider_costs`	array\<DailyProviderCostResponse>	yes	Daily Provider Costs
`delta_percent`	number \| null	yes	Delta Percent
`monthly_cost`	number	yes	Monthly Cost
`monthly_limit`	number \| null	yes	Monthly Limit

ControlTowerUsersQuery

Field	Type	Required	Description
`from_date`	string (date-time) \| null	no	From Date
`limit`	integer	no	Limit
`offset`	integer	no	Offset
`search`	string \| null	no	Search
`sort_by`	string	no	Sort By
`sort_order`	string	no	Sort Order
`to_date`	string (date-time) \| null	no	To Date

ControlTowerUsersResponse

Field	Type	Required	Description
`builder_feature_enabled`	boolean	yes	Builder Feature Enabled
`items`	array\<ControlTowerUserItemResponse>	yes	Items
`total`	integer	yes	Total

ConversationChatCompletionForm

Field	Type	Required	Description
`chat_request`	string	yes	Chat Request

ConversationCompletionQuery

Field	Type	Required	Description
`context`	string \| null	no	Context

ConversationContext

(no properties)

ConversationMessage

Field	Type	Required	Description
`content`	string \| array\<ConversationMessageContentPartTextParam \| ConversationMessageContentPartImageParam \| ConversationMessageContentPartInputAudioParam \| ConversationMessageContentPartPDFParam \| ConversationMessageContentPartImageRefParam \| ConversationMessageContentPartPDFRefParam \| ConversationMessageContentPartInputAudioRefParam>	no	Content
`metadata`	MessageMetadata \| null	no
`reasoning`	MessageReasoning \| null	no
`role`	MessageRole	yes
`tool_call_id`	string \| null	no	Tool Call Id
`tool_calls`	array\<MessageToolCall> \| null	no	Tool Calls

ConversationMessageContentPartImageParam

Field	Type	Required	Description
`content_type`	string	yes	Content Type
`data`	string	yes	Data
`remote_path`	string	no	Remote Path
`type`	string	yes	Type

ConversationMessageContentPartImageRefParam

Field	Type	Required	Description
`content_type`	string	yes	Content Type
`remote_path`	string	yes	Remote Path
`type`	string	yes	Type

ConversationMessageContentPartInputAudioParam

Field	Type	Required	Description
`data`	string	yes	Data
`format`	string	yes	Format
`remote_path`	string	no	Remote Path
`type`	string	yes	Type

ConversationMessageContentPartInputAudioRefParam

Field	Type	Required	Description
`format`	string	yes	Format
`remote_path`	string	yes	Remote Path
`type`	string	yes	Type

ConversationMessageContentPartPDFParam

Field	Type	Required	Description
`data`	string	yes	Data
`filename`	string	yes	Filename
`remote_path`	string	no	Remote Path
`type`	string	yes	Type

ConversationMessageContentPartPDFRefParam

Field	Type	Required	Description
`filename`	string	yes	Filename
`remote_path`	string	yes	Remote Path
`type`	string	yes	Type

ConversationMessageContentPartTextParam

Field	Type	Required	Description
`text`	string	yes	Text
`type`	string	yes	Type

ConversationResponse

Field	Type	Required	Description
`assistant`	AssistantPublicResponse \| null	no
`id`	string (uuid)	yes	Id
`is_read_only`	boolean	no	Is Read Only
`is_system`	boolean	no	Is System
`last_activity_at`	string \| null	no	Last Activity At
`model`	string \| null	no	Model
`owner_user_name`	string \| null	no	Owner User Name
`payload`	array\<ConversationMessage>	yes	Payload
`project_id`	string (uuid) \| null	no	Project Id
`title`	string \| null	no	Title
`updated_at`	string	yes	Updated At
`user_data`	object\<string, any> \| null	no	User Data

ConversationSearchResult

Field	Type	Required	Description
`assistant_id`	string (uuid) \| null	no	Assistant Id
`assistant_name`	string \| null	no	Assistant Name
`assistant_type`	string \| null	no	Assistant Type
`avatar_url`	string \| null	no	Avatar Url
`id`	string (uuid)	yes	Id
`preview`	string \| null	no	Preview
`title`	string \| null	no	Title
`type`	string	no	Type
`ui_url`	string \| null	no	Ui Url
`updated_at`	string	yes	Updated At

ConversationSkillResponse

Field	Type	Required	Description
`conversation_id`	string	yes	Conversation Id
`message`	string	yes	Message
`skill_id`	string	yes	Skill Id

ConversationSummaryResponse

Field	Type	Required	Description
`assistant_id`	string (uuid) \| null	no	Assistant Id
`assistant_type`	string \| null	no	Assistant Type
`id`	string (uuid)	yes	Id
`is_read_only`	boolean	no	Is Read Only
`last_activity_at`	string \| null	no	Last Activity At
`project_id`	string (uuid) \| null	no	Project Id
`title`	string \| null	no	Title
`updated_at`	string	yes	Updated At

ConversationsListMetadata

Field	Type	Required	Description
`has_more`	boolean	yes	Has More
`last_timestamp`	number	yes	Last Timestamp
`limit`	integer \| null	no	Limit

ConversationsListResponse

Field	Type	Required	Description
`conversations`	array\<ConversationSummaryResponse>	yes	Conversations
`metadata`	ConversationsListMetadata	yes

CreateApiTokenRequest

Field	Type	Required	Description
`allowed_assistant_ids`	array\<string (uuid)> \| null	no	Allowed Assistant Ids
`assistant_id`	string (uuid) \| null	no	Assistant Id
`description`	string	yes	Description
`expiry_preset`	string	no	Expiry Preset
`external_services`	array\<string> \| null	no	External Services
`resources_rights`	AuthTokenResourcesRights \| null	no
`scope_names`	array\<string> \| null	no	Scope Names

CreateAssistantDataRequest

Field	Type	Required	Description
`content`	string \| null	no	Content
`data`	array\<AssistantDataRequestItem> \| null	no	Data
`embedding`	array\<any> \| null	no	Embedding
`metadata`	object\<string, any> \| null	no	Metadata

CreateAssistantDataResponse

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`created_item_ids`	array\<string>	yes	Created Item Ids
`message`	string	yes	Message

CreateAssistantFromTemplateBody

Field	Type	Required	Description
`description`	string	yes	Description
`locale`	string \| null	no	Locale
`name`	string	yes	Name
`template_id`	string	yes	Template Id

CreateAssistantFromTemplateResponse

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`starter_prompt`	string \| null	no	Starter Prompt

CreateAssistantRequest

Field	Type	Required	Description
`allowed_external_services`	array\<any> \| null	no	Allowed External Services
`allowed_functions`	array\<any> \| null	no	Allowed Functions
`avatar_url`	string \| null	no	Avatar Url
`content_retrieving_strategy`	ContentRetrievingStrategy	no
`delegations`	array\<DelegationRequest> \| null	no	Delegations
`description`	string	yes	Description
`instructions`	string	yes	Instructions
`llm_args`	object\<string, any> \| null	no	Llm Args
`mcp_servers`	array\<McpServer> \| null	no	Mcp Servers
`model`	string \| null	no	Model
`name`	string	yes	Name
`prompt_starters`	array\<string>	yes	Prompt Starters
`secrets`	object\<string, string> \| null	no	Secrets
`type`	AssistantType \| null	no
`use_system_prompt`	boolean	yes	Use System Prompt
`variables`	object\<string, string> \| null	no	Variables
`visibility`	AssistantVisibilityRequest	yes

CreateAutomationRequest

Field	Type	Required	Description
`assistant_id`	string (uuid)	yes	Assistant Id
`external_services`	array\<string>	no	External Services
`name`	string	yes	Name
`payload`	AutomationPayloadRequest	yes
`schedules`	object\<string, any>	no	Schedules

CreateConversationRequest

Field	Type	Required	Description
`assistant_id`	string \| null	no	Assistant Id
`is_system`	boolean \| null	no	Is System
`model`	string \| null	no	Model
`payload`	array\<ConversationMessage>	yes	Payload
`project_id`	string \| null	no	Project Id
`skill_ids`	array\<string> \| null	no	Skill Ids
`time_zone_offset`	string \| null	no	Time Zone Offset
`title`	string \| null	no	Title
`user_data`	object\<string, any> \| null	no	User Data

CreateEmbeddingsRequest

Field	Type	Required	Description
`texts`	array\<string>	yes	Texts

CreateEmbeddingsResponse

(no properties)

CreateInvitationsRequest

Field	Type	Required	Description
`emails`	array\<string>	yes	Emails
`message`	string \| null	no	Message
`role`	UserRole	yes

CreateInvitationsResponse

Field	Type	Required	Description
`errors`	array\<string>	yes	Errors
`invitations`	array\<InvitationResponse>	yes	Invitations

CreateMemoryRequest

Field	Type	Required	Description
`always_inject`	boolean	no	Always Inject
`assistant_id`	string \| null	no	Assistant Id
`content`	string	yes	Content
`metadata`	object\<string, any> \| null	no	Metadata

CreateProjectRequest

Field	Type	Required	Description
`description`	string	yes	Description
`name`	string	yes	Name
`owner_team_id`	string \| null	no	Owner Team Id

CreateServiceAccountApiTokenRequest

Field	Type	Required	Description
`allowed_assistant_ids`	array\<string (uuid)> \| null	no	Allowed Assistant Ids
`assistant_id`	string (uuid) \| null	no	Assistant Id
`description`	string	yes	Description
`expiry_preset`	string	no	Expiry Preset
`external_services`	array\<string> \| null	no	External Services
`resources_rights`	AuthTokenResourcesRights \| null	no
`scope_names`	array\<string> \| null	no	Scope Names

CreateServiceAccountRequest

Field	Type	Required	Description
`first_name`	string	yes	First Name
`last_name`	string	no	Last Name

CreateTeamBody

Field	Type	Required	Description
`initial_owner_group_ids`	array\<string (uuid)> \| null	no	Initial Owner Group Ids
`initial_owner_user_ids`	array\<string (uuid)> \| null	no	Initial Owner User Ids
`name`	string	yes	Name

CurrentUserResponse

Field	Type	Required	Description
`email`	string	yes	Email
`email_notifications_enabled`	boolean	no	Email Notifications Enabled
`features`	array\<string>	no	Features
`first_name`	string	yes	First Name
`id`	string	yes	Id
`impersonating_tenant_name`	string \| null	no	Impersonating Tenant Name
`impersonation_expires_at`	string \| null	no	Impersonation Expires At
`impersonation_kind`	string \| null	no	Impersonation Kind
`is_admin`	boolean	yes	Is Admin
`is_impersonating`	boolean	yes	Is Impersonating
`is_tenant_admin`	boolean	yes	Is Tenant Admin
`last_name`	string	yes	Last Name
`picture_url`	string \| null	yes	Picture Url
`roles`	array\<string>	yes	Roles
`status`	string	yes	Status
`tenant_id`	string	yes	Tenant Id

DailyProviderCostResponse

Field	Type	Required	Description
`costs_by_provider`	object\<string, number>	yes	Costs By Provider
`date`	string	yes	Date

DailyUsage

Field	Type	Required	Description
`cost`	number	yes	Cost
`date`	string	yes	Date
`tokens`	integer	yes	Tokens

DailyUsageExportQuery

Field	Type	Required	Description
`from_date`	string \| null	no	From Date
`to_date`	string \| null	no	To Date

DecodedAccessTokenResponse

Field	Type	Required	Description
`first_name`	string \| null	no	First Name
`is_admin`	boolean	no	Is Admin
`is_tenant_admin`	boolean	no	Is Tenant Admin
`last_name`	string \| null	no	Last Name
`picture_url`	string \| null	no	Picture Url
`roles`	array\<any>	no	Roles
`sub`	string \| null	no	Sub
`tenant_id`	string \| null	no	Tenant Id

DefaultEmbeddingModelResponse

Field	Type	Required	Description
`default_embedding_model_id`	string \| null	yes	Default Embedding Model Id
`effective_embedding_model_id`	string \| null	yes	Effective Embedding Model Id

DefaultModelQuery

Field	Type	Required	Description
`user_model_id`	string \| null	no	User Model Id

DefaultModelResponse

Field	Type	Required	Description
`default_model_id`	string \| null	yes	Default Model Id
`effective_model_id`	string \| null	yes	Effective Model Id

DelegationFrame

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`instruction`	string	yes	Instruction
`model_id`	string	yes	Model Id
`payload`	array\<ConversationMessage>	yes	Payload
`pending_tool_call_id`	string	no	Pending Tool Call Id
`token_usage`	object\<string, any>	no	Token Usage

DelegationOrchestratorState

Field	Type	Required	Description
`pending_call_id`	string	yes	Pending Call Id
`pending_function_name`	string	yes	Pending Function Name
`stack`	array\<DelegationFrame>	yes	Stack
`version`	integer	yes	Version

DelegationRequest

Field	Type	Required	Description
`delegated_assistant_id`	string (uuid)	yes	Delegated Assistant Id
`description`	string	yes	Description
`position`	integer	no	Position

DelegationResponse

Field	Type	Required	Description
`delegated_assistant_id`	string	yes	Delegated Assistant Id
`description`	string	yes	Description
`id`	string	yes	Id
`position`	integer	yes	Position

DeleteAssistantDataRequest

Field	Type	Required	Description
`id`	any \| null	no	Id
`where`	object\<string, any> \| null	no	Where

DeleteAssistantDataResponse

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`message`	string	yes	Message

DeleteAssistantDatabaseRequest

Field	Type	Required	Description
`confirmation_connection_ref`	string	yes	Confirmation Connection Ref

DeleteProjectResponse

Field	Type	Required	Description
`message`	string	yes	Message

DeployAssistantUIForm

Field	Type	Required	Description
`ui`	string (binary)	yes	Ui

DisableAssistantBody

Field	Type	Required	Description
`reason`	string	yes	Reason

EmbedSource

(no properties)

ExecuteSkillFunctionQuery

Field	Type	Required	Description
`conversation_id`	string (uuid) \| null	no	Conversation Id
`delay`	integer	no	Delay
`file_progress_name`	string \| null	no	File Progress Name

ExecuteSkillFunctionRequest

(no properties)

ExternalServiceRequirementResponse

Field	Type	Required	Description
`configured`	boolean	yes	Configured
`display_name`	string \| null	no	Display Name
`icon_url`	string \| null	no	Icon Url
`name`	string	yes	Name

ExternalServiceVisibilityRequest

Field	Type	Required	Description
`collaborator_group_ids`	array\<string> \| null	no	Collaborator Group Ids
`collaborator_team_ids`	array\<string> \| null	no	Collaborator Team Ids
`collaborators`	array\<string> \| null	no	Collaborators
`group_ids`	array\<string> \| null	no	Group Ids
`team_ids`	array\<string> \| null	no	Team Ids
`type`	VisibilityType	yes
`user_emails`	array\<string> \| null	no	User Emails

ExternalServiceVisibilityResponse

Field	Type	Required	Description
`service_name`	string	yes	Service Name
`visibility`	ModelVisibilityResponse	yes

ExternalServiceVisibilityResponseList

(no properties)

ExternalServiceWithStatusResponse

Field	Type	Required	Description
`configured_scopes`	array\<string>	yes	Configured Scopes
`display_name`	string	yes	Display Name
`icon_url`	string	yes	Icon Url
`is_connected`	boolean	yes	Is Connected
`name`	string	yes	Name

ExternalServicesWithStatusResponse

Field	Type	Required	Description
`services`	array\<ExternalServiceWithStatusResponse>	yes	Services

FailedProjectMemberResponse

Field	Type	Required	Description
`reason`	string	yes	Reason
`user_id`	string	yes	User Id

FavouriteOrderItem

Field	Type	Required	Description
`id`	string (uuid)	yes	Id
`sort_order`	integer	yes	Sort Order

FeatureCatalogResponse

Field	Type	Required	Description
`control`	string	yes	Control
`key`	string	yes	Key
`scope`	string	yes	Scope
`tenant_managed_rollout`	boolean	yes	Tenant Managed Rollout

FeatureCatalogResponseList

(no properties)

FeatureVisibilityRequest

Field	Type	Required	Description
`collaborator_group_ids`	array\<string> \| null	no	Collaborator Group Ids
`collaborator_team_ids`	array\<string> \| null	no	Collaborator Team Ids
`collaborators`	array\<string> \| null	no	Collaborators
`group_ids`	array\<string> \| null	no	Group Ids
`team_ids`	array\<string> \| null	no	Team Ids
`type`	VisibilityType	yes
`user_emails`	array\<string> \| null	no	User Emails

FileTextContentForm

Field	Type	Required	Description
`json_payload`	string \| null	no	Json Payload

FileTextContentResponse

(no properties)

FunctionPermission

Field	Type	Required	Description
`call_id`	string \| null	no	Call Id
`denied`	boolean \| null	no	Denied
`function_name`	string \| null	no	Function Name

GenerateAssistantAvatarRequest

Field	Type	Required	Description
`description`	string	yes	Description
`name`	string	yes	Name

GenerateAudioTranscriptionForm

Field	Type	Required	Description
`model`	string \| null	no	Model

GenerateSpeechBody

Field	Type	Required	Description
`api_args`	object\<string, any> \| null	no	Api Args
`conversation_id`	string \| null	no	Conversation Id
`message_index`	integer \| null	no	Message Index
`model`	string \| null	no	Model
`stream`	boolean	no	Stream
`text`	string \| null	no	Text
`voice`	string \| null	no	Voice

GenerateTenantInvoiceResponse

Field	Type	Required	Description
`invoice`	InvoiceResponse \| null	no
`status`	string	yes	Status

GetAvailableGroupsQuery

Field	Type	Required	Description
`limit`	integer	no	Limit
`offset`	integer	no	Offset
`query`	string \| null	no	Query

GetCostsRequest

Field	Type	Required	Description
`from_date`	string (date-time) \| null	no	From Date
`group_by_tenant`	boolean \| null	no	Group By Tenant
`include_only_billable`	boolean \| null	no	Include Only Billable
`model`	string \| null	no	Model
`to_date`	string (date-time) \| null	no	To Date
`user_ids`	array\<string (uuid)> \| null	no	User Ids

GetCostsResponseModel

Field	Type	Required	Description
`detail`	array\<object\<string, any>>	no	Detail
`from_date`	string	no	From Date
`monthly_organization_limit`	number \| null	no	Monthly Organization Limit
`specific_user_limits`	array\<SpecificUserLimitResponse>	no	Specific User Limits
`tenant_breakdown`	array\<TenantCostSummaryResponse> \| null	no	Tenant Breakdown
`to_date`	string	no	To Date
`total_cost`	number	no	Total Cost
`user_limits`	UserLimitsResponse \| null	no

GetInstanceCostSummaryQuery

Field	Type	Required	Description
`month`	string \| null	no	Month

GetProtectedImageQuery

Field	Type	Required	Description
`background_color`	string	no	Background Color
`image_format`	string	no	Image Format

GetSkillsBuilderHistoryQuery

Field	Type	Required	Description
`is_completed`	boolean \| null	no	Is Completed
`skill_filename`	string \| null	no	Skill Filename

GetSyncHistoryQuery

Field	Type	Required	Description
`limit`	integer	no	Limit
`offset`	integer	no	Offset

GetTenantSpendingOverviewQuery

Field	Type	Required	Description
`include_only_billable`	boolean \| null	no	Include Only Billable
`month`	string \| null	no	Month

GetUserFirstUsageMonthQuery

Field	Type	Required	Description
`include_only_billable`	boolean \| null	no	Include Only Billable

GetUserUsageQuery

Field	Type	Required	Description
`include_only_billable`	boolean \| null	no	Include Only Billable
`month`	string \| null	no	Month

GetUserUsageSummaryQuery

Field	Type	Required	Description
`include_only_billable`	boolean \| null	no	Include Only Billable

GetVideoJobStatusQuery

Field	Type	Required	Description
`model`	string \| null	no	Model

GetWebappConfigQuery

Field	Type	Required	Description
`tenant_id`	string \| null	no	Tenant Id

GroupChange

Field	Type	Required	Description
`change_type`	GroupChangeType	yes
`existing_group_name`	string \| null	no	Existing Group Name
`group`	RemoteGroup	yes
`membership_changes`	array\<MembershipChange>	yes	Membership Changes
`name_changed`	boolean	no	Name Changed

GroupChangeType

(no properties)

GroupResponse

Field	Type	Required	Description
`id`	string	yes	Id
`is_active`	boolean	yes	Is Active
`name`	string	yes	Name

GroupResponseList

(no properties)

GroupSelectionItem

Field	Type	Required	Description
`remote_id`	string	yes	Remote Id

GroupSyncCredentialResponse

Field	Type	Required	Description
`authorized_at`	string \| null	yes	Authorized At
`authorized_by_name`	string \| null	yes	Authorized By Name
`external_account_name`	string \| null	yes	External Account Name
`service_name`	string	yes	Service Name

GroupSyncRunResponse

Field	Type	Required	Description
`completed_at`	string \| null	yes	Completed At
`details`	object\<string, any> \| null	yes	Details
`id`	string	yes	Id
`started_at`	string \| null	yes	Started At
`status`	string	yes	Status
`triggered_by`	string	yes	Triggered By

HealthResponse

Field	Type	Required	Description
`status`	string	yes	Status

ImageAspectRatio

(no properties)

ImageBackground

(no properties)

ImageGenerationBody

Field	Type	Required	Description
`aspect_ratio`	ImageAspectRatio \| null	no
`async_job`	boolean	no	Async Job
`background`	ImageBackground	no
`conversation_id`	string (uuid) \| null	no	Conversation Id
`images`	array\<ImageObject> \| null	no	Images
`mask`	ImageObject \| null	no
`model`	string \| null	no	Model
`nb_outputs`	integer \| null	no	Nb Outputs
`prompt`	string	yes	Prompt
`quality`	ImageQuality \| null	no
`resolution`	ImageResolution \| null	no

ImageGenerationModelResponse

Field	Type	Required	Description
`api`	string	yes	Api
`capabilities_tags`	array\<string> \| null	no	Capabilities Tags
`description`	string \| null	no	Description
`displayName`	string	yes	Displayname
`id`	string	yes	Id
`image_aspect_ratio_mapping`	object\<string, any> \| null	no	Image Aspect Ratio Mapping
`image_quality_mapping`	object\<string, any> \| null	no	Image Quality Mapping
`info_tags`	array\<string> \| null	no	Info Tags
`model`	string	yes	Model
`provider`	string	yes	Provider
`release_date`	string \| null	no	Release Date
`tags`	array\<string> \| null	no	Tags
`usage_pricing`	object\<string, any>	no	Usage Pricing

ImageGenerationModelResponseList

(no properties)

ImageObject

Field	Type	Required	Description
`base64`	string \| null	no	Base64
`content_type`	string	yes	Content Type
`filename`	string	yes	Filename
`protected_url`	string \| null	no	Protected Url

ImageQuality

(no properties)

ImageResolution

(no properties)

ImageTransparencyResponse

Field	Type	Required	Description
`has_transparency`	boolean	yes	Has Transparency

ImageWithMetadata

Field	Type	Required	Description
`base64`	string	yes	Base64
`mime_type`	string	yes	Mime Type

ImprovePromptRequest

Field	Type	Required	Description
`prompt`	string	yes	Prompt

ImprovePromptResponse

Field	Type	Required	Description
`prompt`	string \| null	no	Prompt

IndexingStrategy

(no properties)

InstallPackageBody

Field	Type	Required	Description
`secrets`	object\<string, string>	no	Secrets
`variables`	object\<string, string>	no	Variables
`version`	string \| null	no	Version
`visibility`	ModelVisibility \| null	no

InstallValidationResponse

Field	Type	Required	Description
`already_installed`	InstalledEntityResponse \| null	no
`external_service_requirements`	array\<ExternalServiceRequirementResponse>	no	External Service Requirements
`is_compatible`	boolean	yes	Is Compatible
`missing_dependencies`	array\<MissingDependencyResponse>	yes	Missing Dependencies
`package`	CatalogPackageResponse	yes
`satisfied_dependencies`	array\<SatisfiedDependencyResponse>	yes	Satisfied Dependencies
`selected_version`	PackageVersionResponse	yes

InstalledEntityResponse

Field	Type	Required	Description
`entity_id`	string	yes	Entity Id
`installed_at`	string	yes	Installed At
`package_id`	string	yes	Package Id
`package_version`	string	yes	Package Version
`type`	string	yes	Type

InstalledEntityResponseList

(no properties)

InstanceCostSummaryMetadataResponse

Field	Type	Required	Description
`active_user_count`	integer	yes	Active User Count
`tenant_count`	integer	yes	Tenant Count

InstanceCostSummaryModelResponse

Field	Type	Required	Description
`billable_cost_cad`	number	yes	Billable Cost Cad
`billable_cost_usd`	number	yes	Billable Cost Usd
`input_tokens`	integer	yes	Input Tokens
`model`	string	yes	Model
`non_billable_cost_cad`	number	yes	Non Billable Cost Cad
`non_billable_cost_usd`	number	yes	Non Billable Cost Usd
`output_tokens`	integer	yes	Output Tokens
`provider`	string	yes	Provider
`request_count`	integer	yes	Request Count
`total_cost_cad`	number	yes	Total Cost Cad
`total_cost_usd`	number	yes	Total Cost Usd
`total_tokens`	integer	yes	Total Tokens

InstanceCostSummaryProviderResponse

Field	Type	Required	Description
`billable_cost_cad`	number	yes	Billable Cost Cad
`billable_cost_usd`	number	yes	Billable Cost Usd
`input_tokens`	integer	yes	Input Tokens
`models`	array\<InstanceCostSummaryModelResponse>	yes	Models
`non_billable_cost_cad`	number	yes	Non Billable Cost Cad
`non_billable_cost_usd`	number	yes	Non Billable Cost Usd
`output_tokens`	integer	yes	Output Tokens
`provider`	string	yes	Provider
`request_count`	integer	yes	Request Count
`total_cost_cad`	number	yes	Total Cost Cad
`total_cost_usd`	number	yes	Total Cost Usd
`total_tokens`	integer	yes	Total Tokens

InstanceCostSummaryResponse

Field	Type	Required	Description
`billable_cost_cad`	number	yes	Billable Cost Cad
`billable_cost_usd`	number	yes	Billable Cost Usd
`from_date`	string	yes	From Date
`input_tokens`	integer	yes	Input Tokens
`metadata`	InstanceCostSummaryMetadataResponse	yes
`non_billable_cost_cad`	number	yes	Non Billable Cost Cad
`non_billable_cost_usd`	number	yes	Non Billable Cost Usd
`output_tokens`	integer	yes	Output Tokens
`providers`	array\<InstanceCostSummaryProviderResponse>	yes	Providers
`request_count`	integer	yes	Request Count
`to_date`	string	yes	To Date
`total_cost_cad`	number	yes	Total Cost Cad
`total_cost_usd`	number	yes	Total Cost Usd
`total_tokens`	integer	yes	Total Tokens

InvitationResponse

Field	Type	Required	Description
`created_at`	string	yes	Created At
`email`	string	yes	Email
`id`	string	yes	Id
`invited_by_user_id`	string	yes	Invited By User Id
`message`	string \| null	yes	Message
`role`	string	yes	Role
`status`	string	yes	Status

InvoiceResponse

Field	Type	Required	Description
`admin_fee_cad`	number	yes	Admin Fee Cad
`allocation_cad`	number	yes	Allocation Cad
`billing_period_end`	string	yes	Billing Period End
`billing_period_start`	string	yes	Billing Period Start
`external_invoice_id`	string \| null	yes	External Invoice Id
`id`	string	yes	Id
`line_items`	array\<any> \| null	yes	Line Items
`overage_cad`	number	yes	Overage Cad
`provider`	string	yes	Provider
`status`	string	yes	Status
`tenant_id`	string	yes	Tenant Id
`total_consumption_cad`	number	yes	Total Consumption Cad
`total_invoice_cad`	number	yes	Total Invoice Cad

KnowledgeBaseAttachBody

Field	Type	Required	Description
`knowledge_base_id`	string (uuid)	yes	Knowledge Base Id

KnowledgeBaseCreateAndAttachBody

Field	Type	Required	Description
`config`	object\<string, any>	no	Config
`query_policy`	string	yes	Query Policy
`source_kind`	string	yes	Source Kind

KnowledgeBaseCreateBody

Field	Type	Required	Description
`config`	object\<string, any>	no	Config
`description`	string \| null	no	Description
`name`	string	yes	Name
`query_policy`	string	yes	Query Policy
`source_kind`	string	yes	Source Kind
`urls`	array\<string>	no	Urls
`visibility`	KnowledgeBaseVisibilityRequest \| null	no

KnowledgeBaseDocumentResponse

Field	Type	Required	Description
`content_type`	string \| null	yes	Content Type
`created_at`	string	yes	Created At
`description`	string \| null	yes	Description
`file_id`	string \| null	yes	File Id
`id`	string	yes	Id
`indexing_strategy`	string	yes	Indexing Strategy
`knowledge_base_id`	string	yes	Knowledge Base Id
`last_processed_at`	string \| null	yes	Last Processed At
`name`	string \| null	yes	Name
`path`	string	yes	Path
`protected_url`	string \| null	yes	Protected Url
`status`	string	yes	Status
`updated_at`	string	yes	Updated At

KnowledgeBaseDocumentResponseList

(no properties)

KnowledgeBaseFileUpdateBody

Field	Type	Required	Description
`file_description`	string	yes	File Description
`file_name`	string	yes	File Name
`indexing_strategy`	IndexingStrategy \| null	no

KnowledgeBaseFileUploadResponse

Field	Type	Required	Description
`file_id`	string	yes	File Id
`knowledge_base_id`	string	yes	Knowledge Base Id
`message`	string	yes	Message

KnowledgeBaseLinkResponse

Field	Type	Required	Description
`document_id`	string	yes	Document Id
`knowledge_base_id`	string	yes	Knowledge Base Id
`message`	string	yes	Message

KnowledgeBaseResponse

Field	Type	Required	Description
`config`	object\<string, any>	yes	Config
`created_at`	string	yes	Created At
`description`	string \| null	yes	Description
`embedding_model_id`	string \| null	yes	Embedding Model Id
`id`	string	yes	Id
`indexation_status`	string	yes	Indexation Status
`last_indexed_at`	string \| null	yes	Last Indexed At
`name`	string	yes	Name
`owner_user_id`	string	yes	Owner User Id
`query_policy`	string	yes	Query Policy
`scope`	string	yes	Scope
`source_kind`	string	yes	Source Kind
`updated_at`	string	yes	Updated At
`visibility`	object\<string, any>	yes	Visibility

KnowledgeBaseResponseList

(no properties)

KnowledgeBaseUpdateBody

Field	Type	Required	Description
`config`	object\<string, any>	no	Config
`description`	string \| null	no	Description
`name`	string \| null	no	Name
`visibility`	KnowledgeBaseVisibilityRequest \| null	no

KnowledgeBaseVisibilityRequest

Field	Type	Required	Description
`collaborator_group_ids`	array\<string> \| null	no	Collaborator Group Ids
`collaborator_team_ids`	array\<string> \| null	no	Collaborator Team Ids
`collaborators`	array\<string> \| null	no	Collaborators
`group_ids`	array\<string> \| null	no	Group Ids
`team_ids`	array\<string> \| null	no	Team Ids
`type`	VisibilityType	yes
`user_emails`	array\<string> \| null	no	User Emails

KnowledgeSourceAssistantCreationAccessRequest

Field	Type	Required	Description
`collaborator_group_ids`	array\<string> \| null	no	Collaborator Group Ids
`collaborator_team_ids`	array\<string> \| null	no	Collaborator Team Ids
`collaborators`	array\<string> \| null	no	Collaborators
`group_ids`	array\<string> \| null	no	Group Ids
`team_ids`	array\<string> \| null	no	Team Ids
`type`	VisibilityType	yes
`user_emails`	array\<string> \| null	no	User Emails

KnowledgeSourceBrowseResponse

Field	Type	Required	Description
`items`	array\<KnowledgeSourceItemResponse>	yes	Items
`next_cursor`	string \| null	no	Next Cursor
`resolved_config`	object\<string, any>	yes	Resolved Config

KnowledgeSourceCapabilitiesResponse

Field	Type	Required	Description
`required_scopes`	array\<string>	yes	Required Scopes
`requires_indexing`	boolean	yes	Requires Indexing
`supports_hybrid`	boolean	yes	Supports Hybrid
`supports_native_search`	boolean	yes	Supports Native Search

KnowledgeSourceConfigurationResponse

Field	Type	Required	Description
`allowed_resources`	array\<string>	yes	Allowed Resources
`assistant_creation_access`	ModelVisibilityResponse \| null	yes
`capabilities`	KnowledgeSourceCapabilitiesResponse	yes
`default_external_service_name`	string \| null	yes	Default External Service Name
`display_name`	string	yes	Display Name
`external_service_name`	string \| null	yes	External Service Name
`source_kind`	string	yes	Source Kind

KnowledgeSourceConfigurationResponseList

(no properties)

KnowledgeSourceItemResponse

Field	Type	Required	Description
`access_uri`	string \| null	no	Access Uri
`display_name`	string	yes	Display Name
`drive_id`	string \| null	no	Drive Id
`etag`	string \| null	no	Etag
`file_extension`	string \| null	no	File Extension
`is_directory`	boolean	yes	Is Directory
`mime_type`	string \| null	no	Mime Type
`parent_label`	string \| null	no	Parent Label
`parent_path`	string \| null	no	Parent Path
`path`	string	yes	Path
`remote_id`	string \| null	no	Remote Id
`site_id`	string \| null	no	Site Id
`size`	integer \| null	no	Size

KnowledgeSourceResponse

Field	Type	Required	Description
`external_service_name`	string \| null	yes	External Service Name
`kind`	string	yes	Kind
`required_scopes`	array\<string>	yes	Required Scopes
`requires_indexing`	boolean	yes	Requires Indexing
`supports_hybrid`	boolean	yes	Supports Hybrid
`supports_native_search`	boolean	yes	Supports Native Search

KnowledgeSourceResponseList

(no properties)

LLMFilterDocumentsRequest

Field	Type	Required	Description
`batch_size`	integer	no	Batch Size
`context`	string	no	Context
`documents`	object\<string, string>	yes	Documents
`model_id`	string \| null	no	Model Id
`query`	string	yes	Query

LLMFilterDocumentsResponse

(no properties)

LLMModelResponse

Field	Type	Required	Description
`api_id`	string \| null	no	Api Id
`capabilities_tags`	array\<string> \| null	no	Capabilities Tags
`description`	string \| null	no	Description
`displayName`	string	yes	Displayname
`id`	string	yes	Id
`info_tags`	array\<string> \| null	no	Info Tags
`knowledge_cutoff`	string \| null	no	Knowledge Cutoff
`limit`	ModelLimitResponse \| null	no
`llm_args`	object\<string, any>	no	Llm Args
`max_input_tokens`	integer \| null	no	Max Input Tokens
`modalities`	ModelModalitiesResponse \| null	no
`provider`	string	yes	Provider
`reasoning_options`	array\<ReasoningOptionResponse> \| null	no	Reasoning Options
`release_date`	string \| null	no	Release Date
`supports_sampling`	boolean	no	Supports Sampling
`supports_tools`	boolean	no	Supports Tools
`tags`	array\<string> \| null	no	Tags
`usage_pricing`	object\<string, any>	no	Usage Pricing

LLMModelResponseList

(no properties)

LinkRequest

Field	Type	Required	Description
`id`	string (uuid) \| null	no	Id
`url`	string	yes	Url

LinkResponse

Field	Type	Required	Description
`id`	string	yes	Id
`status`	string	yes	Status
`url`	string	yes	Url

LinkResponseList

(no properties)

ListAssistantsQuery

Field	Type	Required	Description
`type`	AssistantType \| null	no

ListAuditLogsQuery

Field	Type	Required	Description
`mode`	string	no	Mode
`page`	integer	no	Page
`page_size`	integer	no	Page Size

ListAutomationsQuery

Field	Type	Required	Description
`assistant_id`	string (uuid) \| null	no	Assistant Id
`type`	AssistantType \| null	no

ListConversationsQuery

Field	Type	Required	Description
`after_timestamp`	number \| null	no	After Timestamp
`assistant_filter_mode`	AssistantFilterMode \| null	no
`assistant_id`	string (uuid) \| null	no	Assistant Id
`include_projects`	boolean	no	Include Projects
`is_system`	boolean	no	Is System
`limit`	integer	no	Limit

ListGlobalSkillsQuery

Field	Type	Required	Description
`order_by`	string	no	Order By
`search`	string \| null	no	Search
`usable_in`	SkillUsableIn \| null	no

ListMediaModelsQuery

Field	Type	Required	Description
`tags`	array\<string>	no	Tags

ListNotificationsQuery

Field	Type	Required	Description
`status`	NotificationListFilter \| null	no

LocalizedStringResponse

Field	Type	Required	Description
`en`	string	yes	En
`fr`	string \| null	no	Fr

LoginQuery

Field	Type	Required	Description
`nonce`	string	yes	Nonce

LoginRequest

Field	Type	Required	Description
`nonce`	string \| null	yes	Nonce
`oauth_token`	string	yes	Oauth Token
`provider`	string	yes	Provider
`tenant_id`	string \| null	no	Tenant Id

LoginResponse

Field	Type	Required	Description
`access_token`	string	yes	Access Token
`refresh_token`	string	yes	Refresh Token

LogoutRequest

Field	Type	Required	Description
`refresh_token`	string \| null	no	Refresh Token

LogoutResponse

Field	Type	Required	Description
`message`	string	yes	Message

ManageableFeatureResponse

Field	Type	Required	Description
`control`	string	yes	Control
`key`	string	yes	Key
`scope`	string	yes	Scope
`tenant_managed_rollout`	boolean	yes	Tenant Managed Rollout
`visibility`	ModelVisibilityResponse \| null	no

ManageableFeatureResponseList

(no properties)

McpOauthDisconnectBody

Field	Type	Required	Description
`mcp_server_url`	string	yes	Mcp Server Url

McpOauthPrepareBody

Field	Type	Required	Description
`assistant_id`	string \| null	no	Assistant Id
`mcp_server_url`	string	yes	Mcp Server Url

McpOauthPrepareResponse

Field	Type	Required	Description
`authorization_url`	string	yes	Authorization Url

McpOauthServerStatus

Field	Type	Required	Description
`authenticated`	boolean	yes	Authenticated
`expires_at`	integer \| null	no	Expires At
`has_tools`	boolean	yes	Has Tools
`url`	string	yes	Url

McpOauthStatusResponse

Field	Type	Required	Description
`servers`	array\<McpOauthServerStatus>	yes	Servers

McpServer

Field	Type	Required	Description
`arguments`	array\<string>	no	Arguments
`command`	string	no	Command
`environment`	object\<string, string>	no	Environment
`external_service`	string	no	External Service
`headers`	object\<string, string>	no	Headers
`name`	string	yes	Name
`tools`	array\<McpTool>	no	Tools
`type`	McpServerType	no
`url`	string	no	Url

McpServerType

(no properties)

McpTool

Field	Type	Required	Description
`description`	string	no	Description
`inputSchema`	object\<string, any>	yes	Inputschema
`name`	string	yes	Name
`outputSchema`	object\<string, any>	no	Outputschema

MembershipChange

Field	Type	Required	Description
`change_type`	MembershipChangeType	yes
`error_message`	string \| null	no	Error Message
`member`	RemoteGroupMember	yes
`user_found`	boolean	no	User Found

MembershipChangeType

(no properties)

MemoryResponse

Field	Type	Required	Description
`always_inject`	boolean	yes	Always Inject
`assistant_id`	string \| null	yes	Assistant Id
`category`	string \| null	yes	Category
`content`	string	yes	Content
`created_at`	string	yes	Created At
`id`	string	yes	Id
`metadata`	object\<string, any> \| null	yes	Metadata
`scope`	string	yes	Scope
`sensitivity`	string	yes	Sensitivity
`updated_at`	string	yes	Updated At
`user_id`	string	yes	User Id

MemoryResponseList

(no properties)

MessageMetadata

Field	Type	Required	Description
`assistant_id`	string	no	Assistant Id
`files`	array\<MetadataFile>	no	Files
`function_permissions`	array\<FunctionPermission> \| null	no	Function Permissions
`token_usage`	object\<string, any>	no	Token Usage
`tool_calls`	array\<MetadataToolCall>	no	Tool Calls

MessageReasoning

Field	Type	Required	Description
`data`	object\<string, any> \| null	no	Data
`id`	string	yes	Id
`text`	string	no	Text

MessageResponse

Field	Type	Required	Description
`message`	string	yes	Message

MessageRole

(no properties)

MessageToolCall

Field	Type	Required	Description
`function`	ToolCallFunction	yes
`id`	string	yes	Id
`type`	string	yes	Type

MetadataFile

Field	Type	Required	Description
`content`	string	no	Content
`content_type`	string	yes	Content Type
`name`	string	yes	Name

MetadataToolCall

Field	Type	Required	Description
`arguments`	string	no	Arguments
`call_id`	string	no	Call Id
`delegation_state`	DelegationOrchestratorState	no
`function_permission_data`	object\<string, any> \| null	no	Function Permission Data
`function_progress_output_url`	string	no	Function Progress Output Url
`output_metadata`	object\<string, any>	no	Output Metadata
`tool_name`	string	no	Tool Name

MissingDependencyResponse

Field	Type	Required	Description
`package`	CatalogPackageResponse	yes
`package_id`	string	yes	Package Id
`required_min_version`	string	yes	Required Min Version
`type`	string	yes	Type

ModelLibraryMetadataResponse

Field	Type	Required	Description
`capabilities_tags`	array\<string>	yes	Capabilities Tags
`providers`	array\<string>	yes	Providers

ModelLimitResponse

Field	Type	Required	Description
`context`	integer	yes	Context
`input`	integer \| null	no	Input
`output`	integer	yes	Output

ModelModalitiesResponse

Field	Type	Required	Description
`input`	array\<string>	no	Input
`output`	array\<string>	no	Output

ModelVisibility

Field	Type	Required	Description
`collaborator_group_ids`	array\<string>	no	Collaborator Group Ids
`collaborator_ids`	array\<string>	no	Collaborator Ids
`collaborator_team_ids`	array\<string>	no	Collaborator Team Ids
`group_ids`	array\<string>	no	Group Ids
`team_ids`	array\<string>	no	Team Ids
`type`	VisibilityType	yes
`user_ids`	array\<string>	no	User Ids

ModelVisibilityRequest

Field	Type	Required	Description
`collaborator_group_ids`	array\<string> \| null	no	Collaborator Group Ids
`collaborator_team_ids`	array\<string> \| null	no	Collaborator Team Ids
`collaborators`	array\<string> \| null	no	Collaborators
`group_ids`	array\<string> \| null	no	Group Ids
`team_ids`	array\<string> \| null	no	Team Ids
`type`	VisibilityType	yes
`user_emails`	array\<string> \| null	no	User Emails

ModelVisibilityResponse

Field	Type	Required	Description
`collaborator_groups`	array\<SharedGroup> \| null	yes	Collaborator Groups
`collaborator_teams`	array\<SharedTeam> \| null	yes	Collaborator Teams
`collaborators`	array\<SharedUser> \| null	yes	Collaborators
`groups`	array\<SharedGroup> \| null	yes	Groups
`shared_users`	array\<SharedUser> \| null	yes	Shared Users
`teams`	array\<SharedTeam> \| null	yes	Teams
`type`	string	yes	Type

ModelsQuery

Field	Type	Required	Description
`capability_tag`	string \| null	no	Capability Tag
`info_tag`	string \| null	no	Info Tag

MultiImageResponse

Field	Type	Required	Description
`images`	array\<ImageWithMetadata>	yes	Images

NotificationEndpointBody

Field	Type	Required	Description
`endpoint_data`	object\<string, any>	yes	Endpoint Data
`type`	string	yes	Type

NotificationEndpointResponse

Field	Type	Required	Description
`endpoint_data`	object\<string, any>	yes	Endpoint Data
`id`	string	yes	Id
`type`	string	yes	Type
`user_id`	string	yes	User Id

NotificationListFilter

(no properties)

NotificationPreferencesResponse

Field	Type	Required	Description
`email`	boolean	yes	Email

NotificationResponse

Field	Type	Required	Description
`created_at`	string	yes	Created At
`data`	object\<string, any> \| null	yes	Data
`entity_id`	string	yes	Entity Id
`entity_type`	string	yes	Entity Type
`event`	string	yes	Event
`id`	string	yes	Id
`read_at`	string \| null	yes	Read At
`type`	string	yes	Type
`uris`	array\<object\<string, any>> \| null	yes	Uris

NotificationResponseList

(no properties)

NotificationTypeResult

Field	Type	Required	Description
`endpoints_failed`	integer	yes	Endpoints Failed
`endpoints_reached`	integer	yes	Endpoints Reached
`error_message`	string \| null	no	Error Message
`invalid_endpoints_removed`	integer	yes	Invalid Endpoints Removed

NotificationsTarget

(no properties)

OAuthCallbackQuery

Field	Type	Required	Description
`code`	string \| null	no	Code
`error`	string \| null	no	Error
`state`	string \| null	no	State

OpenAIChatCompletionRequest

Field	Type	Required	Description
`messages`	array\<object\<string, any>>	yes	Messages
`model`	string	yes	Model
`stream`	boolean	no	Stream

OpenaiCompatibleModel

Field	Type	Required	Description
`context_length`	integer \| null	no	Context Length
`created`	integer	yes	Created
`id`	string	yes	Id
`object`	string	no	Object
`owned_by`	string	yes	Owned By

OpenaiCompatibleModelsResponse

Field	Type	Required	Description
`data`	array\<OpenaiCompatibleModel>	yes	Data
`object`	string	no	Object

OwnershipCandidateResponse

Field	Type	Required	Description
`avatar_url`	string \| null	yes	Avatar Url
`email`	string \| null	yes	Email
`id`	string	yes	Id
`name`	string	yes	Name
`type`	string	yes	Type

OwnershipCandidateResponseList

(no properties)

OwnershipCandidatesQuery

Field	Type	Required	Description
`search`	string \| null	no	Search

PackageDependencyResponse

Field	Type	Required	Description
`min_version`	string	yes	Min Version
`package_id`	string	yes	Package Id
`type`	string	yes	Type

PackageVariableSpecResponse

Field	Type	Required	Description
`en`	string	yes	En
`fr`	string	yes	Fr

PackageVersionResponse

Field	Type	Required	Description
`dependencies`	array\<PackageDependencyResponse>	yes	Dependencies
`external_services`	array\<string>	no	External Services
`is_compatible`	boolean	yes	Is Compatible
`min_forra_version`	string	yes	Min Forra Version
`secrets_to_provide`	object\<string, PackageVariableSpecResponse>	yes	Secrets To Provide
`source_hash`	string \| null	no	Source Hash
`source_url`	string \| null	no	Source Url
`variables_to_provide`	object\<string, PackageVariableSpecResponse>	yes	Variables To Provide
`version`	string	yes	Version

PatchAssistantRequest

Field	Type	Required	Description
`allowed_external_services`	array\<any> \| null	no	Allowed External Services
`allowed_functions`	array\<any> \| null	no	Allowed Functions
`avatar_url`	string \| null	no	Avatar Url
`content_retrieving_strategy`	ContentRetrievingStrategy \| null	no
`delegations`	array\<DelegationRequest> \| null	no	Delegations
`description`	string \| null	no	Description
`instructions`	string \| null	no	Instructions
`links`	array\<LinkRequest> \| null	no	Links
`llm_args`	object\<string, any> \| null	no	Llm Args
`mcp_servers`	array\<McpServer> \| null	no	Mcp Servers
`model`	string \| null	no	Model
`name`	string \| null	no	Name
`prompt_starters`	array\<string> \| null	no	Prompt Starters
`secrets`	object\<string, string \| null> \| null	no	Secrets
`type`	AssistantType \| null	no
`ui_url`	string \| null	no	Ui Url
`use_system_prompt`	boolean \| null	no	Use System Prompt
`variables`	object\<string, string> \| null	no	Variables
`visibility`	AssistantVisibilityRequest \| null	no

PrepareLoginResponse

Field	Type	Required	Description
`nonce`	string	yes	Nonce

ProjectMemberResponse

Field	Type	Required	Description
`first_opened_at`	string \| null	no	First Opened At
`id`	string	yes	Id
`invited_by_user_id`	string \| null	no	Invited By User Id
`joined_at`	string	yes	Joined At
`project_id`	string	yes	Project Id
`role`	string	yes	Role
`user`	UserResponse \| null	no
`user_id`	string	yes	User Id

ProjectMemberResponseList

(no properties)

ProjectResponse

Field	Type	Required	Description
`created_at`	string	yes	Created At
`current_user_role`	string \| null	no	Current User Role
`description`	string	yes	Description
`id`	string	yes	Id
`name`	string	yes	Name
`owner_team_id`	string \| null	no	Owner Team Id
`owner_user_id`	string \| null	no	Owner User Id
`updated_at`	string	yes	Updated At

ProjectResponseList

(no properties)

PromoteProjectToTeamBody

Field	Type	Required	Description
`team_id`	string	yes	Team Id

ProviderApiKeysResponse

Field	Type	Required	Description
`overrides`	object\<string, string \| null>	yes	Overrides

ProviderSkuCostRowResponse

Field	Type	Required	Description
`cost_usd`	number	yes	Cost Usd
`pct_of_provider`	number \| null	yes	Pct Of Provider
`sku`	string	yes	Sku

ProvisioningMode

(no properties)

ProvisioningModeResponse

Field	Type	Required	Description
`provisioning_mode`	ProvisioningMode	yes

QueryAssistantDataResponse

(no properties)

QueryGroupsQuery

Field	Type	Required	Description
`query`	string	no	Query

QueryUsersQuery

Field	Type	Required	Description
`query`	string	no	Query

ReasoningOptionResponse

Field	Type	Required	Description
`max`	integer \| null	no	Max
`min`	integer \| null	no	Min
`type`	string	yes	Type
`values`	array\<string> \| null	no	Values

ReconciliationModelRowResponse

Field	Type	Required	Description
`gap_percentage`	number \| null	yes	Gap Percentage
`gap_usd`	number	yes	Gap Usd
`internal_cost_usd`	number	yes	Internal Cost Usd
`model`	string	yes	Model
`provider_cost_usd`	number	yes	Provider Cost Usd
`status`	string	yes	Status

ReconciliationProviderRowResponse

Field	Type	Required	Description
`data_status`	string	yes	Data Status
`gap_percentage`	number \| null	yes	Gap Percentage
`gap_usd`	number	yes	Gap Usd
`internal_cost_usd`	number	yes	Internal Cost Usd
`last_synced_at`	string \| null	yes	Last Synced At
`models`	array\<ReconciliationModelRowResponse>	yes	Models
`provider`	string	yes	Provider
`provider_cost_usd`	number	yes	Provider Cost Usd
`sku_breakdown`	array\<ProviderSkuCostRowResponse>	yes	Sku Breakdown

ReconciliationSummaryResponse

Field	Type	Required	Description
`from_date`	string	yes	From Date
`providers`	array\<ReconciliationProviderRowResponse>	yes	Providers
`to_date`	string	yes	To Date
`total_gap_usd`	number	yes	Total Gap Usd
`total_internal_cost_usd`	number	yes	Total Internal Cost Usd
`total_provider_cost_usd`	number	yes	Total Provider Cost Usd

RefreshAvailableGroupsResponse

Field	Type	Required	Description
`groups_fetched`	integer	yes	Groups Fetched

RefreshTokenResponse

Field	Type	Required	Description
`access_token`	string	yes	Access Token

RemoteGroup

Field	Type	Required	Description
`description`	string \| null	no	Description
`members`	array\<RemoteGroupMember>	no	Members
`name`	string	yes	Name
`remote_id`	string	yes	Remote Id

RemoteGroupMember

Field	Type	Required	Description
`display_name`	string \| null	no	Display Name
`email`	string	yes	Email

ReorderFavouritesRequest

Field	Type	Required	Description
`order`	array\<FavouriteOrderItem>	yes	Order

ReplaceConversationPayloadRequest

Field	Type	Required	Description
`payload`	array\<ConversationMessage>	yes	Payload

ResourceRight

(no properties)

RevokeApiTokenResponse

Field	Type	Required	Description
`message`	string	yes	Message

RunAutomationRequest

Field	Type	Required	Description
`runtime_message`	string \| null	no	Runtime Message
`runtime_parameters`	object\<string, any> \| null	no	Runtime Parameters

SatisfiedDependencyResponse

Field	Type	Required	Description
`installed_version`	string	yes	Installed Version
`package_id`	string	yes	Package Id
`type`	string	yes	Type

SchedulesResponse

Field	Type	Required	Description
`next_run_date`	string \| null	yes	Next Run Date
`schedule_list`	array\<string>	yes	Schedule List

SearchAssistantDataRequest

Field	Type	Required	Description
`conversation_id`	string \| null	no	Conversation Id
`exact_match`	boolean \| null	no	Exact Match
`query`	string	yes	Query
`strategy`	ContentRetrievingStrategy \| null	no
`where`	object\<string, any> \| null	no	Where

SearchQuery

Field	Type	Required	Description
`limit`	integer	no	Limit
`offset`	integer	no	Offset
`q`	string \| null	no	Q

SearchResponse

Field	Type	Required	Description
`count`	integer	yes	Count
`query`	string	no	Query
`results`	array\<ConversationSearchResult \| AssistantSearchResult>	yes	Results
`total`	integer	no	Total

SearchSourceBody

Field	Type	Required	Description
`config`	object\<string, any>	no	Config
`cursor`	string \| null	no	Cursor
`parent_path`	string \| null	no	Parent Path
`query`	string	yes	Query

SendNotificationRequest

Field	Type	Required	Description
`body`	string	yes	Body
`data`	object\<string, string> \| null	no	Data
`notification_types`	array\<NotificationsTarget>	yes	Notification Types
`title`	string	yes	Title

SendNotificationResponse

Field	Type	Required	Description
`results_by_type`	object\<string, NotificationTypeResult>	yes	Results By Type
`total_endpoints_reached`	integer	yes	Total Endpoints Reached

ServerVersionResponse

Field	Type	Required	Description
`server_version`	string	yes	Server Version

ServiceVisibilityUpdate

Field	Type	Required	Description
`service_name`	string	yes	Service Name
`visibility`	ExternalServiceVisibilityRequest	yes

SetAssistantUserDataRequest

Field	Type	Required	Description
`data`	object\<string, any> \| array\<any>	yes	Data

SetCatalogMetadataRequest

Field	Type	Required	Description
`catalog_package_id`	string	yes	Catalog Package Id
`catalog_package_version`	string	yes	Catalog Package Version

SharedGroup

Field	Type	Required	Description
`id`	string	yes	Id
`is_active`	boolean	yes	Is Active
`name`	string	yes	Name

SharedTeam

Field	Type	Required	Description
`id`	string	yes	Id
`name`	string	yes	Name

SharedUser

Field	Type	Required	Description
`email`	string	yes	Email
`first_name`	string	yes	First Name
`last_name`	string	yes	Last Name
`picture_url`	string \| null	yes	Picture Url

SignedUploadUrlResponse

Field	Type	Required	Description
`content_type`	string	no	Content Type
`fields`	object\<string, any>	no	Fields
`prefix`	string	no	Prefix
`protected_url`	string	no	Protected Url
`upload_mode`	UploadMode	no
`url`	string	yes	Url

SignedUrlResponse

Field	Type	Required	Description
`url`	string	yes	Url

SignedUrlUploadRequest

Field	Type	Required	Description
`file_path`	string	yes	File Path

SkillBuilderJobData

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`celery_task_id`	string \| null	no	Celery Task Id
`conversation_id`	string \| null	no	Conversation Id
`created_at`	string	yes	Created At
`error`	string \| null	no	Error
`external_services`	array\<string>	yes	External Services
`function_output_url`	string \| null	no	Function Output Url
`instructions`	string	yes	Instructions
`is_completed`	boolean	no	Is Completed
`job_id`	string	yes	Job Id
`run_protected_url`	string \| null	no	Run Protected Url
`skill_filename`	string \| null	no	Skill Filename
`skill_id`	string \| null	no	Skill Id
`skill_name`	string \| null	no	Skill Name
`status`	string \| null	no	Status
`type`	string	no	Type

SkillBuilderJobDataList

(no properties)

SkillDeletionResponse

Field	Type	Required	Description
`message`	string	yes	Message

SkillDetailResponse

Field	Type	Required	Description
`avatar_url`	string \| null	no	Avatar Url
`catalog_package_id`	string \| null	no	Catalog Package Id
`catalog_package_version`	string \| null	no	Catalog Package Version
`created_at`	string	yes	Created At
`description`	string \| null	no	Description
`external_services`	array\<string>	yes	External Services
`functions_file_remote_path`	string \| null	no	Functions File Remote Path
`functions_schema`	object\<string, any> \| null	no	Functions Schema
`functions_status`	string \| null	no	Functions Status
`id`	string	yes	Id
`mcp_server`	McpServer \| null	no
`name`	string	yes	Name
`scope`	string	yes	Scope
`secrets`	array\<string>	no	Secrets
`skill_filename`	string \| null	no	Skill Filename
`type`	string	yes	Type
`updated_at`	string	yes	Updated At
`usable_in`	array\<string>	yes	Usable In
`variables`	object\<string, string>	no	Variables
`visibility`	ModelVisibilityResponse \| null	no

SkillSummaryResponse

Field	Type	Required	Description
`avatar_url`	string \| null	no	Avatar Url
`catalog_package_id`	string \| null	no	Catalog Package Id
`catalog_package_version`	string \| null	no	Catalog Package Version
`created_at`	string	yes	Created At
`description`	string \| null	no	Description
`external_services`	array\<string>	yes	External Services
`functions_schema`	object\<string, any> \| null	no	Functions Schema
`functions_status`	string \| null	no	Functions Status
`id`	string	yes	Id
`name`	string	yes	Name
`scope`	string	yes	Scope
`skill_filename`	string \| null	no	Skill Filename
`type`	string	yes	Type
`updated_at`	string	yes	Updated At
`usable_in`	array\<string>	yes	Usable In

SkillSummaryResponseList

(no properties)

SkillUploadAvatarResponse

Field	Type	Required	Description
`content_type`	string	yes	Content Type
`protected_url`	string	yes	Protected Url

SkillUploadResponse

Field	Type	Required	Description
`message`	string	yes	Message
`skill_id`	string	yes	Skill Id

SkillUsableIn

(no properties)

SpecificUserLimitResponse

Field	Type	Required	Description
`emails`	array\<string>	yes	Emails
`limits`	UserLimitsResponse	yes

StreamingSessionResponse

Field	Type	Required	Description
`id`	string	yes	Id
`status`	string	yes	Status

SwitchTenantRequest

Field	Type	Required	Description
`tenant_id`	string (uuid)	yes	Tenant Id

SyncGroupsRequest

Field	Type	Required	Description
`dry_run`	boolean	no	Dry Run

SyncGroupsResponse

Field	Type	Required	Description
`dry_run`	boolean	yes	Dry Run
`group_changes`	array\<GroupChange>	yes	Group Changes
`groups`	array\<RemoteGroup>	yes	Groups
`stats`	SyncGroupsStats	yes

SyncGroupsStats

Field	Type	Required	Description
`errors`	array\<string>	yes	Errors
`groups_found`	integer	yes	Groups Found
`groups_ignored`	integer	yes	Groups Ignored
`groups_to_create`	integer	yes	Groups To Create
`groups_to_update`	integer	yes	Groups To Update
`memberships_to_add`	integer	yes	Memberships To Add
`memberships_to_remove`	integer	yes	Memberships To Remove
`users_not_found`	integer	yes	Users Not Found
`users_to_provision`	integer	no	Users To Provision

SyncHistoryResponse

Field	Type	Required	Description
`limit`	integer	yes	Limit
`offset`	integer	yes	Offset
`runs`	array\<GroupSyncRunResponse>	yes	Runs
`total`	integer	yes	Total

TeamPrincipalsBody

Field	Type	Required	Description
`group_ids`	array\<string (uuid)>	no	Group Ids
`user_ids`	array\<string (uuid)>	no	User Ids

TeamPrincipalsResponse

Field	Type	Required	Description
`group_ids`	array\<string>	yes	Group Ids
`groups`	array\<GroupResponse>	yes	Groups
`user_ids`	array\<string>	yes	User Ids
`users`	array\<UserResponse>	yes	Users

TeamResponse

Field	Type	Required	Description
`created_at`	string	yes	Created At
`id`	string	yes	Id
`members`	TeamPrincipalsResponse	yes
`name`	string	yes	Name
`owners`	TeamPrincipalsResponse	yes
`tenant_id`	string	yes	Tenant Id
`updated_at`	string	yes	Updated At

TeamResponseList

(no properties)

TemplateCanvasResponse

Field	Type	Required	Description
`html`	string	yes	Html

TemplateResponse

Field	Type	Required	Description
`canvas`	TemplateCanvasResponse \| null	no
`description`	LocalizedStringResponse	yes
`id`	string	yes	Id
`logo_url`	string \| null	no	Logo Url
`name`	LocalizedStringResponse	yes
`required_external_services`	array\<string>	yes	Required External Services
`starter_prompt`	LocalizedStringResponse \| null	no
`type`	AssistantType	yes
`version`	string	yes	Version

TemplateResponseList

(no properties)

TenantConfigBody

(no properties)

TenantConfigResponse

(no properties)

TenantCostSummaryResponse

Field	Type	Required	Description
`daily_costs`	array\<object\<string, any>>	no	Daily Costs
`tenant_id`	string	yes	Tenant Id
`tenant_name`	string	yes	Tenant Name
`total_cost`	number	yes	Total Cost
`user_count`	integer	yes	User Count

TenantFeatureVisibilityResponse

Field	Type	Required	Description
`feature`	string	yes	Feature
`visibility`	ModelVisibilityResponse \| null	no

TenantInvoiceDetailsResponse

Field	Type	Required	Description
`candidate_billing_period_end`	string	yes	Candidate Billing Period End
`candidate_billing_period_start`	string	yes	Candidate Billing Period Start
`invoiceable_total_cad`	number	yes	Invoiceable Total Cad
`invoices`	array\<InvoiceResponse>	yes	Invoices
`is_threshold_reached`	boolean	yes	Is Threshold Reached
`minimum_invoice_threshold_cad`	number	yes	Minimum Invoice Threshold Cad
`next_scheduled_invoice_date`	string	yes	Next Scheduled Invoice Date
`remaining_to_threshold_cad`	number	yes	Remaining To Threshold Cad
`tenant_id`	string	yes	Tenant Id
`tenant_name`	string	yes	Tenant Name

TenantMemberResponse

Field	Type	Required	Description
`created_at`	string	yes	Created At
`email`	string	yes	Email
`first_name`	string \| null	yes	First Name
`id`	string	yes	Id
`invitation_id`	string \| null	yes	Invitation Id
`is_service_account`	boolean	no	Is Service Account
`last_active_at`	string \| null	yes	Last Active At
`last_name`	string \| null	yes	Last Name
`picture_url`	string \| null	yes	Picture Url
`roles`	array\<string>	yes	Roles
`status`	string	yes	Status
`type`	string	yes	Type

TenantModelVisibilityResponse

Field	Type	Required	Description
`model_id`	string	yes	Model Id
`visibility`	ModelVisibilityResponse \| null	no

TenantSpendingOverviewItem

Field	Type	Required	Description
`billing_admin_fee_percentage`	number \| null	no	Billing Admin Fee Percentage
`billing_base_monthly_total`	number \| null	no	Billing Base Monthly Total
`billing_excess_usage_fee`	number \| null	no	Billing Excess Usage Fee
`billing_monthly_additional_fees`	number \| null	no	Billing Monthly Additional Fees
`billing_monthly_total`	number \| null	no	Billing Monthly Total
`billing_price_per_seat`	number \| null	no	Billing Price Per Seat
`billing_seat_count`	integer \| null	no	Billing Seat Count
`billing_token_monthly_budget`	number \| null	no	Billing Token Monthly Budget
`current_spending`	number	yes	Current Spending
`registered_user_count`	integer	no	Registered User Count
`spending_limit`	number \| null	no	Spending Limit
`tenant_id`	string	yes	Tenant Id
`tenant_name`	string	yes	Tenant Name
`user_count`	integer	yes	User Count

TenantSpendingOverviewResponseModel

Field	Type	Required	Description
`month`	string	yes	Month
`tenants`	array\<TenantSpendingOverviewItem>	yes	Tenants

TokenUsageByKeyResponse

Field	Type	Required	Description
`usage`	object\<string, TokenUsageResponse>	yes	Usage

TokenUsageResponse

Field	Type	Required	Description
`cache_creation_tokens`	integer	no	Cache Creation Tokens
`cache_tokens`	integer	no	Cache Tokens
`input_tokens`	integer	no	Input Tokens
`output_tokens`	integer	no	Output Tokens
`reasoning_tokens`	integer	no	Reasoning Tokens
`total_cost`	number	no	Total Cost
`total_tokens`	integer	no	Total Tokens

ToolCallFunction

Field	Type	Required	Description
`arguments`	string	yes	Arguments
`name`	string	yes	Name

TransferAssistantOwnershipBody

Field	Type	Required	Description
`owner_team_id`	string (uuid) \| null	no	Owner Team Id
`owner_user_id`	string (uuid) \| null	no	Owner User Id

TriggerAdminTaskResponse

Field	Type	Required	Description
`status`	string	yes	Status

UnreadNotificationsCountResponse

Field	Type	Required	Description
`count`	integer	yes	Count

UpdateApiTokenBody

Field	Type	Required	Description
`description`	string	yes	Description

UpdateAssistantDataRequest

Field	Type	Required	Description
`content`	string \| null	no	Content
`embedding`	array\<any> \| null	no	Embedding
`metadata`	object\<string, any> \| null	no	Metadata

UpdateAssistantDataResponse

Field	Type	Required	Description
`assistant_id`	string	yes	Assistant Id
`message`	string	yes	Message

UpdateAssistantFileRequest

Field	Type	Required	Description
`file_description`	string	yes	File Description
`file_name`	string	yes	File Name
`indexing_strategy`	IndexingStrategy \| null	no

UpdateAssistantRequest

Field	Type	Required	Description
`allowed_external_services`	array\<any> \| null	no	Allowed External Services
`allowed_functions`	array\<any> \| null	no	Allowed Functions
`avatar_url`	string \| null	no	Avatar Url
`content_retrieving_strategy`	ContentRetrievingStrategy	no
`delegations`	array\<DelegationRequest> \| null	no	Delegations
`description`	string	yes	Description
`instructions`	string	yes	Instructions
`links`	array\<LinkRequest>	yes	Links
`llm_args`	object\<string, any> \| null	no	Llm Args
`mcp_servers`	array\<McpServer> \| null	no	Mcp Servers
`model`	string \| null	no	Model
`name`	string	yes	Name
`prompt_starters`	array\<string>	yes	Prompt Starters
`secrets`	object\<string, string \| null> \| null	no	Secrets
`type`	AssistantType \| null	no
`ui_url`	string \| null	no	Ui Url
`use_system_prompt`	boolean	yes	Use System Prompt
`variables`	object\<string, string> \| null	no	Variables
`visibility`	AssistantVisibilityRequest	yes

UpdateAutomationRequest

Field	Type	Required	Description
`external_services`	array\<string> \| null	no	External Services
`name`	string \| null	no	Name
`payload`	AutomationPayloadRequest \| null	no
`schedules`	object\<string, any> \| null	no	Schedules

UpdateContractInfoRequest

Field	Type	Required	Description
`admin_fee_percentage`	number	no	Admin Fee Percentage
`allowed_providers`	array\<string> \| null	no	Allowed Providers
`harvest_client_id`	integer \| null	no	Harvest Client Id
`monthly_additional_fees`	number	no	Monthly Additional Fees
`price_per_seat`	number	no	Price Per Seat
`required_tags`	array\<string> \| null	no	Required Tags
`seat_limit`	integer \| null	no	Seat Limit
`token_monthly_budget`	number	yes	Token Monthly Budget

UpdateConversationMessageRequest

Field	Type	Required	Description
`message`	ConversationMessage	yes
`user_message_index`	integer \| null	no	User Message Index

UpdateConversationRequest

Field	Type	Required	Description
`model`	string \| null	no	Model
`title`	string \| null	no	Title

UpdateConversationUserDataKeyRequest

Field	Type	Required	Description
`data`	any	no	Data

UpdateConversationUserDataRequest

(no properties)

UpdateDefaultEmbeddingModelRequest

Field	Type	Required	Description
`default_embedding_model_id`	string \| null	no	Default Embedding Model Id

UpdateDefaultModelRequest

Field	Type	Required	Description
`default_model_id`	string \| null	no	Default Model Id

UpdateGlobalSkillForm

Field	Type	Required	Description
`file`	string (binary) \| null	no	File
`skill_data`	string \| null	no	Skill Data

UpdateGroupSelectionsRequest

Field	Type	Required	Description
`add`	array\<GroupSelectionItem>	no	Add
`remove`	array\<GroupSelectionItem>	no	Remove

UpdateGroupSelectionsResponse

Field	Type	Required	Description
`status`	string	yes	Status

UpdateKnowledgeSourceConfigurationBody

Field	Type	Required	Description
`allowed_resources`	array\<string>	no	Allowed Resources
`assistant_creation_access`	KnowledgeSourceAssistantCreationAccessRequest \| null	no
`external_service_name`	string \| null	no	External Service Name

UpdateMemoryRequest

Field	Type	Required	Description
`always_inject`	boolean \| null	no	Always Inject
`content`	string \| null	no	Content
`metadata`	object\<string, any> \| null	no	Metadata

UpdateNotificationPreferencesBody

Field	Type	Required	Description
`email`	boolean	yes	Email

UpdatePackageResponse

Field	Type	Required	Description
`installed`	InstalledEntityResponse	yes
`outcome`	string	yes	Outcome
`package_id`	string	yes	Package Id

UpdateProjectRequest

Field	Type	Required	Description
`description`	string	yes	Description
`name`	string	yes	Name

UpdateProviderApiKeysRequest

Field	Type	Required	Description
`api_key`	string \| null	no	Api Key
`apply_to_provider`	boolean	no	Apply To Provider
`provider_or_model_id`	string	yes	Provider Or Model Id

UpdateProvisioningModeRequest

Field	Type	Required	Description
`group_role_mapping`	object\<string, string> \| null	no	Group Role Mapping
`provisioning_mode`	ProvisioningMode	yes
`required_group`	string \| null	no	Required Group

UpdateTeamBody

Field	Type	Required	Description
`name`	string	yes	Name

UpdateUserCustomPromptBody

Field	Type	Required	Description
`prompt`	string	yes	Prompt

UpdateUserDisplayNameRequest

Field	Type	Required	Description
`first_name`	string	yes	First Name
`last_name`	string	no	Last Name

UpdateUserPreferencesBody

Field	Type	Required	Description
`dismissed_tours`	array\<string> \| null	no	Dismissed Tours
`favorite_model_ids`	array\<string> \| null	no	Favorite Model Ids
`keyboard_shortcuts_enabled`	boolean \| null	no	Keyboard Shortcuts Enabled

UpdateUserRoleRequest

Field	Type	Required	Description
`role`	UserRole	yes

UploadAssistantAvatarForm

Field	Type	Required	Description
`file`	string (binary)	yes	File

UploadAssistantFileForm

Field	Type	Required	Description
`file`	string (binary)	yes	File
`file_type`	string \| null	no	File Type

UploadGlobalSkillForm

Field	Type	Required	Description
`file`	string (binary) \| null	no	File
`skill_data`	string	yes	Skill Data

UploadKnowledgeBaseFileForm

Field	Type	Required	Description
`file`	string (binary)	yes	File

UploadMode

(no properties)

UploadSkillAvatarForm

Field	Type	Required	Description
`file`	string (binary)	yes	File

UploadTenantLogoForm

Field	Type	Required	Description
`file`	string (binary)	yes	File
`logo_type`	string	no	Logo Type

UsageApiKeyBreakdownResponse

Field	Type	Required	Description
`api_token_id`	string	yes	Api Token Id
`description`	string	yes	Description
`masked_value`	string	yes	Masked Value
`models`	array\<UsageModelBreakdownResponse>	yes	Models
`percent_of_total`	number	yes	Percent Of Total
`total_cost`	number	yes	Total Cost

UsageFeatureBreakdownResponse

Field	Type	Required	Description
`feature`	string	yes	Feature
`models`	array\<UsageModelBreakdownResponse>	yes	Models
`percent_of_total`	number	yes	Percent Of Total
`total_cost`	number	yes	Total Cost

UsageModelBreakdownResponse

Field	Type	Required	Description
`model`	string	yes	Model
`percent_of_total`	number	yes	Percent Of Total
`total_cost`	number	yes	Total Cost

UsageProviderBreakdownResponse

Field	Type	Required	Description
`models`	array\<UsageModelBreakdownResponse>	yes	Models
`percent_of_total`	number	yes	Percent Of Total
`provider`	string	yes	Provider
`total_cost`	number	yes	Total Cost

UsageReportModelBreakdown

Field	Type	Required	Description
`input_tokens`	integer	yes	Input Tokens
`model`	string	yes	Model
`output_tokens`	integer	yes	Output Tokens
`provider`	string	yes	Provider
`request_count`	integer	yes	Request Count
`total_cost`	number	yes	Total Cost
`total_tokens`	integer	yes	Total Tokens
`usage_type`	string	yes	Usage Type

UsageReportProviderBreakdown

Field	Type	Required	Description
`models`	array\<UsageReportModelBreakdown>	yes	Models
`provider`	string	yes	Provider
`request_count`	integer	yes	Request Count
`total_cost`	number	yes	Total Cost
`total_tokens`	integer	yes	Total Tokens

UsageStatisticsResponse

Field	Type	Required	Description
`active_conversation_30`	integer	yes	Active Conversation 30
`active_user_30`	integer	yes	Active User 30
`assistant_count`	integer	yes	Assistant Count
`new_user_30`	integer	yes	New User 30
`user_count`	integer	yes	User Count

UsageSummaryResponse

Field	Type	Required	Description
`by_provider`	array\<UsageReportProviderBreakdown>	yes	By Provider
`daily_cost`	number	yes	Daily Cost
`daily_limit`	number \| null	yes	Daily Limit
`monthly_cost`	number	yes	Monthly Cost
`monthly_limit`	number \| null	yes	Monthly Limit

UserCustomPromptResponse

Field	Type	Required	Description
`prompt`	string \| null	no	Prompt

UserFirstUsageMonthResponse

Field	Type	Required	Description
`first_month`	string \| null	yes	First Month
`user_id`	string	yes	User Id

UserLimitsResponse

Field	Type	Required	Description
`daily`	number \| null	no	Daily
`monthly`	number \| null	no	Monthly

UserPreferencesResponse

Field	Type	Required	Description
`dismissed_tours`	array\<string>	yes	Dismissed Tours
`favorite_model_ids`	array\<string>	yes	Favorite Model Ids
`keyboard_shortcuts_enabled`	boolean \| null	no	Keyboard Shortcuts Enabled

UserResolvedFeatureResponse

Field	Type	Required	Description
`control`	string	yes	Control
`key`	string	yes	Key
`scope`	string	yes	Scope

UserResolvedFeatureResponseList

(no properties)

UserResponse

Field	Type	Required	Description
`email`	string	yes	Email
`first_name`	string	yes	First Name
`id`	string	yes	Id
`last_name`	string	yes	Last Name
`picture_url`	string \| null	yes	Picture Url
`status`	string	yes	Status

UserResponseList

(no properties)

UserRole

(no properties)

UserStatsResponse

Field	Type	Required	Description
`conversation_count`	integer	yes	Conversation Count

UserTeamResponse

Field	Type	Required	Description
`created_at`	string	yes	Created At
`id`	string	yes	Id
`members`	TeamPrincipalsResponse	yes
`name`	string	yes	Name
`owners`	TeamPrincipalsResponse	yes
`role`	string	yes	Role
`tenant_id`	string	yes	Tenant Id
`updated_at`	string	yes	Updated At

UserTeamResponseList

(no properties)

UserUsageDetailQuery

Field	Type	Required	Description
`month`	string	yes	Month

UserUsageResponse

Field	Type	Required	Description
`daily_usage`	array\<DailyUsage>	yes	Daily Usage
`month`	string	yes	Month
`total_cost`	number	yes	Total Cost
`total_tokens`	integer	yes	Total Tokens
`user_id`	string	yes	User Id

ValidateInstallBody

Field	Type	Required	Description
`version`	string \| null	no	Version

ValidationError

(no properties)

ValidationErrorElement

Field	Type	Required	Description
`ctx`	object\<string, any> \| null	no	Error context
`loc`	array\<string>	yes	Missing field name
`msg`	string	yes	Error message
`type`	string	yes	Error type

ValidationWarning

Field	Type	Required	Description
`code`	string	yes	Code
`value`	string	yes	Value

VideoAspectRatio

(no properties)

VideoGenerationBody

Field	Type	Required	Description
`aspect_ratio`	VideoAspectRatio \| null	no
`conversation_id`	string (uuid) \| null	no	Conversation Id
`duration`	string \| null	no	Duration
`generate_audio`	boolean \| null	no	Generate Audio
`image`	ImageObject \| null	no
`model`	string \| null	no	Model
`nb_outputs`	integer \| null	no	Nb Outputs
`prompt`	string	yes	Prompt
`resolution`	VideoResolution \| null	no
`video_id`	string \| null	no	Video Id

VideoGenerationModelResponse

Field	Type	Required	Description
`api`	string	yes	Api
`capabilities_tags`	array\<string> \| null	no	Capabilities Tags
`description`	string \| null	no	Description
`displayName`	string	yes	Displayname
`id`	string	yes	Id
`info_tags`	array\<string> \| null	no	Info Tags
`max_outputs`	integer \| null	no	Max Outputs
`model`	string	yes	Model
`provider`	string	yes	Provider
`release_date`	string \| null	no	Release Date
`tags`	array\<string> \| null	no	Tags
`usage_pricing`	object\<string, any>	no	Usage Pricing
`video_aspect_ratio_mapping`	object\<string, any> \| null	no	Video Aspect Ratio Mapping
`video_duration_mapping`	object\<string, any> \| null	no	Video Duration Mapping
`video_resolution_mapping`	object\<string, any> \| null	no	Video Resolution Mapping

VideoGenerationModelResponseList

(no properties)

VideoJobDownloadResponse

Field	Type	Required	Description
`job_id`	string	yes	Job Id
`video_urls`	array\<string>	yes	Video Urls

VideoJobResponse

Field	Type	Required	Description
`job_id`	string	yes	Job Id
`model`	string	yes	Model
`provider`	string	yes	Provider

VideoJobStatusResponse

Field	Type	Required	Description
`error`	string \| null	no	Error
`job_id`	string	yes	Job Id
`status`	AsyncJobStatus	yes

VideoResolution

(no properties)

VisibilityType

(no properties)

VisionForm

Field	Type	Required	Description
`model`	string	yes	Model
`prompt`	string	yes	Prompt

VisionResponse

Field	Type	Required	Description
`response`	string	yes	Response

WebappConfigResponse

(no properties)

WebhookResponse

Field	Type	Required	Description
`result`	string	yes	Result

WorkflowDebugConversationResponse

Field	Type	Required	Description
`conversationId`	string	yes	Conversationid

WorkflowDebugRunBody

Field	Type	Required	Description
`inputs`	object\<string, any> \| null	no	Inputs

WorkflowRunRequestBody

Field	Type	Required	Description
`conversation_id`	string \| null	no	Conversation Id
`inputs`	object\<string, any>	no	Inputs

WorkflowRunResponse

Field	Type	Required	Description
`conversationId`	string	yes	Conversationid
`currentStepId`	string \| null	no	Currentstepid
`result`	any \| null	no	Result
`runId`	string	yes	Runid
`status`	WorkflowRunStatus	yes

WorkflowRunResumeBody

Field	Type	Required	Description
`edits`	object\<string, any> \| null	no	Edits

WorkflowRunStatus

(no properties)