Types

Every entity in Aeontel as a TypeScript type. Field shapes, constraints, and back-references to the methods that consume them.

Every entity in Aeontel as a TypeScript type. Field shapes, constraints, and back-references to the methods that consume them.

All

• AddEdgeDefinitionBody — The AddEdgeDefinitionBody entity.
• AddGraphNodeBody — Request body for a GraphNode operation.
• AddNodeDefinitionBody — The AddNodeDefinitionBody entity.
• AddOrganizationMemberBody — Request body for an OrganizationMember operation.
• AddSolutionMemberBody — Request body for a SolutionMember operation.
• AddSolutionMembersBody — Request body for a SolutionMember operation.
• AddSolutionMembersResponse — Response payload for a SolutionMember endpoint.
• AddSwarmEdgeBody — Request body for a SwarmEdge operation.
• AddSwarmNodeBody — Request body for a SwarmNode operation.
• AddTeamMemberBody — Request body for a TeamMember operation.
• AddThreadParticipantBody — Request body for a ThreadParticipant operation.
• AddWorkflowEdgeBody — Request body for a WorkflowEdge operation.
• AddWorkflowNodeBody — Request body for a WorkflowNode operation.
• AddWorkspaceMemberBody — Request body for a WorkspaceMember operation.
• Agent — The Agent entity.
• AgentVersion — The AgentVersion entity.
• Api — The Api entity.
• ApiKey — The ApiKey entity.
• ApiKeyCreated — Shape returned when an ApiKey is first created.
• ApiRateLimit — The ApiRateLimit entity.
• App — The App entity.
• AppConfig — The AppConfig entity.
• AppDomain — The AppDomain entity.
• AppDomainStatus — The AppDomainStatus entity.
• AppFile — The AppFile entity.
• AppPreviewSession — The AppPreviewSession entity.
• AppPreviewSessionStatus — The AppPreviewSessionStatus entity.
• AppVersion — The AppVersion entity.
• BrowserRenderOptions — Shared render options for Cloudflare Browser Rendering quick actions. Mirrors the CF REST API; every field is optional and passed through as provided. See https://developers.cloudflare.com/browser-rendering/.
• BrowseTableResponse — The BrowseTableResponse entity.
• Build — The Build entity.
• BuildStep — The BuildStep entity.
• BuildWithSteps — The BuildWithSteps entity.
• CancelBuildBody — Request body for a Build operation.
• CancelDeployBody — Request body for a Deploy operation.
• CleanupResourceType — The CleanupResourceType entity.
• CleanupTask — The CleanupTask entity.
• CleanupTaskStatus — The CleanupTaskStatus entity.
• ColumnInfo — The ColumnInfo entity.
• CompleteFileUploadBody — Request body for a File operation.
• Connector — The Connector entity.
• ConnectorConnectResponse — Response payload for a Connector endpoint.
• ConnectorWithStatus — The ConnectorWithStatus entity.
• CorsPolicy — The CorsPolicy entity.
• CreateAgentBody — Request body for creating an Agent.
• CreateAgentVersionBody — Request body for creating an AgentVersion.
• CreateApiBody — Request body for creating an Api.
• CreateApiKeyBody — Request body for creating an ApiKey.
• CreateAppBody — Request body for creating an App.
• CreateAppPreviewSessionBody — Request body for creating an AppPreviewSession.
• CreateAppVersionBody — Request body for creating an AppVersion.
• CreateAppVersionFileBody — Request body for an AppVersion operation.
• CreateBuildBody — Request body for creating a Build.
• CreateDatabaseBody — Request body for creating a Database.
• CreateDeployBody — Request body for creating a Deploy.
• CreateDirectoryBody — Request body for creating a Directory.
• CreateElementBody — Request body for creating an Element.
• CreateElementVersionBody — Request body for creating an ElementVersion.
• CreateElementVersionFileBody — Request body for an ElementVersion operation.
• CreateEndpointBody — Request body for creating an Endpoint.
• CreateFileBody — Body for POST /api/files — initiate a multipart upload and create a file row in uploading state. The response returns the file id plus signed URLs for each part so the client can PUT bytes directly to R2.
• CreateFileResponse — Response payload for a File endpoint.
• CreateFunctionBody — Request body for creating a Function.
• CreateFunctionFileBody — Request body for creating a FunctionFile.
• CreateFunctionVersionBody — Request body for creating a FunctionVersion.
• CreateGraphDefinitionBody — Request body for creating a GraphDefinition.
• CreateGraphInstanceBody — Request body for a Graph operation.
• CreateHtmlFromUrlBody — The CreateHtmlFromUrlBody entity.
• CreateIntegrationBody — Request body for creating an Integration.
• CreateMarkdownFromUrlBody — The CreateMarkdownFromUrlBody entity.
• CreateMcpServerBody — Request body for creating a McpServer.
• CreateOAuthApplicationBody — Request body for creating an OAuthApplication.
• CreateOrganizationBody — Request body for creating an Organization.
• CreatePageBody — Request body for creating a Page.
• CreatePdfFromUrlBody — The CreatePdfFromUrlBody entity.
• CreateRunBody — Request body for POST /api/runs — the single endpoint to execute any entity.

id is a prefixed entity ID (agt*, fun*, swm*, wfl*) — the handler detects the entity type from the prefix. input defaults to { text: string } but accepts any JSON object when the entity defines a custom input schema.

• CreateScheduleBody — Request body for creating a Schedule.
• CreateSchemaBody — Request body for creating a Schema.
• CreateScreenshotFromUrlBody — The CreateScreenshotFromUrlBody entity.
• CreateSecretBody — Request body for creating a Secret.
• CreateSkillBody — Request body for creating a Skill.
• CreateSolutionBody — Request body for creating a Solution.
• CreateSpecBody — Request body for creating a Spec.
• CreateSwarmBody — Request body for creating a Swarm.
• CreateSwarmVersionBody — Request body for creating a SwarmVersion.
• CreateTeamBody — Request body for creating a Team.
• CreateThreadBody — Request body for creating a Thread.
• CreateTokenBody — The CreateTokenBody entity.
• CreateToolBody — Request body for creating a Tool.
• CreateTriggerBody — Request body for creating a Trigger.
• CreateWebhookEndpointBody — Request body for creating a WebhookEndpoint.
• CreateWebhookSubscriptionBody — Request body for creating a WebhookSubscription.
• CreateWorkflowBody — Request body for creating a Workflow.
• CreateWorkspaceBody — Request body for creating a Workspace.
• Database — The Database entity.
• DatabaseKind — The DatabaseKind entity.
• DatabaseStatus — The DatabaseStatus entity.
• Deploy — The Deploy entity.
• DeployStep — The DeployStep entity.
• DeployWithSteps — The DeployWithSteps entity.
• DescribeTableResponse — The DescribeTableResponse entity.
• Directory — Directory — hierarchical organization for files within a workspace. Every workspace has a synthetic root directory created on workspace.created; user-created directories descend from it. Both a display name and a URL-safe slug. Sibling slugs are unique per parent.
• Element — The Element entity.
• ElementVersion — The ElementVersion entity.
• Email — The Email entity.
• EmailAddress — The EmailAddress entity.
• EmailAttachment — The EmailAttachment entity.
• EmptyTrashResult — Result of trash.empty — counts of rows hard-deleted vs. failed.
• Endpoint — The Endpoint entity.
• EndpointAuthPolicy — Auth policy applied to incoming requests. Set on the parent api (default for all its endpoints) and optionally overridden per endpoint. Effective policy = endpoint.auth ?? api.auth.

Spec: docs/endpoints.md §6.

• EndpointHandlerType — The EndpointHandlerType entity.
• Event — The flat audit-log row, as stored in the event table.

Producers (services) emit events via logEvent — those calls are type-narrowed against the EventInput discriminated union in packages/services/src/events.ts, so each variant's data shape is type-checked at the call site. This schema is the consumer shape: what GET /api/events returns. data is delivered as opaque JSON; clients discriminate on type and parse data per the catalogue in docs/events.md.

Subject type isn't stored separately — the subjectId prefix encodes it (agt_… = agent, wsp_… = workspace, …). Use detectEntityType from @aeontel/shared to recover it.

• ExecuteSqlBody — The ExecuteSqlBody entity.
• ExtractGraphBody — Request body for a Graph operation.
• File — File — unified content entity. Every piece of user content (document, image, video, anything) is a file row. Image and video specializations live in side tables and are surfaced via the filtered image/video convenience endpoints.

Multipart upload state is inline on the file row (r2MultipartId, parts, etc.) and null once status = "ready".

• FileStatus — FileStatus — lifecycle state of a file row.

• uploading — multipart upload is in progress, bytes not all written

• ready — upload finalized, bytes in R2, mime sniffed

• error — terminal failure (upload, mime mismatch, R2 error, etc.)

• FileUploadPart — The FileUploadPart entity.

• Function — The Function entity.

• FunctionFile — A single source file belonging to a function version. A function version captures the full file set at the moment it was saved; the run worker materialises these into a Worker Loader bundle on demand and compiles TS/JS sources in-isolate via @cloudflare/worker-bundler.

Files reference only versionId; reach the function via functionVersion.functionId.

• FunctionFileEntry — The FunctionFileEntry entity.
• FunctionVersion — The FunctionVersion entity.
• GrantPermissionBody — Request body for a Permission operation.
• Graph — The Graph entity.
• GraphDefinition — The GraphDefinition entity.
• GraphEdge — The GraphEdge entity.
• GraphEdgeDefinition — The GraphEdgeDefinition entity.
• GraphNode — The GraphNode entity.
• GraphNodeDefinition — The GraphNodeDefinition entity.
• HttpMethod — The HttpMethod entity.
• Image — Image — Cloudflare Images specialization of a file row. Surfaced alongside its file data via the filtered /api/images endpoint. Keyed by its own img_… id, with a unique 1
  FK to the underlying file (fileId).

The url field is derived at read time from the CF Images account hash and the cfImageId, signed with a short-lived JWT if signing is configured.

• InstallIntegrationBody — Request body for an Integration operation.
• InstallMember — The InstallMember entity.
• InstallMembersResponse — Response payload for an InstallMember endpoint.
• Integration — The Integration entity.
• IntegrationInstall — The IntegrationInstall entity.
• IntegrationManifest — The IntegrationManifest entity.
• IntegrationMember — The IntegrationMember entity.
• IntegrationMemberDecl — The IntegrationMemberDecl entity.
• IntegrationMemberPolicy — The IntegrationMemberPolicy entity.
• IntegrationMemberPreview — The IntegrationMemberPreview entity.
• IntegrationMembersResponse — Response payload for an IntegrationMember endpoint.
• IntegrationTrustTier — The IntegrationTrustTier entity.
• IntegrationUpgradeResult — The IntegrationUpgradeResult entity.
• IntegrationVersion — The IntegrationVersion entity.
• IntegrationVisibility — The IntegrationVisibility entity.
• InvokeFunctionBody — Request body for a Function operation.
• InvokeFunctionResponse — Response payload for a Function endpoint.
• KickoffChatBody — Programmatic chat kickoff — open a thread between an agent and a user, optionally seeded with a pre-baked opening message authored by the agent. The recipient discovers the thread via the same event- stream invalidation that backs the chat sidebar.
• KickoffChatResponse — The KickoffChatResponse entity.
• ListCleanupTasksQuery — Query parameters for listing CleanupTask entities.
• ListTablesResponse — The ListTablesResponse entity.
• Log — The Log entity.
• MarkThreadReadBody — Request body for a Thread operation.
• McpServer — The McpServer entity.
• Message — The Message entity.
• MessageContent — A message's content: an ordered array of UIMessage parts.
• MessagePart — AI SDK v6 UIMessage.parts[] element. Loose shape for forward-compat — the runner emits whatever part types it uses; consumers render based on type. Known types: text, reasoning, tool-{name}, dynamic-tool, file, source-url, source-document, data-{name}, step-start. Extended thinking blocks must round-trip verbatim to preserve signatures.
• MissedRunPolicy — The MissedRunPolicy entity.
• MovePageBody — Request body for a Page operation.
• Notification — The Notification entity.
• OAuthApplication — The OAuthApplication entity.
• OAuthApplicationCreated — Returned only at creation time and from the rotate-secret endpoint. clientSecret is shown once; subsequent reads return the application row without it.
• OAuthApplicationType — The OAuthApplicationType entity.
• OAuthScope — The OAuthScope entity.
• Organization — The Organization entity.
• OrganizationMember — The OrganizationMember entity.
• Page — Page — user-authored MDX document that embeds Elements.

Same primitive for docs, runbooks, knowledge base entries (kind "page", tree-structured via parentId), and dashboards (kind "dashboard", flat list on the workspace home). Only kind and surface differ; the data model does not.

body is MDX text. Element tags (<Table …/>, <Chart …/>) resolve to the workspace's Element registry at render time; unknown tags render as inline error cards, not crashes.

• PageKind — Discriminates flat dashboards (workspace home) from tree-structured pages.
• Permission — Permission — universal per-entity ACL grant. Binds (subject, entity, tier).

The caller's effective tier on an entity is the max of:

• global admin bypass
• workspace-member default tier
• direct user grant
• team grants where the caller is a member
• org grants where the caller is a member of the parent org
• public grants (any authenticated user)

Soft-delete semantics: revoke = soft-delete (permission.revoked), restore within retention = permission.restored, hard-delete past retention = permission.purged. Soft-deleted grants are filtered out of every effective-tier query so a revoked grant cannot grant access even momentarily — same precedent as verifyApiKey.

Both entityId and subjectId are polymorphic. The type is encoded in the ID prefix; clients call detectEntityType to label them.

• PublishIntegrationBody — Request body for an Integration operation.
• RefreshSpecResponse — Response payload for a Spec endpoint.
• ResolvePagePathBody — Request body for a Page operation.
• RoleTier — Three-tier permission ladder, applied per (subject, entity).
• Run — The Run entity.
• Schedule — The Schedule entity.
• Schema — The Schema entity.
• Scopes — The Scopes entity.
• Secret — The Secret entity.
• SetAppDomainBody — Request body for an AppDomain operation.
• SignatureAlgo — The SignatureAlgo entity.
• SignFileUploadPartsBody — Request body for a FileUploadPart operation.
• SignFileUploadPartsResponse — Response payload for a FileUploadPart endpoint.
• Skill — The Skill entity.
• SkillResource — The SkillResource entity.
• SkillResourceInput — The SkillResourceInput entity.
• Solution — The Solution entity.
• SolutionEdgeRelation — The SolutionEdgeRelation entity.
• SolutionGraphEdge — The SolutionGraphEdge entity.
• SolutionGraphMember — The SolutionGraphMember entity.
• SolutionGraphResponse — Response payload for a Solution endpoint.
• SolutionMember — The SolutionMember entity.
• Spec — The Spec entity.
• SpecFormat — The SpecFormat entity.
• SpecMember — The SpecMember entity.
• SpecMemberKind — The SpecMemberKind entity.
• SpecVersion — The SpecVersion entity.
• SqlResult — The SqlResult entity.
• StartAppPreviewBody — Request body for an App operation.
• Swarm — The Swarm entity.
• SwarmEdge — The SwarmEdge entity.
• SwarmNode — The SwarmNode entity.
• SwarmVersion — The SwarmVersion entity.
• SyncAgentMcpServersBody — Request body for a McpServer operation.
• SyncAgentSkillsBody — Request body for an Agent operation.
• SyncAgentToolsBody — Request body for an Agent operation.
• SyncWorkflowGraphBody — Request body for a Workflow operation.
• Team — The Team entity.
• TeamMember — The TeamMember entity.
• Thread — The Thread entity.
• ThreadParticipant — A participant in a thread. Exactly one identity field is populated per row (enforced by a CHECK constraint). The populated field determines the participant's kind:
  • userId → Aeontel user
  • agentId → agent
  • swarmId → swarm
  • externalIdentity → external visitor on a deployed app

displayName is required for visitors (they have no other human-readable identity) and optional as a cache for the rest.

• TokenCreated — The TokenCreated entity.
• TokenScopes — The TokenScopes entity.
• ToMarkdownBody — The ToMarkdownBody entity.
• Tool — The Tool entity.
• TrashItem — One soft-deleted row in the cross-entity trash list. id carries the entity's prefixed ID (use detectEntityType(id) if you need the type without reading type). purgeAt is the wall-clock at which the cleanup worker will hard-delete this row, computed server-side from deletedAt + RETENTION_DURATIONS[retentionTier]. Null when the tier is none (compliance hold) or unset.
• Trigger — The Trigger entity.
• UnreadCount — The UnreadCount entity.
• UpdateAgentBody — Request body for updating an Agent.
• UpdateAgentVersionBody — Request body for updating an AgentVersion.
• UpdateApiBody — Request body for updating an Api.
• UpdateApiKeyBody — Request body for updating an ApiKey.
• UpdateAppBody — Request body for updating an App.
• UpdateAppVersionFileBody — Request body for an AppVersion operation.
• UpdateDatabaseBody — Request body for updating a Database.
• UpdateDirectoryBody — Request body for updating a Directory.
• UpdateEdgeDefinitionBody — The UpdateEdgeDefinitionBody entity.
• UpdateElementBody — Request body for updating an Element.
• UpdateElementVersionFileBody — Request body for an ElementVersion operation.
• UpdateEndpointBody — Request body for updating an Endpoint.
• UpdateFileBody — Request body for updating a File.
• UpdateFunctionBody — Request body for updating a Function.
• UpdateFunctionFileBody — Request body for updating a FunctionFile.
• UpdateFunctionVersionBody — Request body for updating a FunctionVersion.
• UpdateGraphDefinitionBody — Request body for updating a GraphDefinition.
• UpdateIntegrationBody — Request body for updating an Integration.
• UpdateMcpServerBody — Request body for updating a McpServer.
• UpdateNodeDefinitionBody — The UpdateNodeDefinitionBody entity.
• UpdateOAuthApplicationBody — Request body for updating an OAuthApplication.
• UpdateOrganizationBody — Request body for updating an Organization.
• UpdateOrganizationMemberRoleBody — Request body for an OrganizationMember operation.
• UpdatePageBody — Request body for updating a Page.
• UpdatePermissionBody — Request body for updating a Permission.
• UpdateScheduleBody — Request body for updating a Schedule.
• UpdateSchemaBody — Request body for updating a Schema.
• UpdateSecretBody — Request body for updating a Secret.
• UpdateSkillBody — Request body for updating a Skill.
• UpdateSolutionBody — Request body for updating a Solution.
• UpdateSpecBody — Request body for updating a Spec.
• UpdateSwarmBody — Request body for updating a Swarm.
• UpdateSwarmVersionBody — Request body for updating a SwarmVersion.
• UpdateTeamBody — Request body for updating a Team.
• UpdateTeamMemberRoleBody — Request body for a TeamMember operation.
• UpdateThreadBody — Request body for updating a Thread.
• UpdateToolBody — Request body for updating a Tool.
• UpdateTriggerBody — Request body for updating a Trigger.
• UpdateUserBody — Request body for updating an User.
• UpdateWebhookEndpointBody — Request body for updating a WebhookEndpoint.
• UpdateWebhookSubscriptionBody — Request body for updating a WebhookSubscription.
• UpdateWorkflowBody — Request body for updating a Workflow.
• UpdateWorkflowEdgeBody — Request body for updating a WorkflowEdge.
• UpdateWorkflowNodeBody — Request body for updating a WorkflowNode.
• UpdateWorkspaceBody — Request body for updating a Workspace.
• UpdateWorkspaceEmailBody — Request body for a Workspace operation.
• UpdateWorkspaceMemberRoleBody — Request body for a WorkspaceMember operation.
• User — The User entity.
• Video — Video — Cloudflare Stream specialization of a file row. Surfaced alongside its file data via the filtered /api/videos endpoint. Keyed by its own vid_… id, with a unique 1
  FK to the underlying file (fileId).

Transcoding is async inside CF. The row starts in processing and lazy-reconciles to ready/error on subsequent GET /api/videos/:id calls (the service hits CF Stream's status API and updates the row).

• VideoTranscodingStatus — The VideoTranscodingStatus entity.
• WebhookAttemptKind — The WebhookAttemptKind entity.
• WebhookCall — The WebhookCall entity.
• WebhookDelivery — The WebhookDelivery entity.
• WebhookDeliveryAttempt — The WebhookDeliveryAttempt entity.
• WebhookDeliveryStatus — The WebhookDeliveryStatus entity.
• WebhookEndpoint — The WebhookEndpoint entity.
• WebhookSignatureStatus — The WebhookSignatureStatus entity.
• WebhookSubscription — The WebhookSubscription entity.
• Workflow — The Workflow entity.
• WorkflowEdge — The WorkflowEdge entity.
• WorkflowNode — The WorkflowNode entity.
• WorkflowNodeCreateType — The set of node types accepted by the API for create/update. Note: this is intentionally narrower than WorkflowNodeTypeSchema from enums.ts (which includes start/end/condition/delay) — the wider set is a pre-existing inconsistency to be cleaned up separately.
• WorkflowRun — The WorkflowRun entity.
• Workspace — The Workspace entity.
• WorkspaceEmailConfig — The WorkspaceEmailConfig entity.
• WorkspaceEmailSettings — The WorkspaceEmailSettings entity.
• WorkspaceMember — The WorkspaceMember entity.
• WriteAppFileBody — Request body for an AppFile operation.