Skip to content
Cyoda Documentation
API Ref
Search
Ctrl
K
Cancel
GitHub
LinkedIn
Discord
YouTube
View Markdown
Settings
Theme
Auto
Light
Dark
API Reference
Scalar
Stoplight
Getting Started
Install cyoda-go and create your first entity
Concepts
What is Cyoda?
Design principles
Entities and lifecycle
Workflows and events
Digital twins and the growth path
APIs and surfaces
Authentication and identity
Build
Build
Modeling entities
Working with entities
Searching entities
Workflows and processors
Client compute nodes
Analytics with SQL
Testing with digital twins
Run
Run
cyoda-cloud
Cyoda Cloud
Provisioning (Cyoda Cloud)
Identity and entitlements (Cyoda Cloud)
Status and roadmap (Cyoda Cloud)
Desktop (single binary)
Docker
Kubernetes
Reference
Reference
`cyoda help` — topic tree
API reference
Entity model export (SIMPLE_VIEW)
Trino SQL surface
CLI
Configuration
Helm values
schemas
JSON Schemas
common
Common Schemas
BaseEvent
CloudEventType
DataFormat
DataPayload
EntityChangeMeta
EntityMetadata
ErrorCode
ModelConverterType
ModelInfo
ModelSpec
statemachine
Statemachine Schemas
ProcessorInfo
TransitionInfo
WorkflowInfo
entity
Entity Schemas
EntityCreateCollectionRequest
EntityCreatePayload
EntityCreateRequest
EntityDeleteAllRequest
EntityDeleteAllResponse
EntityDeleteRequest
EntityDeleteResponse
EntityTransactionInfo
EntityTransactionResponse
EntityTransitionRequest
EntityTransitionResponse
EntityUpdateCollectionRequest
EntityUpdatePayload
EntityUpdateRequest
model
Model Schemas
EntityModelDeleteRequest
EntityModelDeleteResponse
EntityModelExportRequest
EntityModelExportResponse
EntityModelGetAllRequest
EntityModelGetAllResponse
EntityModelImportRequest
EntityModelImportResponse
EntityModelTransitionRequest
EntityModelTransitionResponse
processing
Processing Schemas
CalculationMemberGreetEvent
CalculationMemberJoinEvent
CalculationMemberKeepAliveEvent
EntityCriteriaCalculationRequest
EntityCriteriaCalculationResponse
EntityProcessorCalculationRequest
EntityProcessorCalculationResponse
EventAckResponse
search
Search Schemas
EntityChangesMetadataGetRequest
EntityChangesMetadataResponse
EntityGetAllRequest
EntityGetRequest
EntityResponse
EntitySearchRequest
EntitySnapshotSearchRequest
EntitySnapshotSearchResponse
EntityStatsByStateGetRequest
EntityStatsByStateResponse
EntityStatsGetRequest
EntityStatsResponse
SearchSnapshotStatus
SnapshotCancelRequest
SnapshotGetRequest
SnapshotGetStatusRequest
GitHub
LinkedIn
Discord
YouTube
Select theme
Dark
Light
Auto
Processing Schemas
Processing Schemas
Section titled “Processing Schemas”
This section contains JSON schemas for processing.
Available Schemas
Section titled “Available Schemas”
EventAckResponse
EntityProcessorCalculationResponse
EntityProcessorCalculationRequest
EntityCriteriaCalculationResponse
EntityCriteriaCalculationRequest
CalculationMemberKeepAliveEvent
CalculationMemberJoinEvent
CalculationMemberGreetEvent