Skip to main content

types

Workspace API


Workspace API / types

types

References

ApiResponse

Re-exports ApiResponse


PaginatedResponse

Re-exports PaginatedResponse


ErrorResponse

Re-exports ErrorResponse


PaginationParams

Re-exports PaginationParams


SearchParams

Re-exports SearchParams


SortParams

Re-exports SortParams


DateRangeParams

Re-exports DateRangeParams


StatusParams

Re-exports StatusParams


RefreshToken

Re-exports RefreshToken


UserSession

Re-exports UserSession


MfaCode

Re-exports MfaCode


LoginRequest

Re-exports LoginRequest


RegisterRequest

Re-exports RegisterRequest


MfaVerifyRequest

Re-exports MfaVerifyRequest


AuthResponse

Re-exports AuthResponse


RefreshTokenRequest

Re-exports RefreshTokenRequest


JwtPayload

Re-exports JwtPayload


JwtOrganizationRole

Re-exports JwtOrganizationRole


ConversationScope

Re-exports ConversationScope


MessageRole

Re-exports MessageRole


SyncStatus

Re-exports SyncStatus


Conversation

Re-exports Conversation


ConversationWithSummary

Re-exports ConversationWithSummary


ConversationSummaryData

Re-exports ConversationSummaryData


Message

Re-exports Message


RAGChunk

Re-exports RAGChunk


ThoughtChunk

Re-exports ThoughtChunk


MessageMetadata

Re-exports MessageMetadata


MessageError

Re-exports MessageError


CreateConversationData

Re-exports CreateConversationData


UpdateConversationData

Re-exports UpdateConversationData


CreateMessageData

Re-exports CreateMessageData


ConversationFilters

Re-exports ConversationFilters


MessagePaginationOptions

Re-exports MessagePaginationOptions


CreateConversationRequest

Re-exports CreateConversationRequest


UpdateConversationRequest

Re-exports UpdateConversationRequest


AddMessageRequest

Re-exports AddMessageRequest


SyncConversationRequest

Re-exports SyncConversationRequest


SyncMessageData

Re-exports SyncMessageData


BulkSyncRequest

Re-exports BulkSyncRequest


ConversationResponse

Re-exports ConversationResponse


MessageResponse

Re-exports MessageResponse


ConversationWithMessagesResponse

Re-exports ConversationWithMessagesResponse


ListConversationsResponse

Re-exports ListConversationsResponse


SyncResponse

Re-exports SyncResponse


SyncConflict

Re-exports SyncConflict


SyncError

Re-exports SyncError


MAX_CONVERSATIONS_PER_USER

Re-exports MAX_CONVERSATIONS_PER_USER


MAX_MESSAGE_CONTENT_LENGTH

Re-exports MAX_MESSAGE_CONTENT_LENGTH


MAX_CHUNKS_PER_MESSAGE

Re-exports MAX_CHUNKS_PER_MESSAGE


DEFAULT_MESSAGE_LIMIT

Re-exports DEFAULT_MESSAGE_LIMIT


MAX_MESSAGE_LIMIT

Re-exports MAX_MESSAGE_LIMIT


DEFAULT_CONVERSATION_TITLE

Re-exports DEFAULT_CONVERSATION_TITLE


MAX_TITLE_LENGTH

Re-exports MAX_TITLE_LENGTH


MAX_TIMESTAMP_SKEW_MS

Re-exports MAX_TIMESTAMP_SKEW_MS


Organization

Re-exports Organization


CreateOrganizationData

Re-exports CreateOrganizationData


UpdateOrganizationData

Re-exports UpdateOrganizationData


OrganizationFilters

Re-exports OrganizationFilters


UserOrganization

Re-exports UserOrganization


OrganizationMember

Re-exports OrganizationMember


OrganizationStats

Re-exports OrganizationStats


OrganizationMemberWithDetails

Re-exports OrganizationMemberWithDetails


OrganizationResponse

Re-exports OrganizationResponse


CreateOrganizationRequest

Re-exports CreateOrganizationRequest


UpdateOrganizationRequest

Re-exports UpdateOrganizationRequest


Permission

Re-exports Permission


CreatePermissionData

Re-exports CreatePermissionData


UpdatePermissionData

Re-exports UpdatePermissionData


PermissionFilters

Re-exports PermissionFilters


PermissionResponse

Re-exports PermissionResponse


CreatePermissionRequest

Re-exports CreatePermissionRequest


UpdatePermissionRequest

Re-exports UpdatePermissionRequest


UserPermission

Re-exports UserPermission


Project

Re-exports Project


CreateProjectData

Re-exports CreateProjectData


UpdateProjectData

Re-exports UpdateProjectData


ProjectFilters

Re-exports ProjectFilters


ProjectStats

Re-exports ProjectStats


ProjectWithOrganization

Re-exports ProjectWithOrganization


ProjectResponse

Re-exports ProjectResponse


CreateProjectRequest

Re-exports CreateProjectRequest


UpdateProjectRequest

Re-exports UpdateProjectRequest


ProjectMember

Re-exports ProjectMember


ProjectMemberWithDetails

Re-exports ProjectMemberWithDetails


AddProjectMemberData

Re-exports AddProjectMemberData


UpdateProjectMemberData

Re-exports UpdateProjectMemberData


ProjectMemberFilters

Re-exports ProjectMemberFilters


ProjectRole

Re-exports ProjectRole


ProjectPermission

Re-exports ProjectPermission


ProjectMemberResponse

Re-exports ProjectMemberResponse


AddProjectMemberRequest

Re-exports AddProjectMemberRequest


UpdateProjectMemberRequest

Re-exports UpdateProjectMemberRequest


RAGScope

Re-exports RAGScope


RAGQueryRequest

Re-exports RAGQueryRequest


RAGHistoryPayload

Re-exports RAGHistoryPayload


QueryIntent

Re-exports QueryIntent


IntentClassificationResult

Re-exports IntentClassificationResult


ContextUsageResult

Re-exports ContextUsageResult


DocumentChunk

Re-exports DocumentChunk


RerankerSkipReason

Re-exports RerankerSkipReason


RAGConfidenceMetrics

Re-exports RAGConfidenceMetrics


RAGQueryResponse

Re-exports RAGQueryResponse


RAGStreamChunk

Re-exports RAGStreamChunk


SystemRole

Re-exports SystemRole


OrganizationRole

Re-exports OrganizationRole


OrganizationRoleWithPermissions

Re-exports OrganizationRoleWithPermissions


CreateSystemRoleData

Re-exports CreateSystemRoleData


CreateOrganizationRoleData

Re-exports CreateOrganizationRoleData


UpdateSystemRoleData

Re-exports UpdateSystemRoleData


UpdateOrganizationRoleData

Re-exports UpdateOrganizationRoleData


SystemRoleFilters

Re-exports SystemRoleFilters


OrganizationRoleFilters

Re-exports OrganizationRoleFilters


RolePermissionAssignment

Re-exports RolePermissionAssignment


UserRoleAssignment

Re-exports UserRoleAssignment


UserRoleAssignmentWithDetails

Re-exports UserRoleAssignmentWithDetails


CreateUserRoleAssignmentData

Re-exports CreateUserRoleAssignmentData


UpdateUserRoleAssignmentData

Re-exports UpdateUserRoleAssignmentData


UserRoleAssignmentFilters

Re-exports UserRoleAssignmentFilters


SystemRoleResponse

Re-exports SystemRoleResponse


OrganizationRoleResponse

Re-exports OrganizationRoleResponse


CreateSystemRoleRequest

Re-exports CreateSystemRoleRequest


CreateOrganizationRoleRequest

Re-exports CreateOrganizationRoleRequest


UpdateSystemRoleRequest

Re-exports UpdateSystemRoleRequest


UpdateOrganizationRoleRequest

Re-exports UpdateOrganizationRoleRequest


AssignSystemRoleRequest

Re-exports AssignSystemRoleRequest


AssignCustomRoleRequest

Re-exports AssignCustomRoleRequest


UserRoleInfo

Re-exports UserRoleInfo


AvailableRoles

Re-exports AvailableRoles


JSONSchema

Re-exports JSONSchema


DomainPack

Re-exports DomainPack


DomainPolicyDefaults

Re-exports DomainPolicyDefaults


Skill

Re-exports Skill


SkillVersionMetadata

Re-exports SkillVersionMetadata


SkillVersion

Re-exports SkillVersion


SkillModelSpec

Re-exports SkillModelSpec


SkillPolicy

Re-exports SkillPolicy


SkillCaps

Re-exports SkillCaps


SkillWorkflow

Re-exports SkillWorkflow


WorkflowStepType

Re-exports WorkflowStepType


WorkflowStep

Re-exports WorkflowStep


WorkflowStatus

Re-exports WorkflowStatus


StepStatus

Re-exports StepStatus


WorkflowRun

Re-exports WorkflowRun


WorkflowStepRecord

Re-exports WorkflowStepRecord


ToolCallRecord

Re-exports ToolCallRecord


WorkflowErrorCode

Re-exports WorkflowErrorCode


WorkflowError

Re-exports WorkflowError


SkillSSEEvent

Re-exports SkillSSEEvent


SkillMetadata

Re-exports SkillMetadata


SkillPlan

Re-exports SkillPlan


StepUpdate

Re-exports StepUpdate


ToolCallEvent

Re-exports ToolCallEvent


ToolResultEvent

Re-exports ToolResultEvent


SkillComplete

Re-exports SkillComplete


MatchReason

Re-exports MatchReason


SkillSuggestion

Re-exports SkillSuggestion


SuggestSkillsRequest

Re-exports SuggestSkillsRequest


RunSkillRequest

Re-exports RunSkillRequest


CreateSkillRequest

Re-exports CreateSkillRequest


CreateSkillVersionRequest

Re-exports CreateSkillVersionRequest


SkillUsageEventType

Re-exports SkillUsageEventType


SkillUsageEvent

Re-exports SkillUsageEvent


VALID_WORKFLOW_TRANSITIONS

Re-exports VALID_WORKFLOW_TRANSITIONS


VALID_STEP_TRANSITIONS

Re-exports VALID_STEP_TRANSITIONS


canTransitionWorkflow

Re-exports canTransitionWorkflow


canTransitionStep

Re-exports canTransitionStep


User

Re-exports User


CreateUserData

Re-exports CreateUserData


UpdateUserData

Re-exports UpdateUserData


UserFilters

Re-exports UserFilters


PasswordValidation

Re-exports PasswordValidation


UserStats

Re-exports UserStats


UserResponse

Re-exports UserResponse


CreateUserRequest

Re-exports CreateUserRequest


UpdateUserRequest

Re-exports UpdateUserRequest