Documentation
SDK Reference: Types
All dataclasses and response types in the SDK
Imports
Core types and enums are importable directly from scopix: from scopix import DescriptionStatus, UploadResult, ChatResponse. Feature-specific types live in submodules (scopix.types.colors, scopix.types.usage, scopix.types.video, etc.).
Core Enums
DescriptionStatus, ChatTokenType, StorageTarget, MessageRole, and other enums.
Upload Types
UploadResult, BatchUploadResults, QuotaInfo.
Callback Types
UploadProgressEvent plus video, document, and cloud-storage progress events.
Chat Types
ChatResponse, ChatToken, ChatSession, ChatMessage, SessionList, and more.
Search Types
ImageSearchAgentResult, DocumentSearchAgentResult, ResultRefData.
File Types
UserFile, UserFileDetails, FileList, FullDescription.
Folder Types
Folder, FolderTree, FolderContents, FolderBreadcrumbs, DeleteFolderResult, MoveFilesResult.
Color Types
ColorAnalysis, DominantColor, RGB, HSL, LAB, ColorSearchResponse.
Tenant Types
TenantSettings, TenantLimits, TenantMember, MemberRole.
Audit Types
AuditLogEntry, AuditLogList, AuditEventType, AuditSeverity.
Usage Types
UsageCheckResult, UsageSummary, PlanUtilization, DashboardAnalytics, MonthlyTokenUsage, and more.
Settings Types
S3ConfigStatus, S3ValidationResult.
Document Types
DocumentUploadResult, DocumentDetails, DocumentSearchResponse, DocumentItem, DocumentList, DocumentChunk.
Link Types
LinkItem, LinkList, LinkDetails, CreateLinkResult, LinkOGMetadata, LinkCrawlStatus.
Cloud Storage Types
CloudStorageConnection, CloudStorageJob, ImportResult, ExportResult, CloudFileInput.
Agent Operations Types
SynthesizeResult, DocumentAnalysisResult, ChunkReference.
Agent Data Flow Types
AgentCapability, AgentContract, TypedInput, TypedOutput, ExecutionContext, TypedSlot, Agent, AgentResult, Category, CategorizationResult, DataTypeRegistry, FileRef, FileCollection, FileResolver, FileResolutionError.
Pipeline Types
Pipeline, PipelineResult, PipelineStep, StepResult.
Video Types
VideoAnalysisJobStatus, VideoAnalysisQueueResult, VideoScene, VideoSceneList, VideoMetadata, and status enums.