Skip to content

类型

通用

OperationResult

字段类型说明
-{} 或空响应体Endpoint 已成功完成。

TokenResponse

字段类型说明
tokenstring用于后续 API/MCP 请求的 Bearer token。

AvatarUploadResult

字段类型说明
urlstring已上传 avatar 的 URL。
fileNamestring保存后的文件名。
extensionstring文件扩展名。
sizenumber文件大小,单位为字节。

TagsAndLabels

字段类型说明
tagsstring[]用于过滤和分组的短 tags。
labelsRecord<string, string>机器可读 labels。

账户

Me

字段类型说明
idstringId account.
newidstring兼容的 legacy account id 字段。
tier"free" | "advanced" | "pro"当前 account tier。
settingsobjectAccount settings。
meta.nicknamestringAccount 显示名称。
meta.avatarstring?Account avatar URL。
token.identitystring当前 token 绑定的 identity。
workspaceWorkspaceView | null当前选中的 workspace。
membershipsUserMembership[]该 account 参与的 workspaces。
addressbookAddressEntry[]当前 workspace/account 上下文中的 addresses。
subscriptionsRecord<string, number>按 source/project key 聚合的 subscription 计数。
counters.subscriptionsSubscriptionCounter[]聚合后的 subscription 计数。

UserMembership

字段类型说明
idstringId membership/ACL entry.
level"owner" | "admin" | "developer" | "user"在 workspace 中的角色。
workspaceWorkspaceViewShort该 membership 所属的 workspace。

AccountSettings

字段类型说明
-object当前 UI 版本的 settings 对象。字段集合可能会扩展。

CurrentWorkspaceResponse

字段类型说明
workspaceWorkspaceView | null当前选中的 workspace,或 null

工作空间

WorkspaceView

字段类型说明
idstringId workspace.
fullnamestring唯一 workspace name。
invitestring?Invite token。仅当 caller 可以查看 workspace 私有数据时返回。
tagsstring[]Tags。
labelsRecord<string, string>Labels。
meta.titlestring?Workspace 可见标题。
meta.avatarstring?Workspace avatar URL。

WorkspaceViewShort

字段类型说明
idstringId workspace.
fullnamestringWorkspace fullname。
tagsstring[]Tags。
labelsRecord<string, string>Labels。
metaobject?Workspace metadata。

WorkspaceAclEntry

字段类型说明
idstringId ACL entry.
level"owner" | "admin" | "developer" | "user"角色。
userUserViewShort如果该 entry 已关联 account,则为对应 user。
object{ type: string, id: string }?Workspace 引用。可能出现在 raw ACL 响应中。
subject{ type: string, id: string }?User/invite 引用。可能出现在 raw ACL 响应中。

项目

ProjectView

字段类型说明
idstringId project.
createdAtstring?ISO 格式的创建日期。
updatedAtstring?ISO 格式的更新日期。
createdByAccountIdstring?Owner account id。
billingAccountIdstring?Billing owner account id。
namestringWorkspace 内的 project name。
fullnamestringCanonical project fullname。
workspacestringOwner workspace fullname。
publicbooleanLegacy public 标记。
visibility"public" | "private_link" | "personal"?Storage visibility。
accessLevel"private" | "public" | "free"?Product access level。
tagsstring[]Tags。
labelsRecord<string, string>Labels。
meta.titlestring可见标题。
meta.descriptionstring完整描述。
meta.shortDescriptionstring?短描述。
meta.links{ title: string, url: string }[]?有用链接。
meta.iconstring?URL icon.
meta.avatarstring?Avatar URL,通常与 icon 相同。
meta.coverstring?URL cover.
ownerTitlestring?Workspace/account owner 的可见标题。
triggerLimits.maxProvidersPerTriggernumber | null每个 trigger 的 provider weight 限制。字段名为 API 兼容性保留。

ProjectCreateCapability

字段类型说明
tier"free" | "advanced" | "pro"当前 account tier。
canCreateProjectsboolean是否可以创建 project。
privateProjectsUsednumber已有多少 private projects 计入限制。
privateProjectsLimitnumber | nullPrivate projects 限制;null 表示无限制。
canCreatePrivateProjectsboolean是否可以在限制内创建 private project。
字段类型说明
tokenstringAccess link token。
projectstringProject fullname。
maxUsagesnumber?最大使用次数。
usagesnumber?当前使用次数。
expiresAtstring?ISO 格式的过期日期。
createdAtstring?ISO 格式的创建日期。

ProjectImageUploadResult

字段类型说明
urlstring已上传图片的 URL。
fileNamestring保存后的文件名。
extensionstring文件扩展名。
sizenumber文件大小,单位为字节。

项目转移

ProjectTransferPlan

字段类型说明
mode"dry-run"Plan 预览模式。
sourceProjectTransferProjectRef源 project。
targetProjectTransferTargetRef目标 workspace、name 和 fullname。
countsProjectTransferCounts将被转移内容的计数。
changesProjectTransferChanges计划变更的详细列表。
conflictsProjectTransferConflict[]阻塞性冲突。
notesstring[]附加说明。
planHashstring?Plan hash;如果创建 request 的 endpoint 随 plan 返回该值。

ProjectTransferCounts

字段类型说明
triggersnumber要转移的 triggers。
templatesnumber要转移的 template records。
templateGroupsnumberTemplate groups。
templateTopicsnumberTemplate topics。
subscriptionsnumber引用会受影响的 subscriptions。
scopedEntitiesnumber绑定到该 project 的 apps/actions/resources/types/blueprints。
projectAccessLinksnumber要更新的 access links。
aliasWritesnumber要创建或更新的 entity aliases。
aliasMissingnumber要创建的缺失 aliases。
aliasStalenumber要更新的过期 aliases。
conflictsnumber冲突数量。

ProjectTransferRequest

字段类型说明
idstringId request.
sourceProjectIdstring源 project id。
sourceProjectFullnamestring源 project fullname。
sourceWorkspacestring源 workspace fullname。
targetWorkspacestring目标 workspace fullname。
targetNamestring目标 workspace 中的 project name。
targetFullnamestring目标 workspace 中的 project fullname。
status"pending" | "accepted" | "rejected" | "cancelled" | "expired" | "failed"Request status。
requestedByAccountIdstring创建 request 的 account。
sourceOwnerAccountIdstring当前 source owner account。
targetOwnerAccountIdstring目标 owner account。
planHashstring已接受的 plan hash。
planCountsRecord<string, number>Plan counters 快照。
expiresAtstringISO 格式的过期日期。
createdAtstringISO 格式的创建日期。
updatedAtstringISO 格式的更新日期。
decidedAtstring?ISO 格式的决定日期。
decidedByAccountIdstring?接受、拒绝或取消 request 的 account。
appliedAtstring?ISO 格式的应用日期。
rejectedReasonstring?拒绝原因。
failureReasonstring?失败原因。

ProjectTransferAcceptResult

字段类型说明
requestProjectTransferRequest已接受的 request。
transferProjectTransferApplyResult已应用 transfer 的详情。

ProjectTransferApplyResult

字段类型说明
mode"apply"应用模式。
appliedAtstringISO 格式的应用日期。
writes.projectsnumber已更新的 project records。
writes.triggersnumber已更新的 triggers。
writes.triggerProvidersnumber已更新的 trigger providers。
writes.triggerTransformsnumber已更新的 trigger transforms。
writes.templatesnumber已更新的 templates。
writes.subscriptionsnumber已更新的 subscriptions。
writes.scopedEntitiesnumber已更新的 project-scoped entities。
writes.projectAccessLinksnumber已更新的 access links。
writes.aliasesnumber已写入的 aliases。

触发器

TriggerView

字段类型说明
idstringTrigger id。
createdAtstring?ISO 格式的创建日期。
updatedAtstring?ISO 格式的更新日期。
namestringProject 内的 trigger name。
fullnamestringCanonical trigger fullname。
projectIdstring?Id project.
projectstringProject fullname。
workspacestringWorkspace fullname。
publicbooleanLegacy public 标记。
backend{ type: "sdk", trigger: string, values?: object }Backend runtime 引用。
inputsRecord<string, TypeSchema>必填 subscription inputs。
defaultsEventDefaults?推荐的 notification defaults。
outputRecord<string, TypeSchema>?Legacy output schema.
triggerSpecTriggerSpec?Source matching 规范。
filtersSchemaRecord<string, TriggerOutputSchemaField>?可选 subscription filters。
outputSchemaRecord<string, TriggerOutputSchemaField>?Raw/human output schema。
activationTriggerActivation | null?可选 activation condition。
executionPolicyobject?Runtime policy overrides。
statusTriggerStatusDetailsTest/runtime status。
tagsstring[]Tags。
labelsRecord<string, string>Labels。
meta.titlestring可见标题。
meta.descriptionstring?说明.
hasProvidersboolean?如果 providers 存在,则为 true
hasTransformboolean?如果 transform 存在,则为 true

TriggerDraftView

字段类型说明
providersTriggerProvider[]?完整 provider definitions。
transformTriggerTransform?JavaScript raw/human transform。

TriggerStatusDetails

字段类型说明
status"not_tested" | "ready" | "broken"当前 status。
issuestring?人类可读 issue。
source"edit" | "test" | "runtime" | "dependency"?Status source。
updatedAtstring?ISO 格式的更新日期。

TriggerSpec

变体主要字段
evm_logtype, dataSource, 可选 contract, event, abiFragment, topicsCount, dataBytes, testInput.
evm_transactiontype, dataSource, 可选 testInput.
substrate_eventtype, dataSource, 可选 pallet, event, testInput.
timertype, interval, 可选 testInput.

TriggerTransform

字段类型说明
language"javascript"Transform 语言。
sourcestring?Legacy source。
rawSourcestring?转换为 raw output。
humanSourcestring?将 raw output 转换为 human output。

TriggerActivation

字段类型说明
language"javascript"Activation 语言。
sourcestringJavaScript condition 源码。

TriggerValidationResult

字段类型说明
validbooleanDraft 是否有效。
issuesstring[]Validation issues。
triggerTriggerDraftView?如果 endpoint 返回,则为 normalized trigger draft。

TriggerPatchResult

字段类型说明
fullnamestringTrigger fullname.
dryRunboolean?如果仅验证变更,则为 true
updatedbooleanTrigger 是否已更改。
changedPathsstring[]已更改的 dotted paths。
triggerTriggerDraftViewPatch 后的 trigger,或 normalized dry-run view。

TriggerBulkPatchResult

字段类型说明
dryRunboolean?如果 bulk patch 是 dry run,则为 true
totalCountnumber已处理 items 数量。
updatedCountnumber已更改 items 数量。
itemsTriggerBulkPatchItem[]按 trigger 分组的结果。

TriggerBulkPatchItem

字段类型说明
fullnamestringTrigger fullname.
dryRunboolean?如果 item 是 dry run,则为 true
updatedbooleanTrigger 是否已更改。
changedPathsstring[]已更改 paths。
statusstring?Patch 后的 trigger status。
statusUpdatedAtstring?Status 更新日期。
unsetPathsstring[]已删除的 paths。

TriggerBulkRemoveResult

字段类型说明
dryRunboolean?如果 bulk remove 是 dry run,则为 true
totalCountnumber已处理 triggers 数量。
deletedCountnumber已删除 triggers 数量。
itemsTriggerBulkRemoveItem[]按 trigger 分组的结果。

TriggerBulkRemoveItem

字段类型说明
fullnamestringTrigger fullname.
dryRunboolean?如果 item 是 dry run,则为 true
deletedbooleanTrigger 是否已删除。
projectstringProject fullname。
workspacestringWorkspace fullname。

TriggerPreviewResult

字段类型说明
validbooleanPreview 是否成功。
issuesstring[]Issues。
outputunknown?Output preview。
debugRecord<string, unknown>?Debug details.

TriggerTestResult

字段类型说明
validbooleanTest 是否成功。
issuesstring[]Test issues。
inputunknown?Test 使用的 source item。
outputunknown?Raw/human output。
sourceEventsCountnumber?找到的 source items 数量。
debugRecord<string, unknown>?Debug details.

ProviderTestResult

字段类型说明
validbooleanProvider test 是否成功。
issuesstring[]Issues。
resultunknown?Provider output。
debugRecord<string, unknown>?Debug details.

RuntimeSource

字段类型说明
appstringRuntime app name.
networkstringNetwork/source name。
plugin"evm" | "substrate"Runtime plugin 类型。
instancestringRuntime instance.
status"running" | "degraded" | "error"Runtime status。
updatedAtstringISO 格式的更新日期。
latestSeenBlocknumber?Runtime 看到的 last block。
lastProcessedBlocknumber?Last processed block。
blockLagnumber?当前 block lag。
lastFailedBlocknumber?Last failed block。
errorsLastHournumber?过去一小时 errors 数量。

LatestBlockResult

字段类型说明
validbooleanLookup 是否成功。
issuesstring[]Lookup issues。
latestBlocknumber?找到的 latest block。
matchedboolean是否找到匹配的 source item。
matchedBlocknumber?找到 match 的 block。
checkedBlocksnumber已检查 blocks 数量。
sourceEventsCountnumber?Source event count。
itemIndexnumber?找到的 item index。
inputunknown?找到的 input。
sourcestring?Lookup source。
detailsunknown?附加详情。

触发器导入

EvmAbiImportResult

字段类型说明
eventsunknown[]?已解析 ABI event entries。
callsunknown[]?已解析 ABI call/function entries。
itemsunknown[]?如果 runtime 返回扁平列表,则为解析 entries 的统一列表。
errorstring?如果 runtime 无法解析 ABI,则为错误消息。

EvmAbiResult

字段类型说明
abiunknown[]?如果 ABI 已加载,则为 ABI JSON entries。
sourcestring?ABI source marker。
contractstring?Contract address。
errorstring?如果 ABI 无法加载,则为错误消息。

TriggerImportDraftsResult

字段类型说明
abiSource"provided" | "auto"?EVM import 使用的 ABI source。
draftsTriggerDraftView[]生成的 trigger drafts。

SubstrateSourceInfo

字段类型说明
ss58PrefixnumberSubstrate source 的 SS58 prefix。

SubstratePalletSummary

字段类型说明
namestringPallet name。
docsstring[]Pallet 文档。
hasEventsbooleanPallet 是否有 events。
hasCallsbooleanPallet 是否有 calls。
eventCountnumberEvents 数量。
callCountnumberCalls 数量。

模板

ProjectTemplate

字段类型说明
idstringId template.
projectstringProject fullname。
schemaRecord<string, TypeSchema>Template-level input schema。
groupsTemplateGroup[]向用户显示为 templates 的 groups。
topicsTemplateTopic[]Groups 内的 topics。
rulesTemplateRule[]Topics 的 trigger rules。
metaRecord<string, unknown>Template metadata.
issuestring?Template 同步问题。

TemplateGroup

字段类型说明
namestringGroup id。
meta.titlestring可见标题。
meta.descriptionstring说明.

TemplateTopic

字段类型说明
namestringId topic.
groupstringParent group id。
selectedByDefaultbooleanTopic 是否在 subscription wizard 中默认选中。
meta.titlestring可见标题。

TemplateRule

字段类型说明
idstringRule id。
triggerstringTrigger fullname.
topicstringTopic name。
inputsobject?Rule 的 input mapping/defaults。
policyobject?Execution policy。
conditionsCondition | null?Condition rule。
deprecatedbooleanRule 是否标记为 deprecated。
requiredValuesstring[]必填 template values。
issuestring?Missing trigger or sync issue.

订阅

SubscriptionView

字段类型说明
idstringId subscription.
targetWorkspaceFullnamestring?拥有 subscription 的 workspace。
createdByAccountIdstring?创建 subscription 的 account。
sourceProjectIdstring?源 project id。
sourceProjectFullnamestring?源 project fullname。
countsTowardsTierQuotaboolean?Subscription 是否计入 Free tier quota。
state"on" | "off" | "blocked"Subscription state。
createdAtstringISO 格式的创建日期。
updatedAtstringISO 格式的更新日期。
templateSubscriptionTemplateReference | nullTemplate reference;direct trigger subscription 时为 null
rulesSubscriptionRule[]Trigger rules。
resourcesstring[]Actions 使用的 resource fullnames。
actionsSubscriptionAction[]?Notification actions。
referencesSubscriptionReferences到 source/project/trigger 的 denormalized references。
meta.titlestring?可见标题。
meta.issuestring?Block/entitlement/migration 问题。

SubscriptionTemplateReference

字段类型说明
idstringId template.
inputsRecord<string, string | number>Template input values。
groups{ name: string, meta: { title: string } }[]已选择的 groups。
topicsstring[]已选择的 topics。
rules{ id: string, group: string }[]已选择的 rule references。

SubscriptionRule

字段类型说明
triggerIdstring?Trigger id。
triggerRuleTriggerReferenceTrigger reference。
inputsobject?Input values。
policyobject?Execution policy。
conditionsCondition | null?Condition rule。

SubscriptionAction

字段类型说明
actionstringAction fullname.
valuesRecord<string, unknown>Action values。
overridesEventDefaults?Notification override 字段。

SubscriptionReferences

字段类型说明
sourcesstring[]References to data sources.
projectsstring[]Project fullnames。
triggersstring[]Trigger fullnames。
projectIdsstring[]?Project ids。
triggerIdsstring[]?Trigger ids。

SubscriptionTestResult

字段类型说明
validbooleanTest 是否有效。
issuesstring[]Test issues。
previewunknown?Notification preview/send 结果。
subscriptionSubscriptionView?Test 使用的 draft subscription。

SubscriptionAlertLog

字段类型说明
idstringLog id。
subscriptionIdstringId subscription.
workspaceIdstringId workspace.
projectFullnamestring?Project fullname。
triggerFullnamestring?Trigger fullname.
eventNamestringEvent/trigger name。
createdAtstringISO 格式的创建日期。
status"delivered" | "failed" | "rate_limited" | "blocked"Delivery status。
testInputRecord<string, unknown>?Test input.
itemIndexnumber?Source item index。
replayMatch{ hash?: string | null, index?: number | null }?Replay match 信息。
sourceItemsCountnumber?Source items 数量。
channelsSubscriptionAlertLogChannel[]Delivery channels。
failureReasonCodestring?Error code。
failureReasonMessagestring?错误消息。
expireAtstringLog 过期日期。

资源

ResourceView

字段类型说明
idstringId resource.
namestringResource name.
fullnamestringResource fullname.
projectstring?Project fullname。
workspacestringWorkspace fullname。
publicbooleanPublic 标记。
blueprintstringBlueprint fullname.
tokenstring?Secret token。仅当 caller 可以查看 resource 私有字段时返回。
readybooleanResource 是否 ready。
remarkstring | nullResource status 备注。
dataobject | null?Resource setup data。
tagsstring[]Tags。
labelsRecord<string, string>Labels。
meta.titlestring?可见标题。

ExternalResourceView

字段类型说明
blocks{ type: "markdown", text: string }[]External app 返回的 UI content blocks。

数据源

CustomSourceListView

字段类型说明
workspacestringOwner workspace fullname。
namestringSource name.
fullnamestringSource fullname。
publicbooleanPublic 标记。
kind"evm" | "substrate"Source type。
metaCustomSourceMetaMetadata。
createdAtstringISO 格式的创建日期。
updatedAtstringISO 格式的更新日期。
deployerTitlestring?Deployer/owner 可见标题。

CustomSource

字段类型说明
createdByAccountIdstring?Creator account id.
endpointsstring[]Runtime RPC endpoints。
substrateobject?Substrate extensions/types/RPC config。
batchMaxCountnumber?最大 EVM batch size。
blockProcessingConcurrencynumber?Block processing concurrency。
maxQueuedBlocksnumber?最大 queued blocks。
logs{ retentionMs: number, maxCount: number | null }?Policy log runtime.
runtimeCustomSourceRuntimeMetadata?Runtime metadata。

CustomSourceMeta

字段类型说明
titlestring可见标题。
descriptionstring?说明.
icons.defaultstring?Default icon URL.
ogobject?OpenGraph metadata。

CustomSourceRuntimeMetadata

字段类型说明
evm.chainIdnumber?EVM chain id。
evm.latestBlocknumber?Latest EVM block.
evm.blockHashstring?Block hash。
evm.fetchedAtstringMetadata fetch date.
substrate.ss58Prefixnumber?SS58 prefix.
substrate.latestBlocknumber?Latest Substrate block.
substrate.fetchedAtstringMetadata fetch date.

CustomSourceCreateCapability

字段类型说明
tier"free" | "advanced" | "pro"Account tier.
canCreateCustomSourcesboolean当前 account 是否可以创建 custom sources。
customSourcesUsednumber当前 private custom sources 数量。
customSourcesLimitnumber | null限制;null 表示无限制。

CustomSourceVerifyResult

字段类型说明
okbooleanVerification 是否成功。
logs{ level: "info" | "error", message: string }[]Verification log messages。
detailsRecord<string, unknown>?Runtime/public duplicate check 详情。
errorstring?Verification error。

CustomSourceLogsResult

字段类型说明
existsbooleanLog file 是否存在。
linesstring[]已编辑 log lines。
truncatedbooleanOutput 是否被截断。
updatedAtstring?Log file 更新日期。

CustomSourceRuntimeActionResult

字段类型说明
oktrueRuntime action 是否成功。
sourceFullnamestringSource fullname。
revisionnumberRestart/reset 后的 runtime revision。

CustomSourceResetLagResult

字段类型说明
oktrueReset 是否成功。
latestBlocknumber作为新 lag baseline 使用的 last block。

CustomSourceStatusTestResult

字段类型说明
oktrueTest event 已发送。
eventNamestring生成的 status trigger name。
subscriptionsTestednumber已测试的 subscriptions。
matchednumberMatched subscriptions 数量。
deliverednumber已送达 alerts。
eventCustomSourceStatusEventTest status event。

CustomSourceStatusEvent

字段类型说明
type"status_changed" | "error" | "recovered"Event type。
sourceFullnamestringSource fullname。
sourceNamestringSource name.
sourceTitlestring可见标题。
workspacestringWorkspace fullname。
kind"evm" | "substrate"Source type。
status"running" | "error" | "degraded"新 status。
previousStatus"running" | "error" | "degraded"?上一 status。
severity"info" | "warning" | "error"Severity。
messagestring人类可读消息。
codestring?机器可读 code。
detailsRecord<string, unknown>?附加详情。
timestampstringISO 格式的 event time。

地址

AddressEntry

字段类型说明
idstringId address entry.
type"plain" | "ss58" | "evm" | "bitcoin" | "cosmos"类型 address.
addressstringAddress value。
aliasstring可见 alias。

Builder Registry

AppView

字段类型说明
idstringId app.
namestringApp name.
fullnamestringApp fullname.
projectstringProject fullname。
workspacestringWorkspace fullname。
publicbooleanPublic 标记。
urlstring?App URL。仅当 caller 可以查看私有字段时返回。
tagsstring[]Tags。
labelsRecord<string, string>Labels。

ActionView

字段类型说明
idstringId action.
namestringAction name.
fullnamestringAction fullname.
projectstringProject fullname。
workspacestringWorkspace fullname。
publicbooleanPublic 标记。
backend{ type: "sdk", action: string }Action backend。
valuesRecord<string, TypeSchema>Action values schema。
overridesArray<keyof EventDefaults>Action 可覆盖的 notification fields。
tagsstring[]Tags。
labelsRecord<string, string>Labels。
meta.titlestring可见标题。
meta.descriptionstring?说明.

BlueprintView

字段类型说明
idstringId blueprint.
namestringBlueprint name.
fullnamestringBlueprint fullname.
appstringApp fullname.
projectstringProject fullname。
workspacestringWorkspace fullname。
publicbooleanPublic 标记。
typestringBlueprint type。
dataobject?Blueprint object spec。
tagsstring[]Tags。
labelsRecord<string, string>Labels。
meta.titlestring?可见标题。
meta.descriptionstring?说明.

SharedTypeView

字段类型说明
idstringId shared type.
namestringShared type name。
fullnamestringShared type fullname.
projectstringProject fullname。
workspacestringWorkspace fullname。
publicbooleanPublic 标记。
schemasRecord<string, TypeSchema>命名 schemas。
tagsstring[]Tags。
labelsRecord<string, string>Labels。
meta.titlestring?可见标题。
meta.descriptionstring?说明.

支持类型

EventDefaults

字段类型说明
titlestring?Notification title template。
shortstring?Short markdown text template。
longstring?Long markdown text template。
iconstring | null?Icon URL template。
coverstring | null?Cover URL template。
avatarstring | null?Avatar URL template。
links{ title: string, url: string }[]?Notification links。