Keble API 与 MCP
通过 MCP 或 HTTPS 把你自己的 AI Agent 或代码接入 Keble:搜索市场数据、读取已连接的店铺、生成报告、管理待办,只需一把 API 密钥。
38 个接口 · 37 个 MCP 工具 · OpenAPI (JSON)
认证与 MCP
把占位符换成你在密钥页创建的密钥。 登录后创建密钥
每次调用都在 Authorization 请求头里带上你的 API 密钥。同一把密钥可用于 MCP 和 HTTPS。
Authorization: Bearer PASTE_YOUR_KEY_HERE/api/v3/mcp/api/v3调用方式说明
HTTPS:接口为 POST <REST 地址>/gateway/<工具名>,请求体为 JSON;下载类接口为 GET,参数放在查询字符串里。通过 MCP 调用时,用 tools/call 传入工具名,并把同一份请求体放在 "request" 里。
- API 密钥
- 让你的 AI Agent 或代码代表你的账户操作,可随时在密钥页撤销。
- MCP
- AI 工具调用 Keble 这类服务的开放协议。
- 接口
- 一个可调用的操作;它的名称既是 REST 路径的最后一段,也是 MCP 工具名。
API 参考
38API 密钥可调用的全部接口。每个接口都是一个 REST 路由(除下载表格外均为 POST);标注了 MCP 的,同时是同名的 MCP 工具,两者参数是同一份 JSON。字段说明为英文。
数据
搜索数据MCP 工具 · dp_search
/api/v3/gateway/dp_search回答一个市场问题,或对商品、内容、达人、关键词和趋势做结构化搜索。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 内容数据 ¥0.0140/行 · 计 1 次请求达人数据 ¥0.0140/行 · 计 1 次请求关键词数据 ¥0.0140/行 · 计 1 次请求
请求体 · SearchRequest
One question or structured search with an optional per-call row ceiling.
maxRows可选integer | null | Optional row ceiling for this call; the smaller of this and the normal page size is returned. Omission preserves the normal page size. |
answerLanguage可选AnswerLanguage | Language of seller-facing clarifications and refusals. |
question可选string | null | The natural-language question to answer. |
search可选Search | null | The typed structured search to execute. |
hints可选RouteHints | null | Optional predicates pinned into the stored plan. |
clarification可选ClarificationAnswer | null | The stored clarification choice being resumed. |
fields可选string[] | null | Authorized display-field whitelist; null means all authorized fields. |
返回 · CustomerDpSearchResponse
Expose the full discriminated DP search answer without copying DP fields.
curl -X POST \
"/api/v3/gateway/dp_search" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"question":"best running shoes"}'搜索下一页MCP 工具 · dp_continue
/api/v3/gateway/dp_continue用上一页返回的游标获取搜索的下一页。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 内容数据 ¥0.0140/行 · 计 1 次请求
请求体 · ContinueRequest
A signed continuation request with an optional per-call row ceiling.
cursor必填string | Opaque signed continuation token. |
maxRows可选integer | null | Optional row ceiling for this call; the next cursor follows the last returned row. Omission preserves the normal page size. |
返回 · CustomerDpContinueResponse
Expose one discriminated DP continuation answer.
curl -X POST \
"/api/v3/gateway/dp_continue" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"cursor":"example.continuation.token"}'可查数据MCP 工具 · dp_catalog
/api/v3/gateway/dp_catalog列出现在能搜索的平台和数据类型。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · DpCatalogRequest
The dp_catalog request: the caller only chooses whether DP's per-channel pairs are included.
includePairs可选boolean | Also list each channel's start-to-result pairs (planner-admitted walks, with analyzed and live modes); off by default because the list is large. |
返回 · CustomerDpCatalogResponse
Expose the DP catalog or its typed refusal as one customer root schema.
curl -X POST \
"/api/v3/gateway/dp_catalog" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{}'数据新鲜度MCP 工具 · dp_freshness
/api/v3/gateway/dp_freshness每类可搜索数据有多新。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
返回 · CustomerDpFreshnessResponse
Expose the DP freshness projection or its typed refusal.
curl -X POST \
"/api/v3/gateway/dp_freshness" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{}'记录详情MCP 工具 · dp_record
/api/v3/gateway/dp_record一条搜索结果的全部字段,以及它关联的内容。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 内容数据 ¥0.0140/行 · 计 1 次请求达人数据 ¥0.0140/行 · 计 1 次请求
请求体 · RecordAddress
The ONE public record address: one analyzed record's kind and key.
kind必填AnalyzedRecordKind | |
recordKey必填string | |
seriesWindow可选DateWindow | null | Inclusive date window for an opt-in record-level metric series; null requests no series. |
返回 · CustomerDpRecordResponse
Expose one DP record detail or its typed refusal.
curl -X POST \
"/api/v3/gateway/dp_record" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"kind":"NODE","recordKey":"CONTENT:public:example"}'趋势元素MCP 工具 · dp_motifs
/api/v3/gateway/dp_motifs某个分区里正在扩散或刚开始流行的元素。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · MotifQuery
One named motif section and window with an optional row ceiling.
days可选integer | null | Length in days of the current window; null when start/end state the span. |
start可选string | null | Inclusive first day of an explicit span. |
end可选string | null | Inclusive last day of the current window; null uses the newest member publication day in scope. |
section必填MotifSection | |
terms可选string[] | Word-match terms tested against each member's label or instance, or the member content's searchable fields; at most eight. |
maxRows可选integer | null | Optional row ceiling for this motif page; the smaller of this and the normal page size is returned. Omission preserves the normal page size. |
返回 · CustomerDpMotifsResponse
Expose one DP motif page, its pending variant or a typed refusal.
curl -X POST \
"/api/v3/gateway/dp_motifs" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"section":"SPREADING"}'店铺连接
可连接来源MCP 工具 · elta_catalog
/api/v3/gateway/elta_catalog可以连接的店铺和数据来源。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
返回 · PluginDeclarationCatalog
Every installed plugin's declaration plus the shared vocabulary.
object可选string | Document type: catalog. |
declarations必填PluginDeclaration[] | Declarations of every installed plugin. |
levels可选EntityLevel[] | Every level a value may carry, with its title and parent. |
refusals可选WriteRefusal[] | Every refusal an action row may carry, with its title and meaning. |
curl -X POST \
"/api/v3/gateway/elta_catalog" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{}'我的店铺MCP 工具 · elta_stores
/api/v3/gateway/elta_stores已连接的店铺、它们的连接方式和同步状态。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
返回 · StoresResponse
The stores belonging to the asserted owner, including unfinished stores.
object可选string | Document type: stores response. |
stores必填StoreRecord[] | Stores belonging to the asserted owner. |
curl -X POST \
"/api/v3/gateway/elta_stores" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{}'店铺可用能力MCP 工具 · elta_store_capabilities
/api/v3/gateway/elta_store_capabilities一个店铺现在能做什么:哪些实时查询、修改和数据可用,以及其余项因何不可用。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
返回 · StoreCapabilities
What the installed sources can do right now for one store: live reads, writes and captures.
object可选string | Document type: store capabilities. |
storeId必填string | Store whose current abilities this document describes. |
lookups必填CapabilityRow[] | Installed live reads: one row per (key, account). |
actions必填CapabilityRow[] | Installed provider writes: one row per (key, account). |
datasets必填CapabilityRow[] | Installed captured datasets: one row per (key, account). |
curl -X POST \
"/api/v3/gateway/elta_store_capabilities" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"storeId":"store_1"}'店铺指标MCP 工具 · elta_metrics
/api/v3/gateway/elta_metrics已连接店铺的已存指标。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · MetricsRequest
A serving read of one or more metrics over a date range, current values only.
metricKeys必填string[] | Metrics to read; at least one. |
level必填string | The entity level key the caller wants values at. |
days必填DayRange | Inclusive reporting days in the account's timezone. |
storeIds可选string[] | Stores to include; empty selects the asserted owner's stores. |
accountIds可选string[] | Accounts to read; empty means every account of the owner. |
entities可选string[] | Stored entity keys to read; empty means every entity. |
page可选PageRequest | Row limit and cursor for this read. |
返回 · MetricPage
One bounded page of combined range values: the /v2/metrics/query response.
rows必填MetricRangeValue[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
object可选string | Fixed tag marking this object as a metric page. |
curl -X POST \
"/api/v3/gateway/elta_metrics" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"metricKeys":["acos"],"level":"CAMPAIGN","days":{"startsOn":"2026-09-01","endsOn":"2026-09-02"}}'店铺数据MCP 工具 · elta_facts
/api/v3/gateway/elta_facts已连接店铺的已存数据,例如广告活动和出价。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · FactsRequest
A serving read of stored facts for one owner: family, days, selection and pin.
familyKey必填string | The fact family to read. |
days必填DayRange | Inclusive reporting days in the account's timezone. |
storeIds可选string[] | Stores to include; empty selects the asserted owner's stores. |
accountIds可选string[] | Accounts to read; empty means every account of the owner. |
entities可选string[] | Stored entity keys to read; empty means every entity. |
attributes可选AttributeMatch[] | View selections that restrict which rows are returned. |
asOf可选string | null | Instant to read as of; set this or capture_id, never both. |
captureId可选string | null | Committed capture to read as of; set this or as_of, never both. |
page可选PageRequest | Row limit and cursor for this read. |
返回 · FactPage
One bounded page of fact rows plus the coverage of every requested day.
rows必填FactRow[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
object可选string | Fixed tag marking this object as a fact page. |
coverage必填DayCoverage[] | Coverage of every requested account, family and day. |
readAsOf必填string | The single instant all rows were read at. |
blocked可选BlockedLane[] | Blocked lanes with their reason and fix. |
curl -X POST \
"/api/v3/gateway/elta_facts" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"familyKey":"amazon.ads.sp_campaign_daily","days":{"startsOn":"2026-09-01","endsOn":"2026-09-02"}}'数据历史MCP 工具 · elta_fact_history
/api/v3/gateway/elta_fact_history一条已存数据随时间的变化。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · FactsRequest
A serving read of stored facts for one owner: family, days, selection and pin.
familyKey必填string | The fact family to read. |
days必填DayRange | Inclusive reporting days in the account's timezone. |
storeIds可选string[] | Stores to include; empty selects the asserted owner's stores. |
accountIds可选string[] | Accounts to read; empty means every account of the owner. |
entities可选string[] | Stored entity keys to read; empty means every entity. |
attributes可选AttributeMatch[] | View selections that restrict which rows are returned. |
asOf可选string | null | Instant to read as of; set this or capture_id, never both. |
captureId可选string | null | Committed capture to read as of; set this or as_of, never both. |
page可选PageRequest | Row limit and cursor for this read. |
返回 · FactHistoryResponse
One bounded page of every stored version, superseded ones included.
rows必填FactVersion[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
object可选string | Fixed tag marking this object as a fact history page. |
curl -X POST \
"/api/v3/gateway/elta_fact_history" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"familyKey":"amazon.ads.sp_campaign_daily","days":{"startsOn":"2026-09-01","endsOn":"2026-09-02"}}'店铺变化MCP 工具 · elta_changes
/api/v3/gateway/elta_changes店铺已存数据的近期变化。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ChangesRequest
A serving read of derived fact changes for one owner: the fact read's own selection.
familyKey必填string | The fact family to read. |
days必填DayRange | Inclusive reporting days in the account's timezone. |
storeIds可选string[] | Stores to include; empty selects the asserted owner's stores. |
accountIds可选string[] | Accounts to read; empty means every account of the owner. |
entities可选string[] | Stored entity keys to read; empty means every entity. |
attributes可选AttributeMatch[] | View selections that restrict which rows are returned. |
asOf可选string | null | Instant to read as of; set this or capture_id, never both. |
captureId可选string | null | Committed capture to read as of; set this or as_of, never both. |
page可选PageRequest | Row limit and cursor for this read. |
返回 · FactChangePage
One bounded page of derived fact changes; total_rows counts every change matched.
rows必填FactChange[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
curl -X POST \
"/api/v3/gateway/elta_changes" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"familyKey":"amazon.ads.sp_campaign_daily","days":{"startsOn":"2026-09-01","endsOn":"2026-09-02"}}'实时查询店铺MCP 工具 · elta_lookup
/api/v3/gateway/elta_lookup直接从店铺读取当前数据。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · LookupRequest
One live read pinned to an owner-visible store and optional stored account.
storeId必填string | Owner-visible store to read. |
lookupKey必填string | The declared lookup to run. |
accountId可选string | null | Stored account to read; required when the source has several. |
query必填JsonValue | The lookup's own query payload. |
page可选PageRequest | Row limit and cursor for this read. |
返回 · LookupPage
One bounded page of live results; next_cursor is the provider's page token.
object可选string | Fixed tag marking this object as a lookup page. |
rows必填JsonValue[] | The result rows in the lookup's own shape. |
nextCursor可选string | null | Cursor continuing to the next page; none on the last page. |
curl -X POST \
"/api/v3/gateway/elta_lookup" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"storeId":"store_1","lookupKey":"google.gmail.search","accountId":"acct_1","query":{"q":"from:acme"}}'查询店铺数据MCP 工具 · elta_query
/api/v3/gateway/elta_query筛选并汇总店铺的已存数据。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · QueryRequest
Select a logical target and optionally narrow the authenticated owner's stores/accounts.
target必填QueryTarget | Catalog fact family to read, or METRIC_DAYS for calculated daily values. |
storeIds可选string[] | Stores to include; empty selects the asserted owner's stores. |
accountIds可选string[] | Accounts to include within those stores; empty selects all their accounts. |
pipeline必填QueryStage[] | Read-only aggregation stages over the selected logical rows. |
page可选PageRequest | Page size and continuation cursor for this exact read. |
返回 · QueryPage
One bounded aggregation result page, reusing the shared cursor/total contract.
rows必填QueryRow[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
object可选string | Document type: aggregation query page. |
curl -X POST \
"/api/v3/gateway/elta_query" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"target":"METRIC_DAYS","pipeline":[{"$limit":10}]}'预览还原MCP 工具 · elta_preview_revert
/api/v3/gateway/elta_preview_revert检查已记录的店铺修改能否还原,不会提交任何提议。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · RevertRequest
Ask the service to construct the undo of one proposal; callers choose rows, never undo values.
proposalId必填string | Proposal to revert. |
actionKeys可选string[] | Optional rows to revert; empty means every revertible row. |
replayKey可选string | null | Caller-owned idempotency key. |
attribution可选ProposalAttribution | null | Origin and reason of this undo; excluded from its hash. |
返回 · PreviewView
Stateless answer to a preview request, with outcomes and diffs aligned to its batch.
batch必填ActionBatch | Requested action batch; nothing is persisted by preview. |
previews必填ActionOutcome[] | One live outcome per action, in order. |
diffs必填ActionDiff[] | One derived diff per action, in order. |
curl -X POST \
"/api/v3/gateway/elta_preview_revert" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"proposalId":"proposal_1"}'报告
创建报告MCP 工具 · artifect_create
/api/v3/gateway/artifect_create开始一份定位分析或亚马逊产品报告;同一个幂等键重复提交返回第一次的任务。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 亚马逊产品报告 ¥0.7000/次 · 计 5 次请求产品定位 ¥0.7000/次 · 计 5 次请求广告优化建议 ¥0.7000/次 · 计 5 次请求产品图片 ¥0.7000/次
请求体 · ArtifectReportCreate | ArtifectPositioningCreate | ArtifectAdsAdviceCreate | ArtifectProductImagesCreate | ArtifectShopifyThemeCreate | ArtifectChangeListCreate | ArtifectShopifyBlogPostsCreate | ArtifectShopifyProductCreate | ArtifectAmzListingCreate | ArtifectFbaInboundPlanCreate | ArtifectMonitorCreate
Carry the complete V3 report premise accepted by the runtime.
kind可选string | |
replayKey必填string | |
asin必填string | |
amazonMarketplace必填AmazonMarketplace | |
keywords可选string[] | Discovery keywords; suggest keywords, the seller confirms; at least one nonblank keyword with categoryId skips REPORT_SCOPE; otherwise the run parks on REPORT_SCOPE to ask. |
categoryId可选integer | null | Confirmed Amazon category; with at least one nonblank keyword it skips REPORT_SCOPE. |
title可选string | null | |
image可选string | null | |
language可选Language | null | |
similarProductsLimit可选integer | null | How many comparable products to analyse; None keeps the runtime's website-aligned default. |
economicSetup可选ReportProfileEconomicFields | null | The seller's economic setup in the report package's own field names (ACOS band, fixed size/weight, entry-budget threshold). Its suggestedPurchasingCost is refused when purchaseCost is sent, so the seller's cost has ONE create source; a later PROFILE_INPUTS edit changes the benchmark, never a PROFIT_INPUTS override of the analysed product. |
purchaseCost必填ArtifectReportUserPurchaseCost | ArtifectReportSystemEstimatedPurchaseCost | Required seller-confirmed cost: show Keble's estimate as a suggestion, confirm the cost (single or range) with the seller before creating; later changes to the seller's own cost go through PROFILE_INPUTS and re-price every product; competitors' costs can be changed one by one or as a set through PROFIT_INPUTS. |
Carry the source-agnostic premise for one positioning study.
kind可选string | |
replayKey必填string | |
positioningContext必填string | |
pluginId可选string | null | Installed plugin ID; omit for the host default. Setup must match this plugin's declaration. |
setup可选object | null | Values for the selected plugin's declared setup fields; omitted fields are proposed at SCOPE. |
language可选Language | null |
Start one on-demand Ads optimization-suggestions run for one store.
kind可选string | |
replayKey必填string | |
storeId必填string | |
anchorDay可选string | null | Requested data day; null means yesterday in UTC; a later day is refused before any source is read. |
language可选Language | null |
Create one product-image set from photos already uploaded through the image artifect.
kind可选string | |
request必填CreateImageSet |
Create one Shopify theme document workspace from the theme contract's document request.
kind可选string | |
request必填ThemeDocumentCreateRequest | Start one theme workspace on a connected store: pages are edited as Keble sections and settings, previewed on an unpublished copy of the theme and then published; the theme's own files are never edited. Use this kind, not raw elta_propose shopify.admin.theme_file writes, to add or change sections on a store page. Omit targetThemeId to target the live theme; a targetThemeId the store does not have is refused with the store's themes (name, role, id). Previewing and publishing need theme edits turned on for the store ("Edit themes" under Connectors › store › Allow Keble to change; elta_store_capabilities shows it as shopify.admin.themes): check it before drafting and ask the person to turn it on if it is off. Cancel does not close or discard a workspace: it stays open and nothing is published; DISCARD_PREVIEW removes the preview copy. A stale base revision is REVISION_CONFLICT; other refusals carry kindCode: RUN_NOT_FOUND (No such theme run for this account; list the runs to find it.); WRONG_RUN_KIND (Use the commands of this run's kind; read its snapshot first.); STORE_NOT_FOUND (Connect the store first, then create the run.); TARGET_NOT_IN_STORE (Pick one of the store's themes as the target.); REPLAY_KEY_REUSED (Use a new replay key for a different create request.); UNKNOWN_REVISION (Name a revision this run has.); UNKNOWN_PAGE (Add the page for that template first.); UNKNOWN_SECTION (Use a section key from the snapshot.); UNKNOWN_BLOCK (Use a block key of that section from the snapshot.); UNKNOWN_SECTION_KIND (Use one of the library's section kinds.); UNKNOWN_SETTING (Use a setting declared for that section or block kind.); SETTING_OUT_OF_BOUNDS (Keep the value within the setting's type and bounds.); DUPLICATE_KEY (Choose a template, section key or block key not used yet.); BLOCK_NOT_ALLOWED (That section kind takes no blocks of this kind.); TOO_MANY_BLOCKS (Remove a block before adding another.); ANCHOR_NOT_FOUND (Place the section after an entry the page still has.); TEMPLATE_NOT_PLACEABLE (Place sections only on the theme's existing page templates.); THEME_LIBRARY_FULL (The store already holds 20 themes, Shopify's maximum; delete an unused theme in Shopify Admin.); THEME_PROCESSING (Shopify is still creating the preview copy; update the preview again shortly.); PREVIEW_COPY_UNKNOWN (The preview copy may exist; find it in Shopify Admin by its name and remove it.); NO_PREVIEW_COPY (There is no preview copy yet; UPDATE_PREVIEW makes one.); PREVIEW_NOT_READY (Update the preview and wait until the copy shows this revision.); PROPOSAL_PENDING (A request for this step is still applying; retry shortly.); BASE_CHANGED (The theme changed since it was read; publish again to re-merge.); NOTHING_TO_PROPOSE (The theme already shows this version; there is nothing to change.); PREVIEW_REJECTED (A write was refused before filing, so nothing was filed; resolve its reason (FAMILY_OFF: turn on theme edits for the store), then repeat the step.) |
Carry one account-free change-list create premise to its configured host.
kind必填string | |
request必填ChangeListCreatePremise |
Create one guided Shopify blog post set from the kind's own BlogCreate.
kind可选string | |
request必填BlogCreate |
Create one unpublished Shopify product draft from the kind's ProductCreateRequest.
kind可选string | |
request必填ProductCreateRequest |
Create one owner-fenced new Amazon listing draft from the kind's own ListingCreate.
kind可选string | |
request必填ListingCreate |
Create one Amazon FBA inbound plan artifect and file its plan proposal.
kind可选string | |
replayKey必填string | |
storeId必填string | |
accountId可选string | null | |
change必填object | ELTA action `amazon.seller.create_fba_inbound_plan`'s change, passed through unchanged except for one default. Required: `source_address` (the private ship-from address, its `phone_number` included) and `items` (at least one row, each with `msku`, `quantity` > 0, `prep_owner` and `label_owner`). A row that omits `prep_owner` is filed with `SELLER`: Amazon refuses `NONE` for an item that needs prep, and Amazon US ended its own prep service on 2026-01-01, so `SELLER` is the safe choice there and `AMAZON` is never accepted for prep in the US. `name` is the plan's optional name. Full schema: elta_catalog actions[key=amazon.seller.create_fba_inbound_plan].changeSchema. |
Create one MONITOR draft (a standing artifect), parked on its setup input.
kind可选string | |
replayKey必填string | |
title必填string |
返回 · CustomerArtifectCreateResponse
Expose an Artifect reference or sanitized Artifect failure.
curl -X POST \
"/api/v3/gateway/artifect_create" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"kind":"AMZ_PRODUCT_REPORT","replayKey":"example-replay-1","asin":"B0EXAMPLE1","amazonMarketplace":"US","purchaseCost":{"source":"SYSTEM_ESTIMATED","sellerAgreed":true}}'回答报告MCP 工具 · artifect_answer
/api/v3/gateway/artifect_answer回答报告的待答问题,让它继续。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ArtifectAnswerRequest
Which run, and the typed decision fragment (own input key, revision and replay_key).
ref必填ArtifectRef | |
answer必填ArtifectAnswer |
返回 · CustomerArtifectDecisionResponse
Expose an Artifect decision status, rejection or sanitized failure.
curl -X POST \
"/api/v3/gateway/artifect_answer" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"ref":{"id":"artifect_1"},"answer":{"inputKey":"REPORT_SCOPE:a1b2c3d4","expectedRevision":0,"replayKey":"example-answer-1","decision":{"decisionType":"REPORT_SCOPE","categoryId":1,"keywords":["running shoes"]}}}'调整报告MCP 工具 · artifect_adjust
/api/v3/gateway/artifect_adjust修改报告里已完成的一个决策。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ArtifectAdjustRequest
Which run and typed adjustment; removed arms retain ordinary INVALID_REQUEST validation.
ref必填ArtifectRef | |
adjust必填ArtifectAdjust |
返回 · CustomerArtifectDecisionResponse
Expose an Artifect decision status, rejection or sanitized failure.
curl -X POST \
"/api/v3/gateway/artifect_adjust" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"ref":{"id":"artifect_1"},"adjust":{"baseRevision":0,"replayKey":"example-adjust-1","adjustment":{"adjustmentType":"EXCLUDE_ASINS","asins":["B0EXAMPLE1"]}}}'取消报告MCP 工具 · artifect_cancel
/api/v3/gateway/artifect_cancel取消正在运行的报告。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ArtifectRef
Identify one durable Artifect instance by its opaque public id.
object可选string | |
id必填string |
返回 · CustomerArtifectStatusResponse
Expose an Artifect lifecycle status or sanitized failure.
curl -X POST \
"/api/v3/gateway/artifect_cancel" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"id":"artifect_1"}'报告进度MCP 工具 · artifect_status
/api/v3/gateway/artifect_status报告进行到哪一步,以及它在等待什么。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ArtifectRef
Identify one durable Artifect instance by its opaque public id.
object可选string | |
id必填string |
返回 · CustomerArtifectStatusResponse
Expose an Artifect lifecycle status or sanitized failure.
curl -X POST \
"/api/v3/gateway/artifect_status" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"id":"artifect_1"}'报告待答问题MCP 工具 · artifect_read_input
/api/v3/gateway/artifect_read_input报告正在等待的输入及其选项。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ArtifectInputRequest
One page of the input a parked run offers.
ref必填ArtifectRef | |
inputKey必填string | |
cursor可选string | null | |
maxItems可选integer | null |
返回 · CustomerArtifectInputResponse
Expose an Artifect input page, a terminal-run rejection or a sanitized failure.
curl -X POST \
"/api/v3/gateway/artifect_read_input" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"ref":{"id":"artifect_1"},"inputKey":"DIMENSIONS:a1b2c3d4"}'读取报告MCP 工具 · artifect_snapshot
/api/v3/gateway/artifect_snapshot报告当前的结果。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ArtifectSnapshotRequest
Which run, which immutable revision (None is the head) and which board objects to focus.
ref必填ArtifectRef | |
revision可选integer | null | |
focus可选string[] |
返回 · CustomerArtifectSnapshotResponse
Expose an Artifect snapshot or sanitized failure.
curl -X POST \
"/api/v3/gateway/artifect_snapshot" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"ref":{"id":"artifect_1"}}'读取报告明细MCP 工具 · artifect_detail
/api/v3/gateway/artifect_detail按报告自身的类型,读取其中一部分,例如一个商品、一个单元格或一行广告建议。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ArtifectDetailRequest
Address one artifect and ask it one kind-typed detail question.
返回 · CustomerArtifectDetailResponse
Expose one kind-typed Artifect detail answer or sanitized failure.
curl -X POST \
"/api/v3/gateway/artifect_detail" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"ref":{"id":"artifect_1"},"query":{"kind":"AMZ_PRODUCT_REPORT","query":{"object":"report_listing","asin":"B0EXAMPLE1"}}}'定位插件MCP 工具 · artifect_plugins
/api/v3/gateway/artifect_plugins定位分析可以使用的插件。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
返回 · CustomerArtifectPluginListResponse
Expose the installed positioning plugins in a JSON-object envelope.
object可选string | |
plugins必填RoomPublicDeclaration[] |
curl -X POST \
"/api/v3/gateway/artifect_plugins" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{}'我的报告MCP 工具 · artifect_runs
/api/v3/gateway/artifect_runs你自己的报告任务,按时间从新到旧分页列出;不填类型即列出全部类型。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ArtifectRunsRequest
Which of the caller's own Artifect runs to list, newest first.
kind可选ArtifectKind | null | |
storeId可选string | null | |
limit可选integer | |
before可选string | null |
返回 · ArtifectRunList
One newest-first page; next_before is set only when an older run exists.
object可选string | |
runs必填ArtifectRunItem[] | |
nextBefore可选string | null |
curl -X POST \
"/api/v3/gateway/artifect_runs" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"kind":"AMZ_ADS_ADVICE","storeId":"st_1"}'报告类型说明MCP 工具 · artifect_describe
/api/v3/gateway/artifect_describe一种报告类型的名称、用途,以及创建、调整、回答和明细调用所接受的确切字段。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ArtifectDescribeRequest
Which kind's request bodies to describe.
kind必填string | Identify the workflow family handled by an Artifect runtime. |
返回 · ArtifectKindDescription
One hosted kind's label, purpose and exact request bodies as one JSON Schema document.
kind必填ArtifectKind | |
label必填string | |
purpose必填string | |
requestSchema必填object |
curl -X POST \
"/api/v3/gateway/artifect_describe" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"kind":"AMZ_PRODUCT_REPORT"}'添加图片链接MCP 工具 · artifect_photo_links
/api/v3/gateway/artifect_photo_links保存你自己商品图片的 HTTPS 链接,或仅用作风格参考的公开图片链接;参考图片不会被当作你的商品图片。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · PhotoLinksRequest
HTTPS images stored as owner photos or scene-only references in one bounded intake.
urls必填string[] | |
origin可选string |
返回 · PhotoLinksAdded
The one owner-scoped intake result plus one typed problem per link that produced no photo.
intake必填PhotosAdded | IntakeRefusal | |
problems可选PhotoLinkProblem[] |
curl -X POST \
"/api/v3/gateway/artifect_photo_links" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"urls":["https://images.example.com/reference.jpg"],"origin":"REFERENCE"}'下载建议表格
/api/v3/gateway/artifect_workbook把一次广告优化建议导出为 Excel 文件。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
参数
ref必填string | The run to download. |
language必填Language | Language of the workbook labels. |
返回
curl -G \ "/api/v3/gateway/artifect_workbook" \ -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \ --data-urlencode "ref=<ref>" \ --data-urlencode "language=<language>"
修改与待办
进行店铺修改MCP 工具 · elta_propose
/api/v3/gateway/elta_propose进行一次店铺修改,例如出价或预算;该店铺对应的写入开关开启时立即应用,关闭时会被拒绝,不会提交任何内容。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ActionBatch
One non-empty proposal batch with a unique caller-owned key for each action.
actions必填ProviderAction[] | Requested actions in order, each with a unique action_key. |
返回 · ApprovalView
The inbox item and the proposal's current state shown to a person.
item必填ApprovalItem | |
proposal必填ProposalView |
curl -X POST \
"/api/v3/gateway/elta_propose" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"actions":[{"actionKey":"example-action-1","actionTypeKey":"amazon.ads.set_target_bid","account":{"connectionId":"conn_1","accountId":"acct_1","timezone":"UTC"},"target":{"level":"TARGET","entity":"target_1"},"change":{"bid":"0.90"}}]}'还原店铺修改MCP 工具 · elta_propose_revert
/api/v3/gateway/elta_propose_revert还原一次已记录的店铺修改;店铺支持撤销时立即应用。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · RevertRequest
Ask the service to construct the undo of one proposal; callers choose rows, never undo values.
proposalId必填string | Proposal to revert. |
actionKeys可选string[] | Optional rows to revert; empty means every revertible row. |
replayKey可选string | null | Caller-owned idempotency key. |
attribution可选ProposalAttribution | null | Origin and reason of this undo; excluded from its hash. |
返回 · ApprovalView
The inbox item and the proposal's current state shown to a person.
item必填ApprovalItem | |
proposal必填ProposalView |
curl -X POST \
"/api/v3/gateway/elta_propose_revert" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"proposalId":"proposal_1"}'查看审批MCP 工具 · approval_view
/api/v3/gateway/approval_view查看一条修改提议的审批状态。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · ApprovalViewRequest
Select an approval by its existing item id or its proposal id.
itemId可选string | null | Existing owner-scoped inbox item id. |
proposalId可选string | null | Proposal id, resolved through its owner-scoped inbox key. |
返回 · ApprovalView
The inbox item and the proposal's current state shown to a person.
item必填ApprovalItem | |
proposal必填ProposalView |
curl -X POST \
"/api/v3/gateway/approval_view" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"itemId":"item_1"}'添加待办MCP 工具 · todo_create
/api/v3/gateway/todo_create添加一条待办;同一个幂等键重复提交返回第一条。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · TodoCreate
Immutable original intent for an ordinary todo.
kind可选string | |
content必填ItemContent | |
key可选string | null |
返回 · CreateResult
Stored item and whether the call admitted a new row.
object可选string | |
item必填TodoItem | AlertItem | ApprovalItem | NotificationItem | |
created必填boolean |
curl -X POST \
"/api/v3/gateway/todo_create" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"content":{"title":"Review the weekly report"}}'完成待办MCP 工具 · todo_complete
/api/v3/gateway/todo_complete把一条待办标记为完成。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · InboxItemRef
Which inbox item a read or completion names (one tool/route input).
itemId必填string |
返回 · TodoItem
Ordinary todo with immutable creation and mutable current content.
id必填string | |
owner必填OwnerRef | |
current必填ItemContent | |
created_at必填string | |
revision必填integer | |
created_by可选ActorRef | null | |
kind可选string | |
object可选string | |
creation必填TodoCreate | |
status必填TodoStatus | |
resolved_by可选ActorRef | null |
curl -X POST \
"/api/v3/gateway/todo_complete" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"itemId":"item_1"}'撤回待办MCP 工具 · todo_withdraw
/api/v3/gateway/todo_withdraw撤回你的 AI Agent 创建且仍未处理的待办或审批请求;人创建的事项不受影响。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · InboxItemRef
Which inbox item a read or completion names (one tool/route input).
itemId必填string |
返回 · CustomerInboxItemResponse
Expose the inbox owner's todo/approval union without copying either item model.
curl -X POST \
"/api/v3/gateway/todo_withdraw" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"itemId":"item_1"}'待处理事项MCP 工具 · inbox_pending
/api/v3/gateway/inbox_pending你未完成的待办和待审批事项。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · InboxPendingRequest
One pending page: an opaque cursor and a bounded size (one tool/route input).
cursor可选string | null | |
limit可选integer |
返回 · ItemPage
One ranked pending page and the owner's full matching open count.
object可选string | |
items必填TodoItem[] | AlertItem[] | ApprovalItem[] | NotificationItem[] | |
next_cursor可选string | null | |
total必填integer |
curl -X POST \
"/api/v3/gateway/inbox_pending" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{}'单条事项MCP 工具 · inbox_get
/api/v3/gateway/inbox_get任意状态的一条待办或审批。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 免费
请求体 · InboxItemRef
Which inbox item a read or completion names (one tool/route input).
itemId必填string |
返回 · CustomerInboxItemResponse
Expose the inbox owner's todo/approval union without copying either item model.
curl -X POST \
"/api/v3/gateway/inbox_get" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"itemId":"item_1"}'工具
利润测算MCP 工具 · amz_profit_calculate
/api/v3/gateway/amz_profit_calculate根据成本和物流配置,计算一个商品的利润明细。
- 认证
- API 密钥:Authorization: Bearer <密钥>
- 价格
- 利润测算 计 1 次请求
请求体 · AmzProfitCalculateRequest
One product's cost and shipping observations for the profit calculator.
costProfile必填CostProfile | |
shippingProfile必填ShippingProfile | |
shippingMode可选ShippingMode | |
isPeakPeriod可选boolean |
返回 · ProfitBreakdown
One coherent scenario's exact selling-price-to-profit waterfall.
scenarioKey必填string | |
role必填ScenarioRole | |
shippingMode必填ShippingMode | |
isPeakPeriod必填boolean | |
sellingPrice必填MinorUnitMoney | |
lines必填ProfitBreakdownLine[] | |
profit必填MinorUnitMoney | |
margin必填number | |
sizing必填SizingDetail |
curl -X POST \
"/api/v3/gateway/amz_profit_calculate" \
-H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{"costProfile":{"len1":20,"len2":12,"len3":5,"lenUnit":"cm","marketplace":"US","weight":0.45,"weightUnit":"kg","expectedAdsCostRatio":0.2,"expectedPurchasingCost":{"amount":{"value":3000},"currency":"CNY"},"expectedAverageDailyInventoryVolume":30,"expectedAverageDailyShippedVolume":3,"isApparel":false,"isDangerousGoods":false,"isBattery":false,"feeCategoryString":"HOME_AND_KITCHEN","exchangeRates":[{"currency":"USD","exchangeRate":{"value":100}},{"currency":"CNY","exchangeRate":{"value":720}},{"currency":"CAD","exchangeRate":{"value":136}},{"currency":"EUR","exchangeRate":{"value":92}},{"currency":"GBP","exchangeRate":{"value":79}},{"currency":"JPY","exchangeRate":{"value":15000}},{"currency":"MXN","exchangeRate":{"value":1700}},{"currency":"PLN","exchangeRate":{"value":400}},{"currency":"SEK","exchangeRate":{"value":1050}}],"price":{"amount":{"value":3999},"currency":"USD"}},"shippingProfile":{"exchangeRates":[{"currency":"USD","exchangeRate":{"value":100}},{"currency":"CNY","exchangeRate":{"value":720}},{"currency":"CAD","exchangeRate":{"value":136}},{"currency":"EUR","exchangeRate":{"value":92}},{"currency":"GBP","exchangeRate":{"value":79}},{"currency":"JPY","exchangeRate":{"value":15000}},{"currency":"MXN","exchangeRate":{"value":1700}},{"currency":"PLN","exchangeRate":{"value":400}},{"currency":"SEK","exchangeRate":{"value":1050}}],"freightPerKg":{"amount":{"value":3},"currency":"USD"},"airPerKg":{"amount":{"value":8},"currency":"USD"}}}'对象
1031接口请求和返回用到的对象。展开即可查看字段。
AbsencePolicy可选值 · 2
What an entity missing from a confirmed day means for its family.
AbsoluteTargetBidValue2
An absolute bid for a keyword, a product target or an exact-harvest keyword.
kind可选string | |
bid必填number | string |
AccountChoice2
One owner-visible account option offered when the caller must select an account.
accountId必填string | Stored account identifier. |
label必填string | Readable account or marketplace name. |
AccountRef4
One provider account reached through one bound connection.
connectionId必填string | Connector reaching this account. |
accountId必填string | Account identifier within the source. |
timezone必填string | Reporting timezone of this account. |
currency可选string | null | Account currency; null when no money is reported. |
AcquisitionMode可选值 · 3
Whether DI may buy a bulk provider snapshot for this query, or only call live.
ActionBatch1
One non-empty proposal batch with a unique caller-owned key for each action.
actions必填ProviderAction[] | Requested actions in order, each with a unique action_key. |
ActionDiff11
One derived action diff with its declared undo fidelity and whether the row is revertible.
actionKey必填string | Proposal action row key. |
kind必填ActionKind | ADD, SET or REMOVE action presentation kind. |
status必填ActionStatus | Proposal preview or apply status for this row. |
target必填EntityRef | |
label可选string | null | Provider display label, when available. |
imageUrl可选string | null | The provider's https display image of the target, when it has one; display only, never identity; null when unknown. |
lines可选DiffLine[] | Derived field-level change lines. |
fidelity必填RevertFidelity | Declared completeness of the action's undo. |
revertible可选boolean | Whether this row can be reverted: on a stored view, an applied, not yet reverted action whose fidelity is not NONE; on a preview, the declared limit. Never true when fidelity is NONE. |
revertNote可选StoreLocalizedText | null | Provider-specific undo limitation, in both languages. |
alsoPending可选string[] | Other open proposals touching the same change key. |
ActionFamily2
One owner-facing group of actions that a store can enable or disable together.
key必填string | Write-family identifier. |
title必填StoreLocalizedText | Owner-facing name of this write family. |
ActionIntent可选值 · 5
Neutral write meanings, without provider wire names.
ActionKind可选值 · 3
What one action does to its target; it selects the shared gate and diff colour.
ActionOutcome12
Live preview or final result for one action, with one typed refusal reason if rejected.
actionKey必填string | The action row this outcome belongs to. |
status必填ActionStatus | Preview or apply result for this action. |
current可选JsonValue | null | Current provider value when available. |
label可选string | null | Provider label for the target, when available. |
created可选EntityRef | null | |
issue可选ProviderIssue | null | Provider-owned refusal reason. |
refusal可选string | null | Why the write gate refused this row. |
blockedBy可选string | null | Earlier row or apply record holding a conflicting change key. |
problems可选FieldProblem[] | Field-level provider validation details. |
quote可选JsonValue | null | Provider estimate included in this outcome. |
version可选string | null | Opaque live token read at preview. |
createdVersion可选string | null | Provider version of the entity an applied ADD created. |
ActionProposal15
Stored proposal plus preview and eventual outcomes for one store and account.
object可选string | Fixed tag marking an action proposal. |
proposalId必填string | Identifier of this proposal. |
storeId必填string | Store whose write policy applies. |
account必填AccountRef | Account every action of this proposal targets. |
batch必填ActionBatch | Requested provider changes. |
replayKey可选string | null | Caller-owned idempotency key. |
attribution可选ProposalAttribution | null | Origin and reason frozen at creation; null for 3.2 proposals; not hashed. |
decline可选ProposalDecline | null | Decline actor and reason; set exactly on a DECLINED proposal; not hashed. |
previews必填ActionOutcome[] | One live outcome per action, in order. |
reverts可选RevertLink[] | Apply records this proposal is attempting to revert. |
proposalHash必填string | Hash of the exact proposal contents. |
proposedAt必填string | Instant the proposal was created. |
expiresAt必填string | Instant after which the proposal cannot be applied. |
state可选ProposalState | Proposal lifecycle state. |
outcomes可选ActionOutcome[] | One final outcome per action, set after proposal application. |
ActionStatus可选值 · 5
Preview or apply result for one action; equality-to-preview is not a status.
AddBlock4
Add one block (caller-chosen stable key) to a section after another block (None: at the end).
action可选string | |
sectionKey必填string | |
block必填ThemeBlockInstance | |
after可选string | null |
AddDesign6
Add an empty OWN image; layouts come only from ApplyTemplate (one template path).
action可选string | |
designId必填string | |
name必填string | |
preset必填string | |
size可选PixelSize | null | |
position可选BoardPoint | null |
AddItems3
Add items by hand, as relevant; they start unplaced, so then CLASSIFY every dimension, price bands included.
type可选string | |
actionKey必填string | |
items必填SourcedItem[] |
AddLayer5
Insert a layer (caller-minted id) above above, or at the top when None.
action可选string | |
designId必填string | |
layer必填ImageLayer | TextLayer | ShapeLayer | GroupLayer | |
above可选string | null | |
parent可选string | null |
AddNegativeKeywordValue2
The negative-keyword match type only; the text is the row's exact search term.
kind可选string | |
matchType必填AdsNegativeMatch |
AddPage4
Add an empty page for one template (UNKNOWN target refusals are the runtime's).
action可选string | |
template必填ThemeTemplateRef | |
previewPath必填string | |
newPage可选NewKeblePage | null |
AddPlan7
Add a content plan whose rows will become variants of the OWN image source_id.
action可选string | |
objectId必填string | |
name必填string | |
sourceId必填string | |
columns必填PlanColumn[] | |
rows可选PlanRow[] | |
position可选BoardPoint | null |
AddSection4
Place a new section (caller-chosen stable key) on a page after an anchor (None: at the end).
action可选string | |
page必填ThemeTemplateRef | |
section必填ThemeSectionInstance | |
after可选string | null |
AdsAdType可选值 · 3
Amazon Ads product family one row belongs to (ELTA1 TodoAdType).
AdsAdviceAction可选值 · 7
The one action the AI picks for one reviewed row (ELTA1 TodayAdviceAction).
AdsAdviceRow23
One flagged entity row of one marketplace, with its five windows.
rowKey必填string | |
level必填AdsLevel | |
adType必填AdsAdType | |
entityId必填string | |
campaignId可选string | null | |
adGroupId可选string | null | |
keywordId可选string | null | |
targetId可选string | null | |
advertisedAsin可选string | null | |
name可选string | null | |
campaignName可选string | null | |
adGroupName可选string | null | |
state可选string | null | |
budget可选number | string | null | |
matchType可选AdsMatchType | null | |
bid可选number | string | null | |
d必填AdsWindowMetrics | |
dMinus1必填AdsWindowMetrics | |
dMinus7必填AdsWindowMetrics | |
l7必填AdsWindowMetrics | |
p7必填AdsWindowMetrics | |
triggerCodes必填AdsTriggerCode[] | |
foldedInto可选string | null |
AdsChangeListAbsenceReason可选值 · 4
Why a marketplace that shows advice has no one-click AMZ_ADS_CHANGES list.
AdsDecisionType可选值 · 1
The Ads kind's one agent decision on the shared decision_type discriminator.
AdsEvidenceField可选值 · 8
The non-metric source facts of one AdsAdviceRow a citation may name.
AdsEvidenceRole可选值 · 2
Whether one cited fact supports or cautions against the advice.
AdsLevel可选值 · 6
Advice grain, mapped explicitly onto ELTA's EntityLevel.
AdsLevelNoChange3
Rows of one level that raised no signal: the proof of what was not shown.
level必填AdsLevel | |
count必填integer | |
l7Spend可选number | string | null |
AdsMarketplaceAdvice12
The screen and review result of ONE marketplace of the store.
marketplace必填AmazonMarketplace | |
currency必填Currency | |
anchorDay必填string | |
completeness必填AdsWindowCompleteness | |
screenedCount必填integer | |
candidateCount必填integer | |
candidateOverflow可选boolean | |
noChange可选AdsLevelNoChange[] | |
rows可选AdsAdviceRow[] | |
reviews可选AdsRowReview[] | |
targetAcosPct可选number | string | null | |
oneClick可选AdsRowOneClick[] |
AdsMarketplaceQuery3
Ask for one marketplace's advice, optionally only the rows of one action.
object可选string | |
marketplace必填AmazonMarketplace | |
action可选AdsAdviceAction | null |
AdsMatchType可选值 · 3
Keyword-only match identity from the existing ELTA datasets.
AdsMetricEvidenceRef5
Cite one measured cell of the reviewed row by window and metric.
kind可选string | |
rowKey必填string | |
window必填AdsMetricWindow | |
metric必填AdsMetricName | |
role必填AdsEvidenceRole |
AdsMetricName可选值 · 6
The AdsWindowMetrics fields a metric citation may name.
AdsMetricWindow可选值 · 5
The five metric-window fields of one AdsAdviceRow a citation may name.
AdsNegativeMatch可选值 · 2
The agent's negative-keyword match choice; mapped once to ELTA's type.
AdsReadOnlyReason可选值 · 5
Why one shown advice row has no one-click change.
AdsReasoning3
Observation, inference and uncertainty as separate qualitative statements.
observedSignal必填string | |
interpretation必填string | |
caveat可选string | null |
AdsRowAuditAnswer3
One audit fragment: reviews for some offered rows plus the rows deliberately skipped.
decisionType可选string | |
reviews可选AdsRowReview[] | |
skippedRowKeys可选string[] |
AdsRowAuditItem4
One frozen flagged row offered to the agent, read in its marketplace's money.
marketplace必填AmazonMarketplace | |
currency必填Currency | |
anchorDay必填string | |
row必填AdsAdviceRow |
AdsRowDetail5
One flagged row with its AI review and the money context it is read in.
marketplace必填AmazonMarketplace | |
currency必填Currency | |
anchorDay必填string | |
row必填AdsAdviceRow | |
review可选AdsRowReview | null |
AdsRowFieldEvidenceRef4
Cite one typed non-metric source fact of the reviewed row.
kind可选string | |
rowKey必填string | |
field必填AdsEvidenceField | |
role必填AdsEvidenceRole |
AdsRowOneClick3
Join one shown advice row to its change row, or state why it is read-only.
rowKey必填string | |
changeRowKey必填string | null | |
readOnly必填AdsReadOnlyReason | null |
AdsRowQuery3
Ask for one flagged row of one marketplace and its AI review.
object可选string | |
marketplace必填AmazonMarketplace | |
rowKey必填string |
AdsRowReview6
One AI decision for one flagged row; the audit answer carries exactly these fields.
rowKey必填string | |
action必填AdsAdviceAction | |
reason必填string | |
reasoning可选AdsReasoning | null | |
evidenceRefs可选AdsMetricEvidenceRef[] | AdsRowFieldEvidenceRef[] | |
suggestedChange可选RelativeTargetBidChange | AbsoluteTargetBidValue | SetDailyBudgetValue | AddNegativeKeywordValue | null |
AdsTriggerCode可选值 · 6
Deterministic screen signals (ELTA1 TodoTriggerCode).
AdsWindowCompleteness5
Whether each comparison window of one marketplace is fully synced.
latestDay必填boolean | |
previousDay必填boolean | |
sameWeekdayLastWeek必填boolean | |
last7Days必填boolean | |
prior7Days必填boolean |
AdsWindowMetrics6
Public metric bases and ACoS of one comparison window (ELTA1 DailyTodoWindowMetrics).
impressions可选number | string | null | |
clicks可选number | string | null | |
spend可选number | string | null | |
orders可选number | string | null | |
sales可选number | string | null | |
acosPct可选number | string | null |
AlertCreate4
Immutable SYSTEM-only alert intent with an optional host-defined remedy.
kind可选string | |
content必填ItemContent | |
key可选string | null | |
action可选ItemAction | null |
AlertItem11
Source alert with immutable creation and source-confirmed clear state.
id必填string | |
owner必填OwnerRef | |
current必填ItemContent | |
created_at必填string | |
revision必填integer | |
created_by可选ActorRef | null | |
kind可选string | |
object可选string | |
creation必填AlertCreate | |
status必填AlertStatus | |
resolved_by可选ActorRef | null |
AlertStatus可选值 · 2
An alert is cleared only after its source confirms recovery.
AmazonMarketplace可选值 · 13
AmzProfitCalculateRequest4
One product's cost and shipping observations for the profit calculator.
costProfile必填CostProfile | |
shippingProfile必填ShippingProfile | |
shippingMode可选ShippingMode | |
isPeakPeriod可选boolean |
Analysis8
Optional bounded analyzed facts (relations, unlinked mentions, concepts, trend features) attached to one typed node hit.
recordKey必填string | Analyzed record key these facts belong to. |
version必填integer | Version of the analyzed record these facts were read from. |
observedAt必填string | null | When these facts were observed; null when unknown. |
freshness可选RecordFreshnessTimes | |
relations可选RelationRef[] | Typed relations attached to the record. |
unlinkedMentions可选UnlinkedMention[] | Claims of the record that name an entity no held record matched; at most 16. |
concepts可选ConceptRef[] | Concepts extracted for the record. |
features可选FeatureValue[] | Windowed feature values for the record. |
AnalyzedRecordKind可选值 · 5
WHAT KIND OF RECORD a stored analyzed row is about — the column that makes 'kind is a column, not a table' true, and the identity space `AnalyzedStoreWriteProtocol.reserve_version` allocates versions in. NODE: one analyzed copy of any one node kind — a DI entity or content item or a DP-derived node; `node_kind` beside it says WHICH node. IDEA and CONCEPT: the extract capability's semantic output, including the CLAIM rows the grouping linker later matches. RELATION and TREND: what grouping computes — an edge between two nodes, and a windowed feature over such edges.
AnalyzedRelationKind可选值 · 13
Every relation row the platform may write: subject --kind--> object.
AnswerLanguage可选值 · 2
Language of seller-facing clarification and refusal wording.
ApplyTemplate4
Replace a design's layers with a template's, filling its placeholders (the one template path).
action可选string | |
designId必填string | |
template必填string | |
fills可选TextFill[] | ImageFill[] |
ApprovalCreate7
Immutable SYSTEM-written proposal intent, verified proposer and expiry.
kind可选string | |
content必填ItemContent | |
key必填string | |
proposal必填ProposalRef | |
requested_by可选ActorRef | null | |
expires_at可选string | null | |
ref可选string | null |
ApprovalItem11
Proposal-bound decision whose source reference cannot be edited.
id必填string | |
owner必填OwnerRef | |
current必填ItemContent | |
created_at必填string | |
revision必填integer | |
created_by可选ActorRef | null | |
kind可选string | |
object可选string | |
creation必填ApprovalCreate | |
status必填TodoApprovalStatus | |
decided_by可选ActorRef | null |
ApprovalState4
The live read of one filed item: inbox status and ELTA's current view.
inboxItemId必填string | |
status必填ArtifectHostApprovalStatus | |
withdrawn可选boolean | |
proposal必填ProposalView |
ApprovalView2
The inbox item and the proposal's current state shown to a person.
item必填ApprovalItem | |
proposal必填ProposalView |
ApprovalViewRequest2
Select an approval by its existing item id or its proposal id.
itemId可选string | null | Existing owner-scoped inbox item id. |
proposalId可选string | null | Proposal id, resolved through its owner-scoped inbox key. |
ArtifectAccountRequired2
The create answer when the store has several accounts and none was chosen.
object可选string | |
accountChoices必填AccountChoice[] |
ArtifectAdjust3
Carry one post-completion adjustment against a committed revision.
baseRevision必填integer | |
replayKey必填string | |
adjustment必填ProfitInputsAdjustment | ProfileInputsAdjustment | ExcludeAsinsAdjustment | JudgmentAdjustment | ArtifectPositioningAdjustment | ArtifectAdsAdviceRemove | ArtifectProductImagesEdit | ArtifectProductImagesExport | ArtifectChangeListEdit | ArtifectChangeListPropose | ArtifectChangeListProposeRevert | ArtifectShopifyThemeEdit | ArtifectShopifyThemeUpdatePreview | ArtifectShopifyThemePublish | ArtifectShopifyThemeDiscardPreview | ArtifectShopifyThemeProposeRevert | ArtifectShopifyThemeProposeDiscard | ArtifectShopifyBlogPostsEdits | ArtifectShopifyBlogPostsPropose | ArtifectShopifyBlogPostsProposeRevert | ArtifectShopifyProductEdit | ArtifectShopifyProductPropose | ArtifectShopifyProductProposeRevert | ArtifectAmzListingEdit | ArtifectAmzListingPropose | ArtifectAmzListingProposeRevert | ArtifectFbaInboundProposePlan | ArtifectFbaInboundProposePacking | ArtifectFbaInboundProposeRevert | ArtifectMonitorAdjust | StandingAdjust | One post-completion edit. Later changes to the seller's own cost go through PROFILE_INPUTS and re-price every product; competitors' costs can be changed one by one or as a set through PROFIT_INPUTS. PROFILE_INPUTS also changes the ACOS band, the whole-product fixed size/weight and the entry budget; PROFIT_INPUTS corrects a named product (ask the seller for override sizes and weights; one size may be assigned to a set of products); EXCLUDE_ASINS never adds one. JUDGMENT rewrites the conclusion text of a finished revision (a verdict, named section slots or the overview; numbers untouched) and may be sent at any time. A re-priced revision carries a typed recheck hint: recheck the summary and conclusions against the new numbers, then send ONE JUDGMENT update. Conclusion texts carry no figures; a verdict the policy fixed (including a can't-decide NOT_DETERMINABLE) stays fixed and must be omitted. |
ArtifectAdjustRequest2
Which run and typed adjustment; removed arms retain ordinary INVALID_REQUEST validation.
ref必填ArtifectRef | |
adjust必填ArtifectAdjust |
ArtifectAdjustmentStatus8
Project one admitted adjustment or queued model work on the same run.
adjustmentRef必填string | Opaque child-task or same-run queued-work locator. |
stage必填TaskStage | Adjustment or queued-work execution stage. |
targetRevision必填integer | Revision the edit publishes or queued work updates. |
failureCode可选string | null | Stable child failure refinement code while failed, when available. |
failureReason可选string | null | Sanitized child failure sentence while failed. |
failureType可选TaskExceptionType | null | Child's keble-task failure class, set only while stage is FAILURE. |
updatedAt必填string | Projection instant of this row. |
recheckHint可选ArtifectRecheckHint | null | Figures-moved recheck hint, set only on the SUCCESS projection of a committed adjustment whose figures moved; None (the default) is never serialized. |
ArtifectAdsAdviceCreate5
Start one on-demand Ads optimization-suggestions run for one store.
kind可选string | |
replayKey必填string | |
storeId必填string | |
anchorDay可选string | null | Requested data day; null means yesterday in UTC; a later day is refused before any source is read. |
language可选Language | null |
ArtifectAdsAdviceDetail2
Carry one marketplace's advice or one row's detail from the stored run.
kind可选string | |
answer必填AdsMarketplaceAdvice | AdsRowDetail |
ArtifectAdsAdviceDetailQuery2
Wrap the ads-advice detail query (owned by ads_advice).
kind可选string | |
query必填AdsMarketplaceQuery | AdsRowQuery |
ArtifectAdsAdviceRemove3
Remove advice rows in one marketplace, including manual-only advice.
adjustmentType可选string | |
marketplace必填AmazonMarketplace | |
rowKeys必填string[] |
ArtifectAdsAdviceSnapshot8
Expose one completed Ads optimization-suggestions run, per marketplace.
kind可选string | |
storeId必填string | |
createdAt必填string | |
requestedAnchorDay可选string | null | |
marketplaces可选AdsMarketplaceAdvice[] | |
changeLists可选ArtifectAdsChangeListLink[] | |
changeListAbsences可选ArtifectAdsChangeListAbsence[] | |
unsupportedMarketplaces可选string[] |
ArtifectAdsChangeListAbsence2
Say why one marketplace that shows advice has no AMZ_ADS_CHANGES list.
marketplace必填AmazonMarketplace | |
reason必填AdsChangeListAbsenceReason |
ArtifectAdsChangeListLink2
Link one marketplace of an Ads Advice run to its AMZ_ADS_CHANGES list.
marketplace必填AmazonMarketplace | |
ref必填ArtifectRef |
ArtifectAdsRowAuditInputPage10
Input page for ADS_ROW_AUDIT: one page of flagged Ads rows to audit.
object可选string | |
inputKey必填string | |
ownerRevision必填integer | |
instructions必填string | |
items可选AdsRowAuditItem[] | |
coveredItemCount必填integer | |
itemCount必填integer | |
nextCursor可选string | null | |
deadline必填string | |
decisionType可选string |
ArtifectAmzListingCreate2
Create one owner-fenced new Amazon listing draft from the kind's own ListingCreate.
kind可选string | |
request必填ListingCreate |
ArtifectAmzListingEdit2
Replace an AMZ_LISTING draft's whole content (editor or agent edit).
adjustmentType可选string | |
content必填ListingContent |
ArtifectAmzListingPropose1
File the draft's one ADD for approval at the envelope's base_revision.
adjustmentType可选string |
ArtifectAmzListingProposeRevert1
File the undo (seller-SKU removal) of a LISTED draft at the envelope's base_revision.
adjustmentType可选string |
ArtifectAmzListingSnapshot2
Carry the listing core's current ListingSnapshot under its kind tag.
kind可选string | |
snapshot必填ListingSnapshot |
ArtifectAnswer4
Carry one validated decision fragment for a parked Artifect.
inputKey必填string | |
expectedRevision必填integer | |
replayKey必填string | |
decision必填ReportScopeAnswer | SampleRelevanceAnswer | MaterialFactsAnswer | StandoutSelectionAnswer | ReportJudgmentAnswer | ArtifectPositioningStepDecision | AdsRowAuditAnswer | ArtifectShopifyBlogPostsStepDecision | ArtifectMonitorSetupAnswer | ArtifectMonitorConfirmAnswer |
ArtifectAnswerRequest2
Which run, and the typed decision fragment (own input key, revision and replay_key).
ref必填ArtifectRef | |
answer必填ArtifectAnswer |
ArtifectChangeListCreate2
Carry one account-free change-list create premise to its configured host.
kind必填string | |
request必填ChangeListCreatePremise |
ArtifectChangeListEdit2
Submit the shared engine's typed edit operations through artifect_adjust.
adjustmentType可选string | |
ops必填AddRows[] | EditRow[] | DiscardRow[] | RestoreRow[] |
ArtifectChangeListPropose2
Ask the shared engine to file selected rows; empty selects every eligible row.
adjustmentType可选string | |
rowKeys可选string[] |
ArtifectChangeListProposeRevert2
Ask the engine to revert selected applied rows; empty selects all eligible rows.
adjustmentType可选string | |
rowKeys可选string[] |
ArtifectChangeListSnapshot2
Carry the engine's canonical current change-list snapshot under its kind tag.
kind可选string | |
snapshot必填ChangeListSnapshot |
ArtifectDecisionRejection8
Report one typed refusal without failing the Artifect run.
object可选string | |
inputKey可选string | null | |
reason必填ArtifectRejectionReason | |
pendingInputKey可选string | null | |
currentRevision可选integer | null | |
itemKeys可选string[] | null | |
message可选string | null | |
kindCode可选string | null |
ArtifectDescribeRequest1
Which kind's request bodies to describe.
kind必填string | Identify the workflow family handled by an Artifect runtime. |
ArtifectDetail4
One typed detail answer about one artifect.
object可选string | |
ref必填ArtifectRef | |
payload必填ArtifectReportDetail | ArtifectPositioningDetail | ArtifectAdsAdviceDetail | ArtifectProductImagesDetail | ArtifectShopifyThemeRunDetail | ArtifectMonitorDetail | ArtifectOccurrences | |
capturedAt必填string |
ArtifectDetailRequest2
Address one artifect and ask it one kind-typed detail question.
ArtifectFailure4
The provider-free failure one customer answer may carry.
object可选string | |
code必填ArtifectFailureCode | |
retryable必填boolean | |
message必填string |
ArtifectFailureCode可选值 · 7
Classify one sanitized failure a customer may see for an Artifect run.
ArtifectFbaInboundPlanCreate5
Create one Amazon FBA inbound plan artifect and file its plan proposal.
kind可选string | |
replayKey必填string | |
storeId必填string | |
accountId可选string | null | |
change必填object | ELTA action `amazon.seller.create_fba_inbound_plan`'s change, passed through unchanged except for one default. Required: `source_address` (the private ship-from address, its `phone_number` included) and `items` (at least one row, each with `msku`, `quantity` > 0, `prep_owner` and `label_owner`). A row that omits `prep_owner` is filed with `SELLER`: Amazon refuses `NONE` for an item that needs prep, and Amazon US ended its own prep service on 2026-01-01, so `SELLER` is the safe choice there and `AMAZON` is never accepted for prep in the US. `name` is the plan's optional name. Full schema: elta_catalog actions[key=amazon.seller.create_fba_inbound_plan].changeSchema. |
ArtifectFbaInboundPlanSnapshot9
Expose one FBA inbound plan: its stage, the agent's next step and the live approvals.
kind可选string | |
storeId必填string | |
stage必填FbaInboundStage | |
guide必填string | |
plan可选EntityRef | null | |
planStatus可选FbaInboundPlanStatus | null | |
create可选ApprovalState | null | |
packing可选ApprovalState | null | |
revert可选ApprovalState | null |
ArtifectFbaInboundProposePacking2
File the boxes on the created plan with ELTA's SetFbaInboundPacking change.
adjustmentType可选string | |
change必填object | ELTA action `amazon.seller.set_fba_inbound_packing`'s change, passed through unchanged and filed on the plan Amazon created. Required: `packing_option_id` (one of the plan's live packing options) and `groupings` (one per `packing_group_id`), each grouping holding its `boxes` - dimensions (length, width, height and unit), weight and weight_unit, the quantity of identical boxes - and the items in each box by `msku` and `quantity`. Full schema: elta_catalog actions[key=amazon.seller.set_fba_inbound_packing].changeSchema. |
ArtifectFbaInboundProposePlan2
Re-file the plan with an edited ELTA CreateFbaInboundPlan change.
adjustmentType可选string | |
change必填object | ELTA action `amazon.seller.create_fba_inbound_plan`'s change, passed through unchanged except for one default. Required: `source_address` (the private ship-from address, its `phone_number` included) and `items` (at least one row, each with `msku`, `quantity` > 0, `prep_owner` and `label_owner`). A row that omits `prep_owner` is filed with `SELLER`: Amazon refuses `NONE` for an item that needs prep, and Amazon US ended its own prep service on 2026-01-01, so `SELLER` is the safe choice there and `AMAZON` is never accepted for prep in the US. `name` is the plan's optional name. Full schema: elta_catalog actions[key=amazon.seller.create_fba_inbound_plan].changeSchema. |
ArtifectFbaInboundProposeRevert1
File ELTA's undo of the newest applied proposal; undo cancels the whole plan.
adjustmentType可选string |
ArtifectInputRequest4
One page of the input a parked run offers.
ref必填ArtifectRef | |
inputKey必填string | |
cursor可选string | null | |
maxItems可选integer | null |
ArtifectJudgmentInputPage16
Input page for JUDGMENT: the conclusion question and its citable evidence.
object可选string | |
inputKey必填string | |
ownerRevision必填integer | |
instructions必填string | |
items可选ReportJudgmentEvidenceItem[] | Citable accepted artifacts. |
coveredItemCount必填integer | |
itemCount必填integer | |
nextCursor可选string | null | |
deadline必填string | |
decisionType可选string | |
language必填Language | Reader language of every text. |
verdictOpen必填boolean | False: a policy pre-check already fixed the verdict. |
fixedReasonCode可选ReportReasonCode | null | Set iff the verdict is not open. |
materialInputUnresolvedAdmissible必填boolean | Whether MATERIAL_INPUT_UNRESOLVED may be the reason. |
ruleLines可选string[] | Policy rules the verdict must follow. |
sectionKinds必填ReportNarrativeSectionKind[] | The section slots to write, once each. |
ArtifectKind可选值 · 16
Identify the workflow family handled by an Artifect runtime.
ArtifectKindDescription4
One hosted kind's label, purpose and exact request bodies as one JSON Schema document.
kind必填ArtifectKind | |
label必填string | |
purpose必填string | |
requestSchema必填object |
ArtifectMaterialFactsInputPage10
Input page for MATERIAL_FACTS: every open material question.
object可选string | |
inputKey必填string | |
ownerRevision必填integer | |
instructions必填string | |
items可选ReportMaterialQuestion[] | |
coveredItemCount必填integer | |
itemCount必填integer | |
nextCursor可选string | null | |
deadline必填string | |
decisionType可选string |
ArtifectMonitorAdjust2
Edit a monitor's watches, schedule or delivery at the status's revision (0.25.0).
adjustmentType可选string | |
command必填MonitorSetWatches | MonitorSetCadence | MonitorSetDelivery |
ArtifectMonitorConfirmAnswer1
Confirm a MONITOR draft's spec at the answer's expected_revision (its spec revision, 0.25.0).
decisionType可选string |
ArtifectMonitorConfirmInputPage7
The MONITOR confirm page (0.25.0): "What we'll monitor" for the person to confirm.
object可选string | |
decisionType可选string | |
inputKey必填string | |
ownerRevision必填integer | |
deadline必填string | |
nextCursor可选null | |
page必填MonitorConfirmPage |
ArtifectMonitorCreate3
Create one MONITOR draft (a standing artifect), parked on its setup input.
kind可选string | |
replayKey必填string | |
title必填string |
ArtifectMonitorDecisionType可选值 · 2
The two inputs a MONITOR draft parks on (0.25.0): setup, then the person's confirm.
ArtifectMonitorDetail4
One monitor check in full (0.25.0), the answer to ArtifectMonitorDetailQuery.
kind可选string | |
cycle必填MonitorCycle | |
findings可选MonitorFinding[] | |
nextAfter可选MonitorFindingKey | null |
ArtifectMonitorDetailQuery4
Open one monitor check in full (0.25.0): its coverage, deliveries and one findings page.
kind可选string | |
cycleSeq必填integer | |
after可选MonitorFindingKey | null | |
limit必填integer |
ArtifectMonitorSetupAnswer4
Answer a MONITOR draft's setup: the watches, the schedule and the delivery channels (0.25.0).
decisionType可选string | |
watches必填MonitorWatchRequest[] | |
cadence必填MonitorCadence | |
delivery可选MonitorDelivery |
ArtifectMonitorSetupInputPage7
The MONITOR setup page (0.25.0): the core-rendered capability offers and the cadence floor.
object可选string | |
decisionType可选string | |
inputKey必填string | |
ownerRevision必填integer | |
deadline必填string | |
nextCursor可选null | |
page必填MonitorSetupPage |
ArtifectMonitorSnapshot2
A MONITOR's snapshot (0.25.0): the monitor, its open cycle and its newest finished one.
kind可选string | |
snapshot必填MonitorSnapshot |
ArtifectOccurrence5
One scheduled occurrence (a monitor's check), as every standing kind shows it.
seq必填integer | |
state必填ArtifectOccurrenceState | |
dueAt必填string | |
finishedAt必填string | null | |
newCount必填integer |
ArtifectOccurrenceState可选值 · 5
Where one scheduled occurrence is; RUNNING is open, the other four are finished.
ArtifectOccurrences2
The answer to ArtifectOccurrencesQuery: one page of occurrences, newest first.
items必填ArtifectOccurrence[] | |
more必填boolean |
ArtifectOccurrencesQuery4
List a standing artifect's occurrences (a monitor's checks), newest first.
query必填string | |
beforeSeq可选integer | null | |
limit必填integer | |
kind可选string | null |
ArtifectPendingInput5
Summarize the one request a WAITING_FOR_INPUT Artifect is parked on.
inputKey必填string | |
decisionType必填ReportDecisionType | ArtifectPositioningDecisionType | AdsDecisionType | ArtifectShopifyBlogPostsDecisionType | ArtifectMonitorDecisionType | |
itemCount必填integer | |
coveredItemCount必填integer | |
deadline必填string |
ArtifectPositioningAdjustment2
Post-completion positioning edits applied literally, without a rerun.
adjustmentType可选string | |
edits必填SetSetup[] | AddItems[] | UpdateItems[] | RemoveItems[] | SaveDimension[] | DeleteDimension[] | SetPlacements[] | SaveCriterion[] | DeleteCriterion[] | SetResults[] | SaveView[] | DeleteView[] | ReorderViews[] | Continue[] | SetReview[] | Cancel[] | Propose[] | Classify[] | Assess[] | Score[] | Decide[] |
ArtifectPositioningCreate6
Carry the source-agnostic premise for one positioning study.
kind可选string | |
replayKey必填string | |
positioningContext必填string | |
pluginId可选string | null | Installed plugin ID; omit for the host default. Setup must match this plugin's declaration. |
setup可选object | null | Values for the selected plugin's declared setup fields; omitted fields are proposed at SCOPE. |
language可选Language | null |
ArtifectPositioningDecisionType可选值 · 1
The one positioning answer family: a waiting run step's reviewed result.
ArtifectPositioningDetail2
Carry positioning's own answered detail and the labels its answer uses.
kind可选string | |
answer必填PositioningDetail |
ArtifectPositioningDetailQuery2
Wrap the POSITIONING package's own detail query for one positioning.
kind可选string | |
query必填PositioningCellQuery | PositioningItemsQuery |
ArtifectPositioningSnapshot3
Expose one committed POSITIONING revision through customer projections.
kind可选string | |
room必填RoomPublicRead | |
decision必填RoomPublicDecisionRead |
ArtifectPositioningStepCell2
One assessed cell the waiting step produced (the ASSESS review).
resultType可选string | |
cell必填RoomCell |
ArtifectPositioningStepDecision3
Answer a waiting positioning step: apply these edits, then continue.
decisionType可选string | |
step必填RunStep | |
edits可选SetSetup[] | AddItems[] | UpdateItems[] | RemoveItems[] | SaveDimension[] | DeleteDimension[] | SetPlacements[] | SaveCriterion[] | DeleteCriterion[] | SetResults[] | SaveView[] | DeleteView[] | ReorderViews[] | Continue[] | SetReview[] | Cancel[] | Propose[] | Classify[] | Assess[] | Score[] | Decide[] |
ArtifectPositioningStepInputPage8
One waiting positioning step and the result its agent reviews.
object可选string | |
decisionType可选string | |
inputKey必填string | |
step必填RunStep | |
run必填RunRead | |
results可选ArtifectPositioningStepItem[] | ArtifectPositioningStepCell[] | |
nextCursor可选string | null | |
deadline必填string |
ArtifectPositioningStepItem2
One sourced or placed item the waiting step produced (the SOURCE/PLACE review).
resultType可选string | |
item必填ItemRead |
ArtifectProductImagesCreate2
Create one product-image set from photos already uploaded through the image artifect.
kind可选string | |
request必填CreateImageSet |
ArtifectProductImagesDetail3
Carry the board's EXPORTS view and ephemeral links for its newest export.
kind可选string | |
exports可选ExportSet[] | |
newestUrls可选HostedImage[] |
ArtifectProductImagesDetailQuery2
Ask one image set one detail view.
kind可选string | |
view必填ProductImagesDetailView |
ArtifectProductImagesEdit3
Edit or quote one board using the image contract's own action batch.
adjustmentType可选string | |
actions必填AddDesign[] | RemoveDesign[] | OrderDesigns[] | ResizeDesign[] | SetBackground[] | ApplyTemplate[] | AddLayer[] | RemoveLayers[] | OrderLayer[] | SetBox[] | SetLayerFlags[] | SetText[] | SetTextStyle[] | SetShapeStyle[] | SetShadow[] | GroupLayers[] | UngroupLayer[] | CutOutProduct[] | GenerateScene[] | RestoreRevision[] | SetObjectFrame[] | SetObjectLock[] | CreateVariants[] | SetVariantRecipe[] | DetachVariant[] | AddPlan[] | SetPlan[] | GenerateFromPlan[] | PlaceBrandKit[] | SetImageTransform[] | GenerateDecor[] | SetBoardTitle[] | |
dryRun可选boolean |
ArtifectProductImagesExport3
Export one revision of an image set (head when revision is None).
adjustmentType可选string | |
revision可选integer | null | |
options可选ExportOptions |
ArtifectProductImagesQuote2
The no-write quote returned only by a product-images dry-run adjustment.
object可选string | |
quote必填BatchQuote |
ArtifectProductImagesSnapshot2
Expose the image contract's canonical multi-object board outline.
kind可选string | |
outline必填DocumentOutline |
ArtifectRecheckHint2
Tell the agent which snapshot parts moved and how to recheck them.
partKeys必填string[] | Affected snapshot parts using the owning kind's existing stable keys, converted by its adapter. Never displayed. |
message必填string | Owner-authored, number-free recheck sentence shown to the reader. |
ArtifectRef2
Identify one durable Artifect instance by its opaque public id.
object可选string | |
id必填string |
ArtifectRejectionReason可选值 · 11
Why an answer or adjustment was refused with state left unchanged.
ArtifectReportCreate12
Carry the complete V3 report premise accepted by the runtime.
kind可选string | |
replayKey必填string | |
asin必填string | |
amazonMarketplace必填AmazonMarketplace | |
keywords可选string[] | Discovery keywords; suggest keywords, the seller confirms; at least one nonblank keyword with categoryId skips REPORT_SCOPE; otherwise the run parks on REPORT_SCOPE to ask. |
categoryId可选integer | null | Confirmed Amazon category; with at least one nonblank keyword it skips REPORT_SCOPE. |
title可选string | null | |
image可选string | null | |
language可选Language | null | |
similarProductsLimit可选integer | null | How many comparable products to analyse; None keeps the runtime's website-aligned default. |
economicSetup可选ReportProfileEconomicFields | null | The seller's economic setup in the report package's own field names (ACOS band, fixed size/weight, entry-budget threshold). Its suggestedPurchasingCost is refused when purchaseCost is sent, so the seller's cost has ONE create source; a later PROFILE_INPUTS edit changes the benchmark, never a PROFIT_INPUTS override of the analysed product. |
purchaseCost必填ArtifectReportUserPurchaseCost | ArtifectReportSystemEstimatedPurchaseCost | Required seller-confirmed cost: show Keble's estimate as a suggestion, confirm the cost (single or range) with the seller before creating; later changes to the seller's own cost go through PROFILE_INPUTS and re-price every product; competitors' costs can be changed one by one or as a set through PROFIT_INPUTS. |
ArtifectReportDetail2
Carry the report package's own typed detail answer.
ArtifectReportDetailQuery2
Wrap the REPORT package's own detail query for one report artifect.
kind可选string | |
query必填ReportOverviewQuery | ReportListingsQuery | ReportListingQuery | ReportSectionQuery | ReportEvidenceQuery | ReportJudgmentQuery |
ArtifectReportScopeInputPage10
Input page for REPORT_SCOPE: the offered category candidates.
object可选string | |
inputKey必填string | |
ownerRevision必填integer | |
instructions必填string | |
items可选ReportScopeCandidate[] | |
coveredItemCount必填integer | |
itemCount必填integer | |
nextCursor可选string | null | |
deadline必填string | |
decisionType可选string |
ArtifectReportSnapshot2
Expose one immutable progressive REPORT snapshot from report CRUD.
kind可选string | |
payload必填ProgressiveReportSnapshot |
ArtifectReportSystemEstimatedPurchaseCost2
Carry the seller's explicit agreement to let Keble estimate the cost.
source可选string | |
sellerAgreed必填boolean | The seller agreed to use Keble's estimate; must be true. A create never assumes this agreement. |
ArtifectReportUserPurchaseCost3
Carry the seller's own purchasing cost, as one value or a low/high range.
source可选string | |
value必填MinorUnitMoney | The seller's own per-unit purchasing cost. |
upperBound可选MinorUnitMoney | null | Range upper bound; omit it for a single value. When present it must use the same currency as value and be >= value. |
ArtifectRunItem11
One run the caller's owner started, from any starter (web, agent, MCP).
ref必填ArtifectRef | |
kind必填ArtifectKind | |
stage必填TaskStage | |
failureType可选TaskExceptionType | null | Task failure class, set only while the run has failed. |
failureCode可选string | null | Stable failure refinement code for classification only; user interfaces map it to copy. |
title必填string | null | |
storeId必填string | null | |
anchorDay必填string | null | |
createdAt必填string | |
completedAt可选string | null | When the run's task reached SUCCESS or FAILURE (its success_ts/failure_ts); null otherwise. |
changeListStage可选ChangeListStage | null |
ArtifectRunList3
One newest-first page; next_before is set only when an older run exists.
object可选string | |
runs必填ArtifectRunItem[] | |
nextBefore可选string | null |
ArtifectRunsRequest4
Which of the caller's own Artifect runs to list, newest first.
kind可选ArtifectKind | null | |
storeId可选string | null | |
limit可选integer | |
before可选string | null |
ArtifectSampleRelevanceInputPage10
Input page for SAMPLE_RELEVANCE: one page of frozen candidates.
object可选string | |
inputKey必填string | |
ownerRevision必填integer | |
instructions必填string | |
items可选SampleRelevanceItem[] | |
coveredItemCount必填integer | |
itemCount必填integer | |
nextCursor可选string | null | |
deadline必填string | |
decisionType可选string |
ArtifectShopifyBlogPostsCreate2
Create one guided Shopify blog post set from the kind's own BlogCreate.
kind可选string | |
request必填BlogCreate |
ArtifectShopifyBlogPostsDecisionType可选值 · 1
The one blog-posts answer family: the parked guided step's answer.
ArtifectShopifyBlogPostsEdits2
Edit a READY blog post set before create-all: replace or drop posts.
adjustmentType可选string | |
edits必填ReplacePost[] | DropPost[] |
ArtifectShopifyBlogPostsPropose1
File create-all for the READY post set at the envelope's base_revision.
adjustmentType可选string |
ArtifectShopifyBlogPostsProposeRevert1
File revert-all of the applied create-all's still-live articles at base_revision.
adjustmentType可选string |
ArtifectShopifyBlogPostsSnapshot2
Carry the blog-posts kind's revisioned BlogSnapshot under its kind tag, minus its staged batch.
kind可选string | |
snapshot必填BlogSnapshot |
ArtifectShopifyBlogPostsStepDecision2
Answer the parked guided blog step with that step's own answer model.
decisionType可选string | |
answer必填BlogDirection | PostPlan | StyleExamples | PostDraft | PostSelfReview | SampleConfirmation |
ArtifectShopifyBlogPostsStepInputPage11
Input page of the parked guided blog step: its guidance and the posts still uncovered.
object可选string | |
inputKey必填string | |
ownerRevision必填integer | |
instructions必填string | |
items可选PlannedPost[] | |
coveredItemCount必填integer | |
itemCount必填integer | |
nextCursor可选string | null | |
deadline必填string | |
decisionType可选string | |
step必填BlogStep |
ArtifectShopifyProductCreate2
Create one unpublished Shopify product draft from the kind's ProductCreateRequest.
kind可选string | |
request必填ProductCreateRequest |
ArtifectShopifyProductEdit2
Replace a Shopify product draft's whole content (pane or agent edit).
adjustmentType可选string | |
content必填ProductContent |
ArtifectShopifyProductPropose1
File the draft's one product.create at the envelope's base_revision.
adjustmentType可选string |
ArtifectShopifyProductProposeRevert1
File one product.delete for the run's single live product, at base_revision.
adjustmentType可选string |
ArtifectShopifyProductSnapshot2
Carry the product kind's revisioned ProductSnapshot under its kind tag, minus its staged batch.
kind可选string | |
snapshot必填ProductSnapshot |
ArtifectShopifyThemeCreate2
Create one Shopify theme document workspace from the theme contract's document request.
kind可选string | |
request必填ThemeDocumentCreateRequest | Start one theme workspace on a connected store: pages are edited as Keble sections and settings, previewed on an unpublished copy of the theme and then published; the theme's own files are never edited. Use this kind, not raw elta_propose shopify.admin.theme_file writes, to add or change sections on a store page. Omit targetThemeId to target the live theme; a targetThemeId the store does not have is refused with the store's themes (name, role, id). Previewing and publishing need theme edits turned on for the store ("Edit themes" under Connectors › store › Allow Keble to change; elta_store_capabilities shows it as shopify.admin.themes): check it before drafting and ask the person to turn it on if it is off. Cancel does not close or discard a workspace: it stays open and nothing is published; DISCARD_PREVIEW removes the preview copy. A stale base revision is REVISION_CONFLICT; other refusals carry kindCode: RUN_NOT_FOUND (No such theme run for this account; list the runs to find it.); WRONG_RUN_KIND (Use the commands of this run's kind; read its snapshot first.); STORE_NOT_FOUND (Connect the store first, then create the run.); TARGET_NOT_IN_STORE (Pick one of the store's themes as the target.); REPLAY_KEY_REUSED (Use a new replay key for a different create request.); UNKNOWN_REVISION (Name a revision this run has.); UNKNOWN_PAGE (Add the page for that template first.); UNKNOWN_SECTION (Use a section key from the snapshot.); UNKNOWN_BLOCK (Use a block key of that section from the snapshot.); UNKNOWN_SECTION_KIND (Use one of the library's section kinds.); UNKNOWN_SETTING (Use a setting declared for that section or block kind.); SETTING_OUT_OF_BOUNDS (Keep the value within the setting's type and bounds.); DUPLICATE_KEY (Choose a template, section key or block key not used yet.); BLOCK_NOT_ALLOWED (That section kind takes no blocks of this kind.); TOO_MANY_BLOCKS (Remove a block before adding another.); ANCHOR_NOT_FOUND (Place the section after an entry the page still has.); TEMPLATE_NOT_PLACEABLE (Place sections only on the theme's existing page templates.); THEME_LIBRARY_FULL (The store already holds 20 themes, Shopify's maximum; delete an unused theme in Shopify Admin.); THEME_PROCESSING (Shopify is still creating the preview copy; update the preview again shortly.); PREVIEW_COPY_UNKNOWN (The preview copy may exist; find it in Shopify Admin by its name and remove it.); NO_PREVIEW_COPY (There is no preview copy yet; UPDATE_PREVIEW makes one.); PREVIEW_NOT_READY (Update the preview and wait until the copy shows this revision.); PROPOSAL_PENDING (A request for this step is still applying; retry shortly.); BASE_CHANGED (The theme changed since it was read; publish again to re-merge.); NOTHING_TO_PROPOSE (The theme already shows this version; there is nothing to change.); PREVIEW_REJECTED (A write was refused before filing, so nothing was filed; resolve its reason (FAMILY_OFF: turn on theme edits for the store), then repeat the step.) |
ArtifectShopifyThemeDetail3
Legacy change-set runs only: carry the run's typed change-set detail unchanged.
kind可选string | |
changeSet必填ThemeChangeSet | |
proposalStates可选ThemeProposalStateRead[] |
ArtifectShopifyThemeDetailQuery2
Legacy change-set runs only: address one change set of the run for a detail read.
kind可选string | |
changeSetId必填string |
ArtifectShopifyThemeDiscardPreview1
File the delete of the run's one preview copy (explicit only; abandonment never discards).
adjustmentType可选string |
ArtifectShopifyThemeDocumentDetail3
Carry one detail answer of a theme DOCUMENT run (the report/positioning nested-answer pattern).
kind可选string | |
runKind可选string | |
answer必填ArtifectShopifyThemeRevisionAnswer | ArtifectShopifyThemeTemplatesAnswer | ArtifectShopifyThemeTemplateOutlineAnswer |
ArtifectShopifyThemeDocumentQuery3
Address one detail view of a theme DOCUMENT run (the report/positioning nested-query pattern).
kind可选string | |
runKind必填string | |
query必填ArtifectShopifyThemeRevisionQuery | ArtifectShopifyThemeTemplatesQuery | ArtifectShopifyThemeTemplateOutlineQuery |
ArtifectShopifyThemeDocumentSnapshot4
Expose a theme DOCUMENT run's snapshot: the theme contract's document snapshot plus live states.
kind可选string | |
runKind可选string | |
snapshot必填ThemeDocumentSnapshot | |
proposalStates可选ThemeDocumentProposalStateRead[] |
ArtifectShopifyThemeEdit2
Edit one theme document: the theme contract's own typed page actions, applied as one batch.
adjustmentType可选string | |
actions必填AddPage[] | AddSection[] | MoveSection[] | RemoveSection[] | SetSettings[] | AddBlock[] | MoveBlock[] | RemoveBlock[] | ShopifyThemeRestoreRevision[] | Typed page edits committed together as the next revision, or not at all. Pages are JSON templates (INDEX, PRODUCT, COLLECTION, PAGE, BLOG, ARTICLE); a new Keble landing page uses PAGE with a keble- suffix. Section kinds and settings (type, bound): HERO_BANNER: heading TEXT max 120, subheading TEXT max 250, image IMAGE_URL max 2048, button_label TEXT max 40, button_link URL max 2048, alignment SELECT left|center|right, overlay_opacity RANGE 0-90 step 10, text_color COLOR #rrggbb | RICH_TEXT: heading TEXT max 120, text RICHTEXT max 5000 (plain text, no HTML; a blank line starts a paragraph), alignment SELECT left|center|right, text_color COLOR #rrggbb | IMAGE_WITH_TEXT: image IMAGE_URL max 2048, image_position SELECT left|right, heading TEXT max 120, text RICHTEXT max 2000 (plain text, no HTML; a blank line starts a paragraph), button_label TEXT max 40, button_link URL max 2048, text_color COLOR #rrggbb | FAQ: heading TEXT max 120, text_color COLOR #rrggbb; blocks QUESTION up to 20 (question TEXT max 250, answer RICHTEXT max 2000 (plain text, no HTML; a blank line starts a paragraph)) | FEATURE_LIST: heading TEXT max 120, columns RANGE 2-4 step 1, text_color COLOR #rrggbb; blocks FEATURE up to 12 (title TEXT max 80, text RICHTEXT max 500 (plain text, no HTML; a blank line starts a paragraph), image IMAGE_URL max 2048). Section keys start with keble- and are unique in the document; unset settings inherit the theme, and a null setting value unsets it again. after names the template entry a section follows (entry ids from the TEMPLATE_OUTLINE detail view): "@start" places it first, omitting after places it last. RESTORE_REVISION is the only action of its batch. A page must be in the document before its sections: send ADD_PAGE for the template first, in the same batch or an earlier one (INDEX uses previewPath "/"). |
ArtifectShopifyThemeProposeDiscard2
Legacy change-set runs only: propose deleting one rejected change set's ELTA-created preview copy.
adjustmentType可选string | |
changeSetId必填string |
ArtifectShopifyThemeProposeRevert2
Legacy change-set runs only: propose ELTA's undo of one accepted change set.
adjustmentType可选string | |
changeSetId必填string |
ArtifectShopifyThemePublish2
File one publish of a document revision onto the run's target theme.
adjustmentType可选string | |
revision可选integer | null | The revision to publish to the target theme; null publishes the head revision, resolved before filing. Publishing applies to the store now. To undo, publish the previously published revision (revision 0 is the empty starting version, so publishing it undoes a first publish): it removes only Keble's placement, so the page is restored and Keble section files stay in the theme, unused. A publish also deletes the preview copy when the copy holds the published revision. While one publish applies, publishing another revision is refused PROPOSAL_PENDING (publishing the same revision again answers the pending publish); NOTHING_TO_PROPOSE means the theme already shows that revision. |
ArtifectShopifyThemeQuery以下之一 · 2
ArtifectShopifyThemeRevisionAnswer2
Answer the REVISION view: one committed revision of a theme DOCUMENT run, unchanged.
view可选string | |
revision必填ThemeRevision |
ArtifectShopifyThemeRevisionQuery2
Ask a theme DOCUMENT run for one committed revision (the REVISION(n) view).
view可选string | |
revision必填integer |
ArtifectShopifyThemeRunDetail以下之一 · 2
ArtifectShopifyThemeRunSnapshot以下之一 · 2
ArtifectShopifyThemeSnapshot4
Legacy change-set runs only: the run's snapshot, its create ledger beside the target theme.
kind可选string | |
ledger必填ThemeCreateLedger | |
targetTheme可选ThemeRef | null | |
proposalStates可选ThemeProposalStateRead[] |
ArtifectShopifyThemeTemplateOutlineAnswer3
Answer the TEMPLATE_OUTLINE view: one template's merchant entries in order (this run's excluded).
view可选string | |
source必填ThemeFrameSource | |
outline必填ThemeTemplateOutline |
ArtifectShopifyThemeTemplateOutlineQuery3
Ask a theme DOCUMENT run for one template's merchant entries in order (the locked tree, anchors).
view可选string | |
template必填ThemeTemplateRef | |
source可选ThemeFrameSource |
ArtifectShopifyThemeTemplatesAnswer3
Answer the TEMPLATES view: the placeable JSON page templates the read theme has now.
view可选string | |
source必填ThemeFrameSource | |
templates可选ThemeTemplateRef[] |
ArtifectShopifyThemeTemplatesQuery2
Ask a theme DOCUMENT run which JSON page templates its target (or copy) has now (the page picker).
view可选string | |
source可选ThemeFrameSource |
ArtifectShopifyThemeUpdatePreview1
File one step toward the run's preview copy holding the head revision; it waits in To do for a person.
adjustmentType可选string |
ArtifectSnapshot4
Expose one immutable domain snapshot and optional ephemeral image parts.
ArtifectSnapshotRequest3
Which run, which immutable revision (None is the head) and which board objects to focus.
ref必填ArtifectRef | |
revision可选integer | null | |
focus可选string[] |
ArtifectStanding6
The long-lived part of one status (ArtifectStatus.standing); set exactly for STANDING kinds.
state必填StandingState | |
pausedBy必填StandingPauseBy | null | |
pause必填ArtifectStandingPause | null | |
nextRunAt必填string | null | |
openOccurrence必填ArtifectStandingOccurrence | null | |
lastOccurrence必填ArtifectStandingOccurrence | null |
ArtifectStandingOccurrence2
One occurrence of a standing run as its status shows it: its sequence and where it is.
seq必填integer | |
state必填ArtifectOccurrenceState |
ArtifectStandingPause2
The stored cause of a standing run's pause by core's gate or by its kind.
code必填string | null | |
message必填string |
ArtifectStandoutInputPage10
Input page for STANDOUT_SELECTION: the built cohort to choose from.
object可选string | |
inputKey必填string | |
ownerRevision必填integer | |
instructions必填string | |
items可选StandoutItem[] | |
coveredItemCount必填integer | |
itemCount必填integer | |
nextCursor可选string | null | |
deadline必填string | |
decisionType可选string |
ArtifectStatus14
Report the lifecycle projection of one Artifect instance.
object可选string | |
ref必填ArtifectRef | |
kind必填ArtifectKind | |
stage必填TaskStage | |
revision必填integer | |
pendingInput必填ArtifectPendingInput | null | |
snapshotRef必填string | null | |
updatedAt必填string | |
failureCode可选string | null | Stable failure refinement code while failed, when available. |
failureReason可选string | null | Host-authored failure sentence, set only while stage is FAILURE. |
failureType可选TaskExceptionType | null | keble-task failure class, set only while stage is FAILURE. |
latestAdjustment可选ArtifectAdjustmentStatus | null | Latest admitted adjustment's own execution state, or None when the Artifect has never been adjusted. |
standing可选ArtifectStanding | null | Standing state of a long-lived (STANDING) artifect: its state, who paused it and why, its next run, and its open and last occurrence. A STANDING artifect reads SUCCESS once set up; never wait for it to finish. Absent for every other kind. |
changeListStage可选ChangeListStage | null |
Assess5
Ask the model to judge cells against assessments or criteria (today's criterion and retry).
type可选string | |
actionKey必填string | |
assessments必填string[] | |
cellKeys可选string[] | null | |
missingOnly可选boolean |
AssessmentDetailValue4
An ASSESSMENT detail row: one stored judgement for the cell.
object可选string | |
kind可选string | |
key必填string | |
assessment可选AssessmentResult | null |
AssessmentDisplay可选值 · 2
How an assessment row is drawn; the frontend owns the visuals.
AssessmentKind可选值 · 2
What a model returns for one cell: numeric ranges, or yes/no with reasoning.
AssessmentResult5
One judgement of one cell: ranges or a flag, with reasoning and references.
status必填ValueStatus | |
ranges可选RangeValue[] | |
flag可选boolean | null | |
reasoning可选string | |
references可选SourceReference[] |
AssessmentRow3
A detail row showing one assessment: ranges or flag, its reasoning and references.
kind可选string | |
assessment必填string | |
display可选AssessmentDisplay |
AssetOrigin可选值 · 5
How an asset came to exist (provenance; the fidelity law and check read it).
AssetRef6
An immutable, content-addressed image owned by one owner (bytes in object storage).
assetId必填string | |
mediaType必填ImageMediaType | |
size必填PixelSize | |
byteCount必填integer | |
origin必填AssetOrigin | |
contentBox可选Box | null |
Attribute2
One declared text column: an identity part, a dimension, or an account attribute.
key必填string | Text-column identifier; fact queries use its declared row path. |
title必填StoreLocalizedText | Display name of the column, in both languages. |
AttributeChange7
One identity-part or dim text value changed; an absent side is None, never empty text.
entity必填string | Stored entity key of the row that changed. |
observedAt必填string | Instant the new value became readable. |
captureId必填string | The capture that made the new value readable. |
kind可选string | Discriminator marking this as an attribute change. |
attributeKey必填string | The declared attribute whose value changed. |
oldValue可选string | null | The value before the change; none when there was none. |
newValue可选string | null | The value after the change; none when it was removed. |
AttributeMatch2
One declared attribute restricted to allowed values: a facts-request view selection.
attributeKey必填string | The declared family attribute this selection restricts. |
values必填string[] | Values to match; at least one non-empty value. |
Availability可选值 · 3
What is held for one account x family x day.
BackgroundField2
Override value: the variant canvas background.
field可选string | |
background必填Color | BrandColorRef |
BandedDimension2
A dimension core computes by cutting one numeric fact into bands.
fact必填string | |
label必填LocalizedText |
BatchQuote4
What a batch would add and cost: a dry run of the same check and apply code, with no writes.
newObjects必填integer | |
paid可选OperationQuote[] | |
estSeconds必填integer | |
refusal可选EditRefusal | null |
BlendField2
Override value: a layer's blend mode (how its pixels mix with what is under it).
field可选string | |
blendMode必填BlendMode |
BlendMode可选值 · 6
How a layer mixes with pixels under it inside the same image.
BlockedLane4
One blocked account x dataset lane as served: what is blocked, why, since when.
account必填AccountRef | The provider account whose lane is blocked. |
datasetKey必填string | The dataset whose lane is blocked. |
issue必填ProviderIssue | The typed reason the lane is blocked. |
since必填string | When the lane became blocked. |
BlogCreate3
Create one guided post set pinned to one ELTA store; the blog is chosen at DIRECTION.
replayKey必填string | |
storeId必填string | |
brief必填string |
BlogDirection5
DIRECTION (1.1): what the posts are for and how the set is structured, agreed with the seller.
step可选string | |
blogId必填string | |
audience必填string | |
goal必填string | |
structure必填string |
BlogSnapshot9
The owner-visible post set at one revision, with its latest screen result and every filing.
artifectRef必填ArtifectRef | |
storeId必填string | |
account必填AccountRef | |
revision必填integer | |
postSet必填PostSet | |
screening可选ScreeningResult | null | |
proposals可选ProposalFiling[] | |
filingIntent可选StagedProposal | null | |
approvals可选ApprovalState[] |
BlogStep可选值 · 6
The guided steps the agent is parked on, in order (owner 1.1-1.6).
BoardObjectKind可选值 · 3
The board object kinds (discriminator of BoardObject).
BoardPoint2
Top-left of an object on the board, in board pixels (1 board px = 1 design px at zoom 1).
x必填number | |
y必填number |
Box5
A layer's placement in canvas pixels; rotation in degrees around the box centre.
x必填number | |
y必填number | |
width必填number | |
height必填number | |
rotation可选number |
Brand4
A DP-derived brand label and its existing product count.
kind可选string | Node discriminator; always BRAND. |
key必填string | The brand's own analyzed key, which is its identity. |
name必填string | Brand display name. |
productCount必填integer | Number of products carrying this brand; 0 for a brand known only from mentions. |
BrandClause2
Filter a Product-like result by one or more explicit brand values.
kind可选string | |
values必填string[] |
BrandColorRef3
A colour that follows one kit entry. Swapping kits never re-points it (owner: any number of colours).
ref可选string | |
kitId必填string | |
entryId必填string |
BrandCorpusRef3
The frozen brand list one result was decided against, with its disclosed coverage.
version必填string | |
sha256必填string | |
coverageDisclosure必填string |
BrandFontRef3
A font family that follows one kit font entry; the weight stays on the layer.
ref可选string | |
kitId必填string | |
entryId必填string |
BrandKit9
One owner-level kit as the backend serves it (read-only to product-images).
kitId必填string | |
name必填string | |
tagline可选string | null | |
handle可选string | null | |
version必填integer | |
colors可选KitColor[] | |
fonts可选KitFont[] | |
archivedAt可选string | null | |
updatedAt必填string |
Cancel2
Drop queued work; an unfinished run ends ABANDONED.
type可选string | |
actionKey必填string |
CapabilityRow7
One installed lookup, action or dataset, with what this store can do right now.
key必填string | Key of the lookup, action or dataset this row describes. |
sourceKey必填string | Installed source that declares this item. |
accountId必填string | null | Stored account this row applies to; null exactly when state is NOT_CONNECTED. |
state必填CapabilityState | What this item can do now. |
issue可选ProviderIssue | null | Known typed issue behind this state, if any. |
familyKey可选string | null | Write family of an action row; null for a lookup or dataset. |
blocked可选BlockedLane[] | Blocked lanes of a dataset row; empty for a lookup or action. |
CapabilityState可选值 · 8
Whether one lookup, action or dataset of a store can be used now, and what blocks it.
CaptureStyle以下之一 · 3
CatalogAvailability可选值 · 3
Whether a source or published analyzed rows can answer a cell.
CatalogCellView11
One channel and kind's public capability cell.
object必填string | Public object discriminator. |
channel必填Channel | Channel represented by the cell. |
recordKind必填AnalyzedRecordKind | Record family represented. |
nodeKind必填NodeKind | null | Node family, or null when the cell names no node kind. |
availability必填CatalogAvailability | Whether an active source or published rows serve this cell. |
requiresMarket可选boolean | Every active source for this channel and kind requires a market; false until a source declares it, never inferred from rows or markets. |
acceptsWindow可选boolean | Published rows of this kind have a windowed metric or feature binding. |
markets可选string[] | Markets declared by active sources for this channel and kind; empty means market-agnostic. |
fields必填ColumnSpec[] | Authorized public columns. |
textFields可选string[] | Searchable text fields a field-less text clause reads; empty when the kind serves none. |
seedCallBounds可选SeedCallBound[] | Declared physical source calls per seed subject per page and page ceiling, per exact-seed selector; empty means unknown. |
CatalogEdgeView7
One public catalog edge: an enabled topology hop a caller may use.
object必填string | Public object discriminator. |
edgeId必填string | Stable topology edge id. |
fromKind必填NodeKind | Source node family of the hop. |
toKind必填NodeKind | Target node family of the hop. |
analyzed可选boolean | null | Whether this edge has a stored leg; null means unknown. |
live可选boolean | null | Whether this edge has a live leg; null means unknown. |
relation可选AnalyzedRelationKind | null | Analyzed relationship followed by this edge; null for edges without a relation. |
CatalogPairView8
One public catalog pair: a start-to-result walk this channel admits.
object必填string | Public object discriminator. |
channel必填Channel | Channel this pair walks on. |
fromKind必填NodeKind | Start node family of the pair. |
toKind必填NodeKind | Result node family of the pair. |
peers可选PeerIntent | null | Peer intent of a same-kind pair; null means identity or a plain conversion. |
analyzed必填boolean | The planner admits this pair with an analyzed leg on every hop; not a stored-row guarantee. |
live必填boolean | A live source read admits this pair in its mode. |
routes必填string[][] | Ordered edge-id routes the planner admits, each hop an enabled edge id. |
CategoryClause3
THE category carrier: filter by category values or provider category keys.
kind可选string | |
values必填string[] | |
op可选string |
Cell6
One cell of one dimension combination, computed when read.
cellKey必填string | |
options必填object | |
groupKeys必填string[] | |
itemCount必填integer | |
measures必填object | |
results必填object |
CellDetail4
The dialog for one clicked cell: the view's criterion first (if any), then declared sections.
cell必填RoomCell | |
criterion可选AssessmentResult | null | |
sections必填DetailSectionRead[] | |
decisionPick可选DecisionPick | null |
CellScore4
One scored cell: 0-100 score, tier 0-9, and each factor's percentile.
cellKey必填string | |
score必填integer | |
tier必填integer | |
percentiles必填object |
ChangeCapture1
A dataset read as one continuous lane over the source's own update time.
kind可选string | Capture style: changes since the previous sync. |
ChangeFieldTitle2
Human title of one top-level field of an action's change, declared by the plugin.
field必填string | Top-level change field this title names. |
title必填StoreLocalizedText | Bilingual display name of that change field. |
ChangeList13
The persisted, revisioned list of one artifect with a frozen ELTA target.
kind必填ArtifectKind | |
storeId必填string | Keble identity that fences the owner and drives display. |
account必填AccountRef | ELTA AccountRef resolved once at create; edits cannot retarget it. |
revision必填integer | |
revisedAt必填string | |
rows必填ChangeRow[] | |
privateValues可选PrivateValue[] | |
previewedAt可选string | null | |
commandReceipts可选CommandReceipt[] | |
filed可选FiledBatch[] | |
reverts可选FiledBatch[] | |
filingIntent可选FilingIntent | null | |
withdrawn可选FiledBatch[] |
ChangeListCreatePremise4
The replayable create body shared by change-list kinds, with an optional account selector.
replayKey必填string | |
storeId必填string | Keble identity that fences the owner and drives display. |
accountId可选string | null | |
rows必填NewChangeRow[] |
ChangeListSnapshot10
What read returns: the public list, screening result, stage and guide.
ref必填ArtifectRef | |
changeList必填ChangeList | |
screening必填ScreeningResult | null | |
kindProblems可选KindRuleProblem[] | |
stage必填ChangeListStage | |
guide必填StageGuide | |
rowStages必填ChangeRowStageView[] | |
approvals可选ApprovalState[] | |
reverts可选ApprovalState[] | |
leafRules可选LeafRule[] |
ChangeListStage可选值 · 4
The derived stage of a row, and the aggregate used by the kind's guide.
ChangeRow6
One proposed write: a bound ELTA action, its rationale and local inclusion state.
rowKey必填string | |
action必填ProviderAction | |
rationale必填string | |
status可选ChangeRowStatus | |
origin必填ChangeRowOrigin | |
preview可选RowPreview | null |
ChangeRowOrigin可选值 · 2
Who wrote a row first; set once by the engine and kept through every edit.
ChangeRowStageView3
One row's stage and its live approval join, without duplicating approval state.
rowKey必填string | |
stage必填ChangeListStage | |
inboxItemId必填string | null |
ChangeRowStatus可选值 · 2
Whether the person keeps a row in the next proposal. Apply/revert state is ELTA's, never here.
ChangesRequest9
A serving read of derived fact changes for one owner: the fact read's own selection.
familyKey必填string | The fact family to read. |
days必填DayRange | Inclusive reporting days in the account's timezone. |
storeIds可选string[] | Stores to include; empty selects the asserted owner's stores. |
accountIds可选string[] | Accounts to read; empty means every account of the owner. |
entities可选string[] | Stored entity keys to read; empty means every entity. |
attributes可选AttributeMatch[] | View selections that restrict which rows are returned. |
asOf可选string | null | Instant to read as of; set this or capture_id, never both. |
captureId可选string | null | Committed capture to read as of; set this or as_of, never both. |
page可选PageRequest | Row limit and cursor for this read. |
Channel可选值 · 7
Identify a source channel without exposing its provider implementation.
ChargeRefusalCode可选值 · 1
Why the money owner refused one paid step, when the payer can act on it (0.6.0).
ClaimEmotion可选值 · 5
How the item feels about the claimed entity, on a 5-level scale.
ClaimStance可选值 · 4
The stance one claim's supporting text shows toward the entity.
ClarificationAnswer2
The console's reply to one CLARIFY: the stored partial query the choice binds into, and the choice itself.
queryKey必填string | Key of the stored partial query this choice binds into. |
choice必填string | The caller's chosen answer among the offered choices. |
Classify4
Ask the model to place groups into the named dimensions (all relevant groups when None).
type可选string | |
actionKey必填string | |
dimensionKeys必填string[] | |
itemKeys可选string[] | null |
Color1
An sRGB colour with alpha, stored as #rrggbbaa.
hex必填string |
ColorRemap2
Replace one authored colour value (hex or kit ref) with another, by exact match, before kit lookup.
source必填Color | BrandColorRef | |
target必填Color | BrandColorRef |
ColumnSpec4
One public result column: its field code, scalar type and, for a money cell, its unit and the column carrying the paired currency.
name必填string | Field code of this result column. |
valueType必填string | Scalar type the column's values carry; DECIMAL is a major-unit number carried as a JSON string. |
unit可选MetricUnit | null | Metric unit of the cell's values; null when the column declares none. |
currencyColumn可选string | null | Sibling column carrying the currency; set iff unit is MONEY. |
Combine以下之一 · 3
CommandReceipt3
Record one successful caller command for bounded replay and conflict detection.
replayKey必填string | |
bodySha256必填string | |
revision必填integer |
Comment9
Represent one comment nested beneath its Content item.
externalId必填string | |
parentExternalId可选string | null | |
authorName可选string | null | |
authorHandle可选string | null | |
authorRef可选SourceSubject | null | |
body可选string | null | |
publishedAt可选string | null | |
depth可选integer | |
metrics可选MetricObservation[] |
ComposedPost7
One post as the composer edits and renders it: title, featured image, ordered blocks, metadata.
title必填string | |
handleStem必填string | |
featuredImage可选ExistingShopifyFile | ShopifyRemoteImage | PostExportedImage | null | |
blocks必填HeadingBlock[] | ParagraphBlock[] | ListBlock[] | ImageBlock[] | QuoteBlock[] | |
summary可选string | null | |
tags可选string[] | |
author必填string |
Concept6
An extracted concept attached to one scoped source record.
kind可选string | Node discriminator; always CONCEPT. |
conceptKind必填ConceptKind | Which kind of concept this is. |
key必填string | Per-item concept identity, 'revision:label'. |
label必填string | Normalized label text of the concept. |
subjectRefs必填NodeRef[] | Scoped references to the source records this concept was extracted from. |
itemCount必填integer | Number of source items carrying this concept. |
ConceptKind可选值 · 14
Concept records the extract capability yields, in two families.
ConceptRef2
ONE CONCEPT A RECORD WAS FOUND TO BE ABOUT: the label the extract capability normalized, TOGETHER WITH which kind of concept it is.
label必填string | Normalized label of the concept. |
kind必填ConceptKind | Which kind of concept the label names. |
ConclusionDetailValue5
A CONCLUSION detail row: the cell's status and, when a signal is raised, its prose.
object可选string | |
kind可选string | |
key必填string | |
conclusion必填ConclusionStatus | |
assessment可选AssessmentResult | null |
ConclusionRow2
The cell's tinted conclusion: the first raised signal wins, else NEUTRAL.
kind可选string | |
signals必填ConclusionSignal[] |
ConclusionSignal2
One FLAG assessment that, when raised, sets the conclusion's tone.
assessment必填string | |
tone必填Tone |
ConclusionStatus可选值 · 4
A cell's conclusion (today's detail status values).
ConnectStyle可选值 · 2
How an owner binds a source: a consent redirect, or credentials they enter.
ConnectionRecord15
One owner's grant for one plugin source, and the accounts it reaches.
object可选string | Document type: connector record. |
connectionId必填string | Connector identifier within the asserted owner scope. |
storeId必填string | Store this connector belongs to. |
sourceKey必填string | Catalog source authorized by this connector. |
status必填ConnectionStatus | Current authorization state. |
accounts可选DiscoveredAccount[] | Accounts reached by this connector. |
regions可选ProviderRegion[] | Sales regions reached by the discovered accounts. |
boundAt必填string | When the connector was first bound. |
consentedAt可选string | null | Latest successful consent instant; null when no consent was recorded. |
lastSyncedAt可选string | null | When this connection last synced successfully. |
syncedThrough可选string | null | Provider data instant this connection synced through. |
boundWith必填ConnectStyle | The way the current grant was bound. |
reconsentDueAt可选string | null | When the owner must renew this connection's grant (rotate an expiring credential, or consent again), if a declared lifetime makes it known; null when nothing expires. |
issue可选ProviderIssue | null | Invalid-access reason requiring renewed consent, if present. |
removing可选boolean | A removal started and has not finished. The record is kept only so the same DELETE can finish it: capture, binding and lifecycle commands refuse it. False for every normal record. |
ConnectionStatus可选值 · 3
Where one bound connection stands.
Contact9
Represent one creator-linked contact record with optional contact facts.
kind可选string | |
channel必填Channel | |
externalId必填string | |
creatorRef必填SourceSubject | |
email可选string | null | |
whatsapp可选string | null | |
instagram可选string | null | |
observedAt必填string | |
provenance必填Provenance |
ContactClause2
The CREATOR result has a stored CONTACT carrying every named contact fact.
kind必填string | |
present必填string[] | CONTACT field codes that must all be present and non-empty on one stored contact of the creator. |
Content24
Represent one published item with typed creator/product references.
kind可选string | |
channel必填Channel | |
externalId必填string | |
contentType必填ContentType | |
title可选string | null | |
body可选string | null | |
hashtags可选string[] | |
creatorRef可选SourceSubject | null | |
creatorName可选string | null | |
creatorHandle可选string | null | |
community可选string | null | |
publishedAt可选string | null | |
metrics可选MetricObservation[] | |
media可选MediaRef[] | |
productRefs可选SourceSubject[] | |
language可选string | null | |
mentionedRefs可选SourceSubject[] | |
sponsorship可选ContentSponsorship | |
market可选string | null | |
textTracks可选SocialTextTrack[] | |
comments可选Comment[] | |
status可选ContentStatus | |
observedAt必填string | |
provenance必填Provenance |
ContentRef5
THE single content-addressed reference. Object key ends in the sha256 — content-addressing holds by construction. Bytes are read only through the owner's bytes protocol, never a storage credential.
store必填StoreOwner | |
objectKey必填string | |
sha256必填string | |
byteCount必填integer | |
mediaType必填string |
ContentSource可选值 · 2
Whether an image owns its canvas or resolves from an OWN parent (discriminator of ImageContent).
ContentSponsorship可选值 · 4
What the platform itself declares about payment for one Content item.
ContentStatus可选值 · 4
Describe whether one Content item remains available.
ContentType可选值 · 4
Describe the provider-neutral presentation form of one Content item.
Continue3
Accept the reviewed step's current result (as edited) and let the run go on.
type可选string | |
actionKey必填string | |
after必填RunStep |
ContinueRequest2
A signed continuation request with an optional per-call row ceiling.
cursor必填string | Opaque signed continuation token. |
maxRows可选integer | null | Optional row ceiling for this call; the next cursor follows the last returned row. Omission preserves the normal page size. |
CostProfile18
Canonical calculator input with currency-aware Money observations.
len1必填number | |
len2必填number | |
len3必填number | |
lenUnit必填string | |
marketplace必填AmazonMarketplace | |
weight必填number | |
weightUnit必填string | |
expectedAdsCostRatio必填number | |
expectedCustomerReturnedRatio可选number | |
expectedPurchasingCost必填MinorUnitMoney | |
expectedAverageDailyInventoryVolume必填integer | |
expectedAverageDailyShippedVolume必填integer | |
isApparel必填boolean | |
isDangerousGoods必填boolean | |
isBattery必填boolean | |
feeCategoryString必填string | |
exchangeRates必填ExchangeRateInUsd[] | |
price必填MinorUnitMoney |
CoverageNote4
ONE disclosed gap in the world the page was computed over . UNLINKED_CLAIMS: claims touching a relation the query used with no accepted edge. UNHYDRATED_ENDPOINTS: linked endpoint records with no stored profile (including key-only stores/categories), not a short page. MISSING_OBSERVATIONS: rows whose metric series has no observation in the resolved window.
kind必填GapKind | Non-empty-cause gap this note discloses. |
count必填integer | Distinct records the gap covers: for MISSING_OBSERVATIONS the searched result-kind records whose series has no observation in the resolved window, in the freshness unit (records, not versions); for UNLINKED_CLAIMS the distinct claims, not result records; for UNHYDRATED_ENDPOINTS the distinct linked endpoint records with no stored profile. |
detail必填string | Plain description of the gap. |
total可选integer | null | Distinct records of the searched kind in scope; absent when the gap has no record population. |
CreateImageSet5
Create an image set from already-uploaded product photos.
replayKey必填string | |
title必填string | |
brief必填ProductBrief | |
presets可选string[] | |
actions可选AddDesign[] | RemoveDesign[] | OrderDesigns[] | ResizeDesign[] | SetBackground[] | ApplyTemplate[] | AddLayer[] | RemoveLayers[] | OrderLayer[] | SetBox[] | SetLayerFlags[] | SetText[] | SetTextStyle[] | SetShapeStyle[] | SetShadow[] | GroupLayers[] | UngroupLayer[] | CutOutProduct[] | GenerateScene[] | RestoreRevision[] | SetObjectFrame[] | SetObjectLock[] | CreateVariants[] | SetVariantRecipe[] | DetachVariant[] | AddPlan[] | SetPlan[] | GenerateFromPlan[] | PlaceBrandKit[] | SetImageTransform[] | GenerateDecor[] | SetBoardTitle[] |
CreateResult3
Stored item and whether the call admitted a new row.
object可选string | |
item必填TodoItem | AlertItem | ApprovalItem | NotificationItem | |
created必填boolean |
CreateVariants3
Create variants of one OWN image; free unless a spec carries a scene prompt (each its own paid step).
action可选string | |
sourceId必填string | |
variants必填VariantSpec[] |
Creator13
Represent one publishing account without inferring a real-world person.
kind可选string | |
channel必填Channel | |
externalId必填string | |
name必填string | |
handle可选string | null | |
biography可选string | null | |
market可选string | null | |
links可选string[] | |
verified可选boolean | null | |
metrics可选MetricObservation[] | |
media可选MediaRef[] | |
observedAt必填string | |
provenance必填Provenance |
CreatorHandleSuggestion2
Prefill a creator handle input; this suggestion never runs a search.
kind可选string | Handle-prefill suggestion discriminator. |
channel必填Channel | Channel of the creator handle to enter. |
Credential8
One piece of grant material the source declares, entered by the owner or returned.
key必填string | Credential field identifier. |
label可选string | null | Label for an owner-entered credential field. |
entered可选boolean | Whether the owner enters this value when connecting. |
secret可选boolean | Whether this value must be hidden when displayed. |
updatable可选boolean | Whether the owner may replace this entered value alone on the held connection. |
required可选boolean | Whether the binding form requires this entered value. |
lifetimeDays可选integer | null | Days after entry the value stops working, when the provider forces a renewal. |
renewHint可选StoreLocalizedText | null | Where the owner gets a new value once this one expires, in both languages. |
CriterionRecord3
A FLAG assessment a person or agent made after create (today's custom mask).
key必填string | |
label必填LocalizedText | |
prompt必填string |
Currency可选值 · 159
Currencies full list: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
CurrencyBasis可选值 · 2
State how a MONEY value's currency is known.
CustomerArtifectCreateResponse以下之一 · 3
Expose an Artifect reference or sanitized Artifect failure.
CustomerArtifectDecisionResponse以下之一 · 4
Expose an Artifect decision status, rejection or sanitized failure.
CustomerArtifectDetailResponse以下之一 · 2
Expose one kind-typed Artifect detail answer or sanitized failure.
CustomerArtifectInputPage以下之一 · 10
CustomerArtifectInputResponse以下之一 · 3
Expose an Artifect input page, a terminal-run rejection or a sanitized failure.
CustomerArtifectPluginListResponse2
Expose the installed positioning plugins in a JSON-object envelope.
object可选string | |
plugins必填RoomPublicDeclaration[] |
CustomerArtifectSnapshotResponse以下之一 · 2
Expose an Artifect snapshot or sanitized failure.
CustomerArtifectStatusResponse以下之一 · 2
Expose an Artifect lifecycle status or sanitized failure.
CustomerDpCatalogResponse以下之一 · 2
Expose the DP catalog or its typed refusal as one customer root schema.
CustomerDpContinueResponse以下之一 · 4
Expose one discriminated DP continuation answer.
CustomerDpFreshnessResponse以下之一 · 2
Expose the DP freshness projection or its typed refusal.
CustomerDpMotifsResponse以下之一 · 3
Expose one DP motif page, its pending variant or a typed refusal.
CustomerDpRecordResponse以下之一 · 2
Expose one DP record detail or its typed refusal.
CustomerDpSearchResponse以下之一 · 6
Expose the full discriminated DP search answer without copying DP fields.
CustomerInboxItemResponse以下之一 · 4
Expose the inbox owner's todo/approval union without copying either item model.
CutOutProduct3
Paid: cut the product out of a PRODUCT layer's photo.
action可选string | |
designId必填string | |
layerId必填string |
Dataset6
One captured dataset, including the visible provider-number parity label.
key必填string | Captured dataset identifier. |
families必填Family[] | Fact families produced by this dataset. |
capture必填CaptureStyle | How this dataset is captured and scheduled. |
backfillDays必填integer | Historical days initially captured within source retention. |
requires可选Permission[] | Permissions needed to capture this dataset. |
unverified可选boolean | Whether equality with source-reported totals remains unverified. |
DateClause4
Bound one launch instant from below or above.
kind可选string | |
field必填string | |
op必填string | |
value必填string |
DateWindow2
Bound one explicit inclusive calendar window for keyword trend reads.
start必填string | |
end必填string |
DayCoverage6
What is held for one account x family x day, and whether it is settled.
account必填AccountRef | The provider account this coverage is for. |
familyKey必填string | The fact family this coverage is for. |
day必填string | The reporting day this coverage is for. |
availability必填Availability | What is held for this account, family and day. |
maturity必填Maturity | Whether the value may still be restated by the source. |
capturedAt可选string | null | Newest capture that confirmed this day; none when unconfirmed. |
DayRange2
Inclusive reporting days in one account's timezone.
startsOn必填string | First reporting day, inclusive. |
endsOn必填string | Last reporting day, inclusive. |
Decide2
Start one decision over the current scorecard (explicit intent; part of the run, never a separate run). The host owns settlement.
type可选string | |
actionKey必填string |
Decider可选值 · 2
Who decides a step's result before the run moves on.
DecisionPick4
One recommended cell with its score, headline and the model's explanation (when written).
cellKey必填string | |
score必填integer | |
title可选string | null | |
prose可选string | null |
DecisionRecord3
The latest decision over the scorecard; headline and prose may be unavailable while picks stand.
decisionId必填string | |
status必填DecisionStatus | |
picks可选DecisionPick[] |
DecisionRefusal可选值 · 3
Why core cannot offer a decision run now (existing wire tokens; the frontend maps copy).
DecisionStatus可选值 · 3
A decision run is one explicit intent; only one runs at a time (existing ruling).
DeleteCriterion3
Delete one criterion and its results; views naming it show no criterion.
type可选string | |
actionKey必填string | |
key必填string |
DeleteDimension3
Delete one dimension and its placements; views naming it fall back to their other axes.
type可选string | |
actionKey必填string | |
dimensionKey必填string |
DeleteView5
Delete one saved view from the viewer's viewport (the first definition cannot be deleted).
type可选string | |
actionKey必填string | |
viewer必填ViewerRef | |
expectedRevision必填integer | |
viewId必填string |
DetachVariant2
Freeze a variant's resolved design into OWN content (kit refs stay refs); it stops following its parent.
action可选string | |
objectId必填string |
DetailSection3
One section of the dialog a person opens by clicking a cell.
key必填string | |
title必填LocalizedText | |
rows必填MeasureRow[] | AssessmentRow[] | ConclusionRow[] | ItemsRow[] | ReferencesRow[] |
DetailSectionRead2
One declared section with its rows filled for one cell.
section必填DetailSection | |
values必填MeasureDetailValue[] | AssessmentDetailValue[] | ConclusionDetailValue[] | ItemsDetailValue[] | ReferencesDetailValue[] |
DiffLine6
One mutation or estimate line, optionally private or a raw text hunk.
kind必填DiffLineKind | Diff-line operation and display color. |
field必填string | Changed field name or quote JSON pointer. |
before可选JsonValue | null | Previous field value, when present. |
after可选JsonValue | null | Requested value or estimate, when present. |
private可选boolean | Whether this line contains owner-only data. |
textHunks可选TextHunk[] | Raw line operations for a text-file diff. |
DiffLineKind可选值 · 4
Meaning and display treatment of one requested change or provider estimate.
DimensionOrigin可选值 · 2
Where a dimension's placements come from: cut from a fact, or judged (model or caller).
DimensionRecord5
One dimension of a positioning and its ordered options.
key必填string | |
label必填LocalizedText | |
origin必填DimensionOrigin | |
fact可选string | null | |
options必填OptionRecord[] |
DiscardRow2
Leave one row out of the next proposal; it stays visible and restorable.
op可选string | |
rowKey必填string |
DiscoveredAccount7
An account a binding reaches, as the plugin reports it at discovery.
accountId必填string | Account identifier within the source. |
title必填string | Account display name. |
timezone必填string | Account's reporting timezone. |
currency可选string | null | Account currency; null when no money is reported. |
region可选ProviderRegion | null | Sales region reached by this account; null for sources without regional accounts. |
attributes可选object | Account metadata keyed by the source's declared attributes. |
granted可选Permission[] | null | Permissions reported for this account; null when they cannot be listed. |
DocumentOutline8
The artifect snapshot the chat agent reads before each turn; pixels travel separately (previews).
status必填SetStatus | |
revision必填integer | |
title必填string | |
kits必填BrandKit[] | |
photos必填OwnedPhotoRef[] | |
objects必填ObjectOutline[] | |
focus可选string[] | |
latestEdit可选EditSummary | null |
DpCatalogRequest1
The dp_catalog request: the caller only chooses whether DP's per-channel pairs are included.
includePairs可选boolean | Also list each channel's start-to-result pairs (planner-admitted walks, with analyzed and live modes); off by default because the list is large. |
DriftPolicy可选值 · 2
Whether a write may proceed after its target changed since preview.
DropPost2
Leave one post out of create-all.
edit可选string | |
postKey必填string |
DropShadow4
A rendered shadow under any leaf layer (procedural, deterministic, free).
color必填Color | BrandColorRef | |
blur必填number | |
offsetX可选number | |
offsetY可选number |
EditActionKind可选值 · 32
Every edit the agent or the editor can make (discriminator of EditAction).
EditRefusal8
A refused batch or step, pointing at the first offending action so the agent can fix and resubmit.
outcome可选string | |
code必填EditRefusalCode | |
actionIndex可选integer | null | |
layerId可选string | null | |
objectId可选string | null | |
changedObjects可选string[] | |
limit可选integer | null | |
chargeRefusal可选ChargeRefusalCode | null |
EditRefusalCode可选值 · 25
Why a batch (or a paid step on re-check) was not applied; the head is unchanged in every case.
EditRow4
Replace one row's account-free action without changing key, type or target.
op可选string | |
rowKey必填string | |
action必填UnboundAction | |
rationale可选string | null |
EditSummary6
One recorded edit summary for the agent's last-change card and the editor's version history.
revision必填integer | |
actor必填ProductImagesActorKind | |
actionTypes必填EditActionKind[] | |
changedObjects必填string[] | |
committedAt必填string | |
batchKey可选string | null |
EllipseGeometry1
An ellipse inscribed in the box (callout dots, circular badges).
kind可选string |
EntityLevel3
One catalog-declared entity level: its key, bilingual title and one-hop parent.
key必填string | Level key carried by every value. |
title必填StoreLocalizedText | Display name of the level, in both languages. |
parent可选string | null | Level whose entity scopes this one; never itself parented. |
EntityPage10
One customer page with honest progress and an opaque continuation.
coveragePartial可选boolean | Coverage notes were counted over a candidate batch or suppressed, so whole-cell counts are unknown; also set when the page's rows, including a successful empty page, cover only a frozen lexical candidate set, leaving records with no PHRASE hit or ranked beyond the retained window unreachable. |
object必填string | Public object discriminator. |
items必填NodeHit[] | Final typed node hits in page order. |
cursor必填string | null | Opaque signed short token for continuation; null when complete. |
progress必填PageProgress | Requested count and progress per step. |
coverage可选CoverageNote[] | Disclosed gaps in the world this page searched. |
unapplied可选string[] | At most eight request parts that this page did not apply. |
families可选FamilySummary[] | Product families represented by this page's listings. |
window可选ResolvedWindow | null | Time axis and inclusive span read; null when none. |
market可选string | null | Resolved market this page read; null when unknown or unset. |
EntityRef4
One provider entity at a declared level, optionally scoped by its typed parent.
level必填string | Granularity of the entity: a catalog level key. |
entity必填string | Identifier at the declared granularity. |
parent可选EntityRef | null | |
label可选string | null | Display title only, never identity; excluded from proposal hashes and target keys. |
EstimateSource可选值 · 5
Provenance of one economic input used by a profit breakdown line.
EstimationStatus可选值 · 3
State whether a reported metric is actual, estimated, or unknown.
EvidenceBasis可选值 · 3
HOW STRONGLY a fact supports a hit.
ExchangeRateInUsd2
Legacy fixed-two quote expressing currency major units per one USD.
currency必填Currency | |
exchangeRate必填StdMoneyAmount |
ExcludeAsinsAdjustment2
Remove ASINs from the analysis and recompute dependent sections.
adjustmentType可选string | |
asins必填string[] | ASINs removed from the analysis. |
ExistingShopifyFile2
An image body segment that refers to a file already in this Shopify store.
file_id必填string | |
alt_text可选string |
ExportOptions4
How an export renders: format, scale, which images, or one layer alone (stated once per export).
format可选RenderFormat | null | |
scale可选number | |
objectIds可选string[] | null | |
layerId可选string | null |
ExportSet6
An immutable, ordered group of rendered images pinned to one revision: what the listing artifect consumes.
exportId必填string | |
setId必填string | |
revision必填integer | |
options可选ExportOptions | |
images必填ExportedImage[] | |
createdAt必填string |
ExternalIdentity3
Retain a universal product alias without provider attribution.
kind必填ExternalIdentityKind | |
value必填string | |
market可选string | null |
ExternalIdentityKind可选值 · 5
Name provider-neutral product aliases that are safe for consumer data.
FactChange以下之一 · 2
FactChangePage4
One bounded page of derived fact changes; total_rows counts every change matched.
rows必填FactChange[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
FactHistoryResponse5
One bounded page of every stored version, superseded ones included.
rows必填FactVersion[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
object可选string | Fixed tag marking this object as a fact history page. |
FactPage8
One bounded page of fact rows plus the coverage of every requested day.
rows必填FactRow[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
object可选string | Fixed tag marking this object as a fact page. |
coverage必填DayCoverage[] | Coverage of every requested account, family and day. |
readAsOf必填string | The single instant all rows were read at. |
blocked可选BlockedLane[] | Blocked lanes with their reason and fix. |
FactRow8
One stored fact value: identity values, day, typed cells.
account必填AccountRef | The provider account this row belongs to. |
familyKey必填string | The fact family this row belongs to. |
identity必填string[] | One value per family identity attribute, in declared order. |
parents可选EntityRef[] | |
day必填string | The reporting day this value is for. |
occurredAt可选string | null | When the event happened; only for event-style families. |
measures可选object | Measure values keyed by declared measure key; absent is unknown. |
dims可选object | Attribute values keyed by declared attribute key. |
FactSpec3
One fact every item of this plugin may carry.
key必填string | |
label必填LocalizedText | |
kind必填FactValueKind |
FactVersion5
One stored version of one fact row (change-only history).
row必填FactRow | The stored fact row this version belongs to. |
captureId必填string | The capture whose processing made this version readable. |
contentHash必填string | Hash of the row content used to detect a new version. |
observedAt必填string | Instant this version became readable. |
supersededAt可选string | null | Instant a newer version replaced this one; none while current. |
FactsRequest9
A serving read of stored facts for one owner: family, days, selection and pin.
familyKey必填string | The fact family to read. |
days必填DayRange | Inclusive reporting days in the account's timezone. |
storeIds可选string[] | Stores to include; empty selects the asserted owner's stores. |
accountIds可选string[] | Accounts to read; empty means every account of the owner. |
entities可选string[] | Stored entity keys to read; empty means every entity. |
attributes可选AttributeMatch[] | View selections that restrict which rows are returned. |
asOf可选string | null | Instant to read as of; set this or capture_id, never both. |
captureId可选string | null | Committed capture to read as of; set this or as_of, never both. |
page可选PageRequest | Row limit and cursor for this read. |
FailureRef2
A typed, self-describing reference to one durable failure record.
kind必填FailureRefKind | Store the referenced durable record lives in. |
id必填string | Durable record id in that store. |
FailureRefKind可选值 · 1
What kind of durable record a public failure reference names.
Family8
One family of facts: identity, time placement, columns and settle window.
key必填string | Fact-family identifier. |
kind必填TemporalFactKind | How these facts are placed in time. |
level必填string | Granularity of each fact row: a catalog level key. |
identity必填Attribute[] | Ordered text columns identifying a fact. |
dims可选Attribute[] | Additional descriptive text columns. |
measures必填Measure[] | Numeric columns reported by this family. |
settlesAfterDays必填integer | Days after reporting before a value is final; zero means final on capture. |
absence必填AbsencePolicy | Meaning of an entity missing from a confirmed day. |
FamilySummary6
One product family on a page: its label, size and price range.
familyKey必填string | Stable family key, matching NodeHit.family_key. |
label必填string | Readable family label. |
memberCount必填integer | Listings in this family. |
priceCurrency可选Currency | null | Currency of min_price and max_price. |
minPrice可选number | string | null | Lowest member price in major units. |
maxPrice可选number | string | null | Highest member price in major units. |
FbaInboundPlanStatus可选值 · 3
The live plan state, read through ELTA's amazon.seller.fba_inbound_plan_status lookup.
FbaInboundStage可选值 · 7
Where one FBA inbound plan is; the kind's pure stage(...) derives it on every read.
FeatureValue5
One windowed analyzed metric, distinct from label adoption counts.
featureCode必填string | Code of the analyzed feature this value measures. |
windowDays必填integer | Length in days of the window the value was computed over. |
value必填number | The feature's value inside this window. |
velocity可选number | null | Change of the value against the previous window; null when none was measured. |
rank可选integer | null | Position inside the compared cohort; null when no cohort applies. |
FieldProblem3
One provider validation detail attached to a submitted field or whole action row.
field可选string | null | JSON pointer into the change, when known. |
code必填string | Provider or contract field-problem code. |
message必填string | Provider explanation and repair guidance. |
FiledBatch4
Pointers and selected row keys for one filing; no copy of ELTA or inbox state.
proposalId必填string | |
inboxItemId必填string | |
revision必填integer | |
rowKeys必填string[] | Forward selection, or a revert's source-row bound. ELTA revert links and outcomes define touched coverage. |
FilingIntent4
Persist one exact proposal or revert request before filing it through approvals.
request必填ActionBatch | RevertRequest | |
replayKey必填string | |
commandReceipt可选CommandReceipt | null | |
revision必填integer |
FillField2
Override value: a shape layer's fill, solid or gradient (None = no fill).
field可选string | |
fill必填Color | BrandColorRef | LinearGradient | RadialGradient | null |
FirstLegLineDetail3
Transport composition of the first-leg shipping breakdown line.
shippingMode必填ShippingMode | |
billableWeightKg必填number | |
ratePerKg必填MinorUnitMoney |
FlipField3
Override value: an image layer's mirror flags.
field可选string | |
flipX必填boolean | |
flipY必填boolean |
FontSizeField2
Override value: a text layer's font size in canvas pixels.
field可选string | |
size必填number |
FontWeight可选值 · 3
The static weights available in the hosted, licence-cleared font manifest.
FrameEvidence3
The frame ONE element cites as its evidence.
kind可选string | Evidence discriminator; always FRAME. |
frame必填ContentRef | Content reference of the retained frame this element cites. |
timestampMs必填integer | Publication-relative offset of the cited frame in milliseconds. |
Freshness6
Cached freshness rows and one scope-level pending-ingest count.
object必填string | Public object discriminator. |
rows必填FreshnessRow[] | One freshness aggregate per channel and kind. |
activationEpoch必填integer | Visible activation epoch. |
activatedAt必填string | Activation timestamp of the epoch. |
asOf必填string | Timestamp at which the report was computed. |
ingestPending可选integer | null | Jobs waiting in this scope's DP ingest queue; null means not measured. |
FreshnessRow6
One freshness aggregate identified by (channel, node_kind).
channel必填Channel | null | Channel this row counts; null for channel-agnostic rows. |
nodeKind必填NodeKind | ConceptKind | Node or concept kind this row counts. |
records必填integer | Number of cached records for this (channel, kind) coordinate. |
latestObservedAt必填string | null | Legacy raw observation maximum; not a confirming-check guarantee. |
latestCheckedAt可选string | null | |
basis可选FreshnessTime | null |
FreshnessTime可选值 · 3
The three distinct record clocks; no legacy observation fallback is lawful.
FromObject9
The source object or source facts from which a path begins.
kind必填NodeKind | Node kind the path starts from. |
channel可选Channel | null | Source channel the source records live in; null for derived kinds. |
sourceIds可选NodeRef[] | Exact source records the path starts from. |
descriptions可选KeywordTerm[] | Descriptive facts (title, brand, handle and similar) hydrated from the source. |
identities可选ExternalIdentity[] | Universal product aliases (GTIN, EAN, UPC, SKU, model number) carried by the source. |
handles可选string[] | Creator or store handles supplied as source facts. |
conceptKind可选ConceptKind | null | Concept kind to start from when the source kind is CONCEPT. |
market可选string | null | Market the source records belong to. |
dateWindow可选DateWindow | null | Inclusive publication-date span of source topic videos; null means unbounded. |
GapKind可选值 · 7
ONE gap vocabulary for coverage notes and empty step causes.
GatewayError8
The one customer error body: a stable code, a localized message and the offending fields.
object可选string | |
code必填GatewayErrorCode | |
message必填string | |
fields可选string[] | |
failureRef可选FailureRef | null | Upstream failure reference for operator lookup. |
operationId可选string | null | The call's operation id (also the X-Keble-Operation-Id header); quote it to support. |
redeemRefusalReason可选RedeemCodeRefusalReason | null | Finite redeem-refusal reason; set only on a redeem-code refusal. |
retryAfterSeconds可选integer | null | Seconds until a retry may succeed (the request window reset); null when unknown. |
GatewayErrorCode可选值 · 26
Every customer/admin refusal code on REST, MCP and the V3 feature routes.
GenerateDecor6
Paid: paint one decoration on transparency (§6).
action可选string | |
objectId必填string | |
prompt必填string | |
newLayerId可选string | null | |
box可选Box | null | |
replaces可选string | null |
GenerateFromPlan3
Create one variant per plan row that has none (id {plan_id}-{row_id}); row_ids=None = every such row.
action可选string | |
planId必填string | |
rowIds可选string[] | null |
GenerateScene7
Paid: generate a BACKGROUND under the product layer, or across the whole canvas, from a prompt.
action可选string | |
designId必填string | |
layerId必填string | null | |
newLayerId可选string | null | |
replaces可选string | null | |
prompt必填string | |
styleReferences可选AssetRef[] |
GeometryField2
Override value: a shape layer's whole geometry (a variant may round a panel or swap a badge outline).
field可选string | |
geometry必填RectGeometry | EllipseGeometry | LineGeometry | PolygonGeometry | PathGeometry |
GradientStop2
One colour at offset 0–1, following a kit or literal colour.
offset必填number | |
color必填Color | BrandColorRef |
GrantedBy可选值 · 2
Who can grant a permission, which decides who must act when it is missing.
GridSpec5
Which measures may size the circle and be printed in it.
sizeMeasures必填string[] | |
numberMeasures必填string[] | |
defaultSize必填string | |
defaultNumber必填string | |
cellAssessments可选string[] |
GroupLayer8
Layers moved and hidden together; children are placed in canvas coordinates and the box is derived.
layerId必填string | |
name必填string | |
opacity可选number | |
blendMode可选BlendMode | |
visible可选boolean | |
locked可选boolean | |
kind可选string | |
children必填ImageLayer[] | TextLayer[] | ShapeLayer[] | GroupLayer[] |
GroupLayers5
Wrap sibling layers into a new group (caller-minted id); its box is derived from them.
action可选string | |
designId必填string | |
layerIds必填string[] | |
groupId必填string | |
name必填string |
GuardedFetchRefusalCode可选值 · 7
Why a guarded fetch was refused; each is a policy decision, never a transport fault.
HeadingBlock3
One section heading (h2/h3); the post title is the h1 and is not a block.
kind可选string | |
level必填integer | |
text必填string |
HopProgress6
ONE public step entry: how far a page's step got.
edgeId可选string | null | Public catalog edge id; null when unavailable (direct searches or older records). |
toKind必填NodeKind | Node kind this step reads. |
read必填integer | Rows this step read so far. |
fetched可选integer | null | Rows this step fetched before a post-fetch filter removed some; null when no rows were removed after fetching. |
exhausted必填boolean | True when this step has no further rows. |
emptyCause可选GapKind | null | Why this step read zero rows; null unless read is 0. |
HostedImage5
One exact exported design with its private-storage signed GET URL and its slot findings.
designId必填string | |
asset必填AssetRef | |
url必填string | |
expiresAt必填string | |
findings必填SlotFinding[] |
HtmlSegment1
One literal HTML fragment in the ordered body sent to Shopify.
html必填string |
HttpsImageUrl1
An image the owner already hosts (their own cloud link); Amazon fetches it at apply.
url必填string |
ImageBlock3
One shape-selected image placed between paragraphs, with an optional caption.
kind可选string | |
image必填ExistingShopifyFile | ShopifyRemoteImage | PostExportedImage | |
caption可选string | null |
ImageExportRef3
The consumer-held reference to one exported design: set, immutable export, design.
imageSetId必填string | |
exportId必填string | |
designId必填string |
ImageFill2
Fill an image placeholder with an asset (the product photo, a logo); never a found REFERENCE.
placeholder必填string | |
asset必填AssetRef |
ImageFinding2
One slot-rule result placed on one image of the draft; a hint, never a refusal.
pointer必填string | |
finding必填SlotFinding |
ImageLayer15
A placed image; mask is a cut-out alpha matte applied to asset's own pixels.
layerId必填string | |
name必填string | |
opacity可选number | |
blendMode可选BlendMode | |
visible可选boolean | |
locked可选boolean | |
box必填Box | |
shadow可选DropShadow | null | |
kind可选string | |
role必填ImageRole | |
asset必填AssetRef | |
mask可选AssetRef | null | |
flipX可选boolean | |
flipY可选boolean | |
crop可选Box | null |
ImageMediaType可选值 · 3
Accepted and produced image encodings.
ImageOperation可选值 · 3
The paid image-model operations; each is one OperationSpec in library.OPERATIONS.
ImageRole可选值 · 4
What an image layer shows; the fidelity law and the slot checks read it.
InboxItemRef1
Which inbox item a read or completion names (one tool/route input).
itemId必填string |
InboxPendingRequest2
One pending page: an opaque cursor and a bounded size (one tool/route input).
cursor可选string | null | |
limit可选integer |
InferredFact2
WHERE A RETURNED VALUE CAME FROM when it was inferred.
inferredBy必填string | Declaration and major that inferred the value, e.g. creator_market@1. |
confidence必填number | The inference's confidence in [0, 1]. |
IntakeFinding2
One hint on one accepted upload (index into the uploads tuple).
code必填IntakeFindingCode | |
uploadIndex必填integer |
IntakeFindingCode可选值 · 1
A hint about an accepted upload; the owner decides whether it suits their slot.
IntakeRefusal4
An upload the intake refused (index into the uploads tuple), with the limits in force on TOO_LARGE.
code必填IntakeRefusalCode | |
uploadIndex必填integer | |
maxUploadBytes可选integer | null | |
maxPixels可选integer | null |
IntakeRefusalCode可选值 · 2
Why an upload was not accepted: only bytes that cannot be an image or cannot be stored.
IssueKind可选值 · 7
Why a provider refused or failed one call, in the terms the service acts on.
ItemAction2
Host-defined alert remedy, such as a store reason and its store identity.
key必填string | |
ref必填string |
ItemCardSpec4
How one item group is shown in the item list and approval step.
titleFact必填string | |
imageFact可选string | null | |
facts可选string[] | |
pivotFacts可选string[] |
ItemContent4
Human-visible and editable todo/alert/approval content.
title必填string | |
description可选string | |
priority可选Priority | |
assignee可选string | null |
ItemPrompt2
What the models see of one item, as typed parts.
text必填string | |
imageUrls可选string[] |
ItemRead2
One item with its relevance and its group's placements (what the SOURCE and PLACE reviews show).
record必填ItemRecord | |
placements必填object |
ItemRecord2
One stored item, as the plugin sourced it or a caller added it, with its relevance.
item必填SourcedItem | |
relevant必填boolean |
ItemUpdate4
One item's changed fields; an omitted field is unchanged, a named fact is replaced.
key必填string | |
name可选string | null | |
facts可选object | |
relevant可选boolean | null |
ItemsDetailValue4
An ITEMS detail row: the cell's sample items projected to the declared facts.
object可选string | |
kind可选string | |
key必填string | |
items可选object[] |
ItemsRow2
A detail row listing the cell's sample items with the named facts.
kind可选string | |
facts必填string[] |
JsonValue0
没有字段。
JudgmentAdjustment4
Rewrite the conclusion text of the head revision; numbers untouched, 0 model calls.
adjustmentType可选string | |
verdict可选ReportJudgmentVerdict | null | Replacement verdict, when given. |
sections可选ReportJudgmentSection[] | Replacement slot texts, each slot at most once. |
overview可选ReportOverviewEvidence | null | Replacement overview, when given. |
JudgmentQuestion8
Write the conclusion for the committed numbers of one revision.
decisionType可选string | |
language必填Language | Reader language of every text. |
verdictOpen必填boolean | False: a policy pre-check already fixed the verdict. |
fixedReasonCode可选ReportReasonCode | null | Set iff the verdict is not open. |
materialInputUnresolvedAdmissible必填boolean | Whether MATERIAL_INPUT_UNRESOLVED may be the reason. |
ruleLines可选string[] | Policy rules the verdict must follow. |
sectionKinds必填ReportNarrativeSectionKind[] | The section slots to write, once each. |
items可选ReportJudgmentEvidenceItem[] | Citable accepted artifacts. |
KebleBlockKind可选值 · 2
The block kinds a Keble section may repeat: one FAQ question, one feature of a feature list.
KebleSectionKind可选值 · 5
The v1 Keble section library; every member has exactly one SectionSpec (totality test).
Keyword11
Represent a market-scoped source term without embedding product relations.
kind可选string | |
channel必填Channel | |
externalId必填string | |
text必填string | |
keywordType可选KeywordType | |
market可选string | null | |
metrics可选MetricObservation[] | |
brands可选string[] | |
categories可选string[] | |
observedAt必填string | |
provenance必填Provenance |
KeywordCandidate2
One caller term with the evidence the server attached (the core's one converter builds it).
term必填string | |
evidence必填MeasuredKeywordEvidence[] | SuggestedKeywordEvidence[] |
KeywordTerm2
A normalized description carried from a source into ONE named builder.
value必填string | The normalized description text. |
termType必填SourceDescriptionKind | Which descriptive source field the text came from. |
KeywordType可选值 · 3
Describe a source term without selecting its eventual query operation.
KindRuleProblem4
One kind-owned rule a row's action breaks, located by JSON Pointer in action.change.
rowKey必填string | |
pointer必填string | |
rule必填string | |
message必填string |
KitFont3
One named kit font with its usage label, e.g. Anton for HEADLINES (demo 4). Weight stays on the layer.
entryId必填string | |
name必填string | |
font必填string |
Language可选值 · 22
LastCombine1
Range value = the value of the last day that has one.
kind可选string | Range combination: last day with a value. |
LayerClippedRule1
No visible layer extends past the canvas edge (advisory).
kind可选string |
LayerField可选值 · 19
One editable field of a layer or of the canvas.
LayerOverride3
One field of one variant layer that differs from the parent; latest write per (layer_id, field) wins.
layerId必填string | null | |
value必填BoxField | TextField | ColorField | FontField | FontSizeField | FontWeightField | AlignField | LineHeightField | LetterSpacingField | FillField | StrokeField | GeometryField | BlendField | ShadowField | OpacityField | VisibleField | FlipField | CropField | BackgroundField | |
atRevision必填integer |
LeafEditability可选值 · 3
How a page or agent may change one leaf of a row's change; derived from ELTA facts.
LeafRule3
One editability fact for one action type at one JSON Pointer into change.
actionTypeKey必填string | |
pointer必填string | |
editability必填LeafEditability |
LetterSpacingField2
Override value: a text layer's letter spacing.
field可选string | |
letterSpacing必填number |
LineGeometry2
A line across the box diagonal or midline (callout leader lines).
kind可选string | |
diagonal可选boolean |
LineHeightField2
Override value: a text layer's line height.
field可选string | |
lineHeight必填number |
LinearGradient3
A fill across the box: angle 0 left-to-right, 90 top-to-bottom; rotates with the box.
stops必填GradientStop[] | |
gradient可选string | |
angle可选number |
ListBlock3
One bulleted or numbered list; items use the paragraph's inline subset.
kind可选string | |
ordered必填boolean | |
items必填string[] |
ListingCapture1
A dataset read as the full current list on every run.
kind可选string | Capture style: full current list. |
ListingContent6
The seller-editable draft: PTD attributes, price, keyword terms and ordered images.
sellerSku必填string | |
attributes可选object | |
ourPrice可选number | string | null | |
keywords可选string[] | |
mainImage可选ImageExportRef | OwnedPhotoRef | HttpsImageUrl | null | |
otherImages可选ImageExportRef[] | OwnedPhotoRef[] | HttpsImageUrl[] |
ListingCreate3
Create one owner-fenced draft for one target; the body never carries an account.
replayKey必填string | |
target必填ListingTarget | |
content必填ListingContent |
ListingOutcome可选值 · 8
What happened to the draft's ADD, derived on every read from the live approval and ELTA reads.
ListingReadBack3
ELTA's live read of the exact seller SKU after an applied ADD.
sellerSku必填string | |
present必填boolean | |
asin可选string | null |
ListingSnapshot15
The owner-visible draft at one revision with its pins, evidence, checks and live outcome.
artifectRef必填ArtifectRef | |
revision必填integer | |
account必填AccountRef | |
productTypeSchema必填ProductTypeSchema | |
content必填ListingContent | |
keywordCandidates可选KeywordCandidate[] | |
screening必填ScreeningResult | |
imageFindings可选ImageFinding[] | |
preview可选RowPreview | null | |
stage必填ChangeListStage | |
guide必填StageGuide | |
outcome必填ListingOutcome | |
approval可选ApprovalState | null | |
revertApproval可选ApprovalState | null | |
readBack可选ListingReadBack | null |
ListingStatus可选值 · 4
Name the known availability states of one Product listing.
ListingTarget3
The ELTA store, its selected marketplace account and the product type of one draft.
storeId必填string | |
marketplaceId必填string | |
productType必填string |
LlmProductDiversity可选值 · 4
Lookup6
One live provider read a source supports: answered on request, never stored.
key必填string | Live lookup identifier. |
title必填string | Display name of this live lookup. |
querySchema必填JsonValue | JSON Schema of the lookup input. |
resultSchema必填JsonValue | JSON Schema of a lookup result. |
requires可选Permission[] | Permissions needed to run this lookup. |
meaning可选string | null | What this live lookup answers and when to use it, in one sentence; null when undeclared. |
LookupPage3
One bounded page of live results; next_cursor is the provider's page token.
object可选string | Fixed tag marking this object as a lookup page. |
rows必填JsonValue[] | The result rows in the lookup's own shape. |
nextCursor可选string | null | Cursor continuing to the next page; none on the last page. |
LookupRequest5
One live read pinned to an owner-visible store and optional stored account.
storeId必填string | Owner-visible store to read. |
lookupKey必填string | The declared lookup to run. |
accountId可选string | null | Stored account to read; required when the source has several. |
query必填JsonValue | The lookup's own query payload. |
page可选PageRequest | Row limit and cursor for this read. |
MatchedFact11
WHY THIS ROW MATCHED THIS CLAUSE: the stored fact, when it was observed, and the relation path if a hop was involved. One fact per field, one MatchedFact per clause.
clauseIndex可选integer | null | Index of the query clause this fact satisfies; null when the fact carries no clause position. |
basis必填EvidenceBasis | Evidence basis of this fact: RECORDED, MENTIONED or SIMILAR. |
fieldOrCode必填string | Field or feature code the fact was read from. |
value必填string | integer | number | string | boolean | The stored value that matched the clause; money is an exact major-unit decimal. |
observedAt必填string | null | When the fact was observed; null when unknown. |
measure可选string | null | Trend column the fact read: VALUE, VELOCITY or RANK; null when the fact is not a feature. |
path可选RelationHop[] | Relation hops that connect the result to the fact; empty when the match needed none. |
window可选ResolvedWindow | null | The resolved window this fact was read in; null when the fact carries none. |
currencyBasis可选CurrencyBasis | null | How a monetary fact's currency is known (STATED or ASSUMED); null for a non-monetary fact. |
estimation可选EstimationStatus | null | Whether a monetary fact's value is estimated; null for a non-monetary fact. |
inferred可选InferredFact | null | Provenance of an inferred value; omitted when the source stated the value. |
MaterialFactEstimate2
Use the system calculation for one key, without claiming seller authority.
choiceType可选string | |
questionKey必填string | Question settled by system estimation. |
MaterialFactResolution3
One seller-fact choice for one committed material question.
choiceType可选string | |
questionKey必填string | Answered question identity. |
resolution必填ReportMaterialResolution | Typed seller facts. |
MaterialFactsAnswer2
Settle offered material keys in one non-empty, typed request.
decisionType可选string | |
resolutions必填MaterialFactResolution[] | MaterialFactEstimate[] | One resolution or estimate choice per offered key. |
Maturity可选值 · 2
Whether a day's value may still be restated by the source.
MaxLongestSideRule2
The longest side is at most pixels (Shopify 5000, Amazon 10000).
kind可选string | |
pixels必填integer |
Measure3
One declared numeric column, its unit and its display name.
key必填string | Numeric-column identifier; fact queries use its declared row path. |
unit必填Unit | Physical unit of values in this column. |
title必填StoreLocalizedText | Display name of the column, in both languages. |
MeasureChange7
One measure changed; values stay Decimal and an absent side is None, never 0.
entity必填string | Stored entity key of the row that changed. |
observedAt必填string | Instant the new value became readable. |
captureId必填string | The capture that made the new value readable. |
kind可选string | Discriminator marking this as a measure change. |
measureKey必填string | The declared measure whose value changed. |
oldValue可选number | string | null | The value before the change; none when there was none. |
newValue可选number | string | null | The value after the change; none when there was none. |
MeasureCoverage2
How many of the cell's groups (or items) carried the measured fact.
counted必填integer | |
total必填integer |
MeasureDetailValue4
A MEASURE detail row: one declared measure's computed value for the cell.
object可选string | |
kind可选string | |
key必填string | |
measure可选MeasureValue | null |
MeasureFormat可选值 · 4
How the frontend prints a measure value.
MeasureRow2
A detail row showing one measure's value.
kind可选string | |
measure必填string |
MeasureValue4
One measure's value in one cell; coverage is set for DISTINCT and fact-based rules.
status必填ValueStatus | |
value可选number | string | null | |
currency可选string | null | |
coverage可选MeasureCoverage | null |
MeasuredKeywordEvidence8
One ELTA fact row the server read for this term: family, account, day, row identity, metric.
kind可选string | |
familyKey必填string | |
accountId必填string | |
day必填string | |
sourceRowId必填string | |
sourceRowSha256必填string | |
measureKey必填string | |
value必填number | string |
MediaKind可选值 · 2
Name the common image or video media forms carried by entities.
MediaRef6
Reference one public media URL without carrying its bytes.
kind必填MediaKind | |
sourceUrl必填string | |
thumbnailUrl可选string | null | |
width可选integer | null | |
height可选integer | null | |
durationSeconds可选number | null |
Metric5
One metric the plugin calculates per day, and how its days are combined.
key必填string | Calculated metric identifier. |
unit必填Unit | Physical unit of the metric's values. |
levels必填string[] | Granularities where this metric is available. |
meaning必填string | Business meaning of this metric. |
combine必填Combine | How daily values combine across a reporting range. |
MetricClause4
Compare one typed metric against an integer, finite number, or Money.
kind可选string | |
metric必填MetricKind | |
op必填string | |
value必填integer | number | MinorUnitMoney |
MetricCoverage可选值 · 5
Describe whether a metric is a point, interval, cumulative, or board fact.
MetricGap可选值 · 7
Why a range value is missing or qualified.
MetricKind可选值 · 46
Name entity and product-keyword measurements with stable units and periods.
MetricObservation16
Represent one typed measurement without source/provider attribution.
metric必填MetricKind | |
unit必填MetricUnit | |
period必填MetricPeriod | |
intValue可选integer | null | |
floatValue可选number | null | |
moneyValue可选MinorUnitMoney | null | |
currencyBasis可选CurrencyBasis | null | |
market可选string | null | |
measuredAt可选string | null | |
periodStart可选string | null | |
periodEnd可选string | null | |
coverage可选MetricCoverage | |
estimationStatus可选EstimationStatus | |
confidence可选number | null | |
origin可选ObservationOrigin | |
change可选boolean |
MetricPage5
One bounded page of combined range values: the /v2/metrics/query response.
rows必填MetricRangeValue[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
object可选string | Fixed tag marking this object as a metric page. |
MetricPeriod可选值 · 6
Name the temporal coverage of a metric observation.
MetricRangeValue11
One metric for one entity over the requested days, combined by its declared rule.
metricKey必填string | The metric this value is for. |
entity必填string | The entity these days were combined for. |
value必填number | string | null | The combined value; none means no value, not zero. |
availability必填Availability | What is held for this metric, entity and range. |
maturity必填Maturity | Whether the combined days may still be restated. |
currency可选string | null | Currency of the value when it is money; none otherwise. |
timezone可选string | null | Timezone the days were read in, when combining needs it. |
accountId可选string | null | Set only when the value could not be combined across accounts. |
gaps可选MetricGap[] | Reasons the value is missing or qualified. |
provisionalDays可选string[] | Days in the range that may still be restated. |
blocked可选BlockedLane[] | Lanes named with a source-blocked gap: which and why. |
MetricUnit可选值 · 6
THE one unit vocabulary for metric values; DPC imports it.
MetricsRequest7
A serving read of one or more metrics over a date range, current values only.
metricKeys必填string[] | Metrics to read; at least one. |
level必填string | The entity level key the caller wants values at. |
days必填DayRange | Inclusive reporting days in the account's timezone. |
storeIds可选string[] | Stores to include; empty selects the asserted owner's stores. |
accountIds可选string[] | Accounts to read; empty means every account of the owner. |
entities可选string[] | Stored entity keys to read; empty means every entity. |
page可选PageRequest | Row limit and cursor for this read. |
MinLongestSideRule2
The longest side is at least pixels (Amazon: 1000 enables zoom).
kind可选string | |
pixels必填integer |
Monitor13
One user-owned standing question with its watches, schedule and delivery.
monitorId必填string | |
owner必填MonitorOwnerScope | |
confirmedBy可选string | null | |
title必填string | |
language可选Language | |
status必填MonitorStatus | |
pauseReason可选MonitorPauseReason | null | |
specRevision必填integer | |
watches可选MonitorWatch[] | |
cadence可选MonitorCadence | null | |
delivery可选MonitorDelivery | |
agent必填MonitorAgentBinding | |
nextDueAt可选string | null |
MonitorCadence6
One schedule; next_due is the only schedule math in the estate.
unit必填MonitorCadenceUnit | |
every必填integer | |
at可选string | null | |
weekday可选integer | null | |
dayOfMonth可选integer | null | |
timezone必填string |
MonitorConfirmPage6
The confirm input page, "What we'll monitor": watches, schedule, next run and the request estimate.
page可选string | |
monitor必填Monitor | |
nextRunAt必填string | |
checksPerDay必填number | string | |
requestsPerDay必填number | string | |
expiresAt必填string |
MonitorCycle10
One scheduled check of one monitor, running the frozen spec_revision.
monitorId必填string | |
seq必填integer | |
specRevision必填integer | |
dueAt必填string | |
state必填MonitorCycleState | |
watches必填MonitorWatchCycle[] | |
baseline必填boolean | |
startedAt必填string | |
finishedAt可选string | null | |
deliveries可选MonitorChannelDelivery[] |
MonitorDelivery2
Per-monitor channel toggles; the inbox notification is always filed for a reported cycle.
chat可选boolean | |
email可选boolean |
MonitorFinding3
One reported item of one cycle: the item as seen, and what changed.
findingKey必填MonitorFindingKey | |
item必填MonitorFindingItem | |
change必填MonitorNewItem | MonitorValueChange | MonitorRankMove |
MonitorSetupPage5
The setup input page: the capability catalog frozen at create, and the cadence floor.
page可选string | |
monitor必填Monitor | |
offers必填MonitorCapabilityOffer[] | |
minInterval必填string | |
expiresAt必填string |
MonitorSnapshot3
What the host reads to show a monitor and derive its artifect stage (from status + open cycle only).
monitor必填Monitor | |
openCycle可选MonitorCycle | null | |
lastCycle可选MonitorCycle | null |
MonitorStatus可选值 · 5
Lifecycle of one monitor; the artifect stage is derived from it and the open cycle, never stored.
MonitorWatch11
One stored watch: the compiled spec under the core's stable watch_key, with the request it came from.
title必填string | |
channelLabel必填string | |
subjectLabel必填string | |
policy必填MonitorFindingPolicy | |
sourceKey必填string | |
fetches必填boolean | |
minInterval必填string | |
readsPerCheck必填integer | |
dataAsOf可选string | null | |
watchKey必填string | |
request必填MonitorWatchRequest |
MonthlyStorageFee8
month必填integer | |
isDangerousGoods必填boolean | |
productSizeTier必填string | |
feeCategory必填string | |
volumeCubic必填number | |
cubicUnit必填string | |
perCubicStorageFee必填number | |
storageFee必填number |
Motif11
ONE MOTIF NODE — a group of elements several creators independently did.
kind可选string | Node discriminator; always MOTIF. |
key必填string | Identity key 'motif:{first member element key}'; a merge keeps the older key. |
name必填string | Display name of the motif. |
elementKind必填ConceptKind | Concept kind of the elements this motif groups. |
sections必填MotifSection[] | Named sections this motif belongs to; empty when it belongs to none. |
features必填FeatureValue[] | Windowed motif figures (creators, posts, quality) with velocity and rank. |
trend可选MotifTrend | null | Read-time trending reading over the reader's own window; null when the read names no trending window. |
dailyPosts必填integer[] | Posts per day across the requested window, oldest first, ending at the window end day; length equals the window's days. |
products可选RelationRef[] | Distinct products featured by the motif's member content. |
membersTotal必填integer | Number of member elements grouped by this motif. |
examples可选MotifMember[] | Newest-first member examples, at most five. |
MotifMember10
ONE member element shown on a motif card.
elementKey必填string | Key of the member element inside the motif. |
contentRef必填NodeRef | Scoped reference to the content the element was extracted from. |
creatorRef必填NodeRef | null | Scoped reference to the content's creator; null when it has no author. |
pattern必填string | Generic pattern label of the element, without brand or product names. |
appearance必填string | How the element appears: subject, action, framing and on-screen text. |
instance必填string | null | This content's brand or product specifics for the pattern; null when none. |
evidence必填FrameEvidence[] | SpanEvidence[] | Frame or transcript citations that support this member. |
publishedAt必填string | null | Publication time of the member content; null when unknown. |
creatorHandle可选string | null | Handle of the member content's creator, when known. |
views可选integer | null | Latest view count of the member content, when known. |
MotifQuery6
One named motif section and window with an optional row ceiling.
days可选integer | null | Length in days of the current window; null when start/end state the span. |
start可选string | null | Inclusive first day of an explicit span. |
end可选string | null | Inclusive last day of the current window; null uses the newest member publication day in scope. |
section必填MotifSection | |
terms可选string[] | Word-match terms tested against each member's label or instance, or the member content's searchable fields; at most eight. |
maxRows可选integer | null | Optional row ceiling for this motif page; the smaller of this and the normal page size is returned. Omission preserves the normal page size. |
MotifSection可选值 · 2
THE TWO NAMED MOTIF QUESTIONS the platform asks of itself on every page load, as a closed vocabulary rather than free text.
MotifTrend8
ONE MOTIF'S TRENDING READING for the resolved window and the equally long window immediately before it.
score必填number | Trending score: creators x growth x buzz x freshness. |
growth必填number | Current creators over previous creators, plus one each; the previous count is 0 when nothing published in the previous window. |
buzz必填number | Log10(1 + likes + 2 x comments) over the current window. |
freshness必填number | Recency decay of the newest member publication, in (0, 1]. |
ageDays必填integer | Days from the window's end day back to the newest in-window member publication. |
newestPublishedAt必填string | Publication time of the newest member inside the current window. |
current必填MotifWindowFigures | Member figures of the current window. |
previous可选MotifWindowFigures | null | Member figures of the equally long previous window; null when nothing published in it. |
MotifWindow3
WHICH CALENDAR DAYS one motif trending read compares.
days可选integer | null | Length in days of the current window; null when start/end state the span. |
start可选string | null | Inclusive first day of an explicit span. |
end可选string | null | Inclusive last day of the current window; null uses the newest member publication day in scope. |
MotifWindowFigures5
ONE MOTIF'S MEMBER TOTALS INSIDE ONE WINDOW.
creators必填integer | Distinct member creators who published inside the window. |
posts必填integer | Distinct member contents published inside the window. |
likes必填integer | Likes summed over the window's member contents; a missing count is 0. |
comments必填integer | Comments summed over the window's member contents; a missing count is 0. |
views必填integer | Views summed over the window's member contents; a missing count is 0. |
MoveBlock4
Move one block within its section to after another block (None: to the end).
action可选string | |
sectionKey必填string | |
blockKey必填string | |
after可选string | null |
MoveSection3
Move one section within its page to after another entry (None: to the end).
action可选string | |
sectionKey必填string | |
after可选string | null |
NewChangeRow2
A new account-free row action and the one-sentence rationale shown to the person.
action必填UnboundAction | |
rationale必填string |
NewKeblePage2
The store page Keble creates at publish for a Keble landing-page template (unpublished).
title必填string | |
handle必填string |
NewThemePage4
Removed in the first theme release after SEO and GEO migrate.
title必填string | |
handle必填string | |
templateSuffix必填string | |
body必填HtmlSegment[] | ExistingShopifyFile[] | ShopifyRemoteImage[] |
NoArguments0
The request of an operation that takes nothing but its caller (a catalog, a freshness report).
没有字段。
NoBadgeClaimsRule1
No visible text layer carries a badge or claim word from the package's fixed zh/en lexicon.
kind可选string |
NoEdgeCropRule2
At most max_hidden_ratio of the product's content box is hidden by the canvas edge or a crop.
kind可选string | |
maxHiddenRatio必填number |
NoGraphicsRule1
Only product image layers over the background: no shapes, logos or decorations (Amazon main).
kind可选string |
NoTextRule1
The design has no visible text layer (Amazon main image: no text or pricing).
kind可选string |
NodeHit9
A returned typed node, the source refs that led to it, and its display facts.
item必填Product | Store | Creator | Content | Keyword | Contact | PlatformDefinedCategory | Brand | ProductFamily | Motif | Concept | The returned node, either a source entity or a declared derived kind. |
via可选NodeRef[] | Scoped source references that led to this node. |
analysis可选Analysis | null | Analyzed facts attached when the analyzed store has them; null otherwise. |
recordKey必填string | The stored row's key, else stable_key_of over the subject claim. |
familyKey可选string | null | Product family key shared by this row's siblings; null when the row belongs to no family. |
evidence可选MatchedFact[] | Matched facts explaining why this hit is here; at most 8. |
promoted可选boolean | Whether this hit is promoted: a recorded promotional link, or explicit paid sponsorship. When the hit's claim about the matched entity carries a stance, paid sponsorship counts only if that claim recommends the entity as the item's main subject; a hit with no stance-bearing claim keeps the plain paid verdict. Computed once by is_promoted, never re-derived by a renderer. |
label可选string | null | Serving-resolved display label: the stored title/name, else a bounded caption excerpt; null when the node has no readable label or its name must not be exposed (a contact's email or WhatsApp). |
publicUrl可选string | null | Public HTTPS link built from the hit's own stored identity (a source post/creator/product page); null when no link can be built without guessing or when the node has no public page. Never a media or signed CDN URL. |
NodeKind可选值 · 11
Every node kind one DP search can start from or ask for.
NodeRef3
One kind- and channel-scoped reference used in DP, never a bare ID list.
kind必填NodeKind | Node kind that defines the key namespace. |
channel可选Channel | null | Source channel the referenced record lives in; null for a derived node's own scope. |
key必填string | Kind- and scope-qualified key of the referenced node. |
NotificationCreate4
Immutable generic producer-filed note that people read per source event.
kind可选string | |
content必填ItemContent | |
key必填string | |
ref必填string |
NotificationItem9
A stored note with no shared status; who read it lives in per-person receipts.
id必填string | |
owner必填OwnerRef | |
current必填ItemContent | |
created_at必填string | |
revision必填integer | |
created_by可选ActorRef | null | |
kind可选string | |
object可选string | |
creation必填NotificationCreate |
ObjectKind可选值 · 7
Name the seven source entity kinds returned by Data Infra.
ObjectOutline20
One object as the agent reads it; focus objects carry their resolved layers and overrides.
objectId必填string | |
kind必填BoardObjectKind | |
name必填string | |
position必填BoardPoint | |
state必填ObjectState | |
changedAtRevision必填integer | |
source可选ContentSource | null | |
parentId可选string | null | |
recipe可选VariantRecipe | null | |
preset可选string | null | |
size可选PixelSize | null | |
background可选Color | null | |
layers可选ImageLayer[] | TextLayer[] | ShapeLayer[] | GroupLayer[] | null | |
overrides可选LayerOverride[] | null | |
staleParts可选StalePart[] | |
unresolved可选UnresolvedBrandRef[] | |
findings可选SlotFinding[] | |
columns可选PlanColumn[] | null | |
rows可选PlanRow[] | null | |
kitId可选string | null |
ObjectState可选值 · 7
The one badge an object shows; derived, never stored. Precedence top to bottom.
ObjectStatus4
One non-READY object's badge, lock and the steps behind it (SetStatus.objects).
objectId必填string | |
state必填ObjectState | |
locked必填boolean | |
stepIds可选string[] |
ObservationOrigin可选值 · 2
Label who measured one metric value.
OpacityField2
Override value: a layer's opacity.
field可选string | |
opacity必填number |
OperationQuote2
How many paid steps of one operation a batch would admit.
operation必填ImageOperation | |
steps必填integer |
OptionRecord5
One option of a dimension; banded options keep their bounds.
key必填string | |
label必填LocalizedText | |
low可选number | string | null | |
high可选number | string | null | |
catchAll可选boolean |
OrderDesigns3
Move one object in the board order (z-order and LAYERS tree): directly above above, or to the bottom.
action可选string | |
objectId必填string | |
above必填string | null |
OrderLayer4
Move one layer in the stack: directly above above, or to the bottom when None.
action可选string | |
designId必填string | |
layerId必填string | |
above必填string | null |
OwnedPhotoRef1
The consumer-held reference to one photo the owner uploaded through add_photos.
asset必填AssetRef |
OwnerKind可选值 · 2
The two supported item-list owners.
OwnerType可选值 · 3
PageProgress2
How far one page got against what the caller asked for.
requested必填integer | Rows the caller asked for. |
hops可选HopProgress[] | One entry per executed step, in plan order. |
PageRequest2
How one bounded read pages: a row limit and the opaque cursor that continues it.
limit可选integer | Maximum rows in this page. |
cursor可选string | null | Opaque cursor from the previous page. |
PaidStepState可选值 · 9
Lifecycle of one paid step (one attempt): admitted in the request, run by the worker, landed alone.
PaidStepView9
One paid step as the agent and the editor see it.
attemptId必填string | |
action必填CutOutProduct | GenerateScene | GenerateDecor | |
state必填PaidStepState | |
refusal可选EditRefusalCode | null | |
chargeRefusal可选ChargeRefusalCode | null | |
failure可选ProviderFailureCode | null | |
revision可选integer | null | |
queuedAt可选string | null | |
waitingForUnlock可选boolean |
ParagraphBlock2
One paragraph of plain text with inline **strong**, *em* and [label](https://...).
kind可选string | |
text必填string |
PathGeometry2
A library outline filling the box, stretched/rotated by it; no free-form path data.
kind可选string | |
path必填PathKey |
PathKey可选值 · 20
One immutable curated outline from the keble-core 1000-unit square path library.
PeerIntent可选值 · 2
What a same-kind search means when it asks for peers.
Permission4
One provider-side permission a read or write needs, as the plugin declares it.
key必填string | The declared permission key. |
title必填string | Short label of the permission. |
grantedBy必填GrantedBy | Who can grant it, which decides who must act. |
grantHint必填StoreLocalizedText | What the grantor must change and where, in both languages. |
Phase可选值 · 4
The four user-visible phases (the existing stepper), subject-neutral.
PhaseStatus可选值 · 4
WAITING_FOR_USER is distinct from WORKING: busy is not idle (existing ruling).
PhotoLinkProblem3
Why one owner photo link produced no photo; the same shape for every code.
url必填string | |
code必填GuardedFetchRefusalCode | PhotoLinkTransportCode | |
detail必填string |
PhotoLinkTransportCode可选值 · 1
A link's transport fault that is not a policy refusal (owned here; keble-helpers stays raise-only).
PhotoLinksAdded2
The one owner-scoped intake result plus one typed problem per link that produced no photo.
intake必填PhotosAdded | IntakeRefusal | |
problems可选PhotoLinkProblem[] |
PhotoLinksRequest2
HTTPS images stored as owner photos or scene-only references in one bounded intake.
urls必填string[] | |
origin可选string |
PhotosAdded4
The accepted uploads, in upload order, and their hints.
photos必填OwnedPhotoRef[] | |
references可选AssetRef[] | |
findings可选IntakeFinding[] | |
defaultStarterPaidSteps必填integer |
PixelSize2
A raster size in pixels.
width必填integer | |
height必填integer |
PlaceBrandKit5
Add a card showing one owner kit (UNKNOWN_BRAND_KIT for an unknown or foreign kit).
action可选string | |
objectId必填string | |
name必填string | |
kitId必填string | |
position可选BoardPoint | null |
PlaceholderBinding2
A plan column whose cell text replaces every source text layer carrying this placeholder.
binding可选string | |
placeholder必填string |
PlanColumn3
One plan column; binding=None is a note column the agent reads (angle, audience).
columnId必填string | |
title必填string | |
binding可选TextLayerBinding | PlaceholderBinding | SceneCueBinding | null |
PlanRow3
One plan row: cells maps a column id to its text; name names the generated image.
rowId必填string | |
cells可选object | |
name可选string | null |
PlanRowRef2
One row of one plan; held by the variant that row produced (the only row -> image link).
planId必填string | |
rowId必填string |
PlannedPost6
One row of the post plan (1.2): topic, abstract, tone, length and intended images.
postKey必填string | |
topic必填string | |
abstract必填string | |
toneKey必填string | |
targetWords必填integer | |
imagePlan必填string |
PlatformDefinedCategory10
Represent one catalog category node that a platform itself defines.
kind可选string | |
channel必填Channel | |
externalId必填string | |
name必填string | |
parentRef可选SourceSubject | null | |
path可选string[] | |
market可选string | null | |
metrics可选MetricObservation[] | |
observedAt必填string | |
provenance必填Provenance |
PluginDeclaration5
Everything one plugin package declares: sources, metrics and write-family switches.
key必填string | Catalog plugin identifier. |
title必填string | Display name of this plugin. |
sources必填Source[] | Sources this plugin can connect. |
metrics可选Metric[] | Metrics this plugin calculates; empty for live-read-only plugins. |
actionFamilies可选ActionFamily[] | Unique owner-facing families used by this plugin's actions. |
PolicyCitation4
The captured official source passage behind one rule.
policyUrl必填string | |
section必填string | |
capturedOn必填string | |
snapshotSha256必填string |
PolygonGeometry3
A polygon (inner_ratio=1) or star inscribed in the box, first corner up.
kind可选string | |
corners必填integer | |
innerRatio可选number |
PositioningCellQuery3
Ask for one cell's detail dialog, the reading client's cell read.
object可选string | |
cellKey必填string | |
viewId可选string | null |
PositioningDetail3
One answered detail query: the reading client's answer plus the labels it uses.
object可选string | |
answer必填CellDetail | PositioningItemPage | |
labels必填PositioningDetailLabels |
PositioningDetailLabels7
The labels one detail answer needs to be read by a person, and nothing more.
object可选string | |
itemNoun必填LocalizedText | |
dimensions可选DimensionRecord[] | |
measures可选RoomPublicMeasure[] | |
assessments可选RoomPublicAssessment[] | |
facts可选FactSpec[] | |
criterion可选LocalizedText | null |
PositioningItemsQuery3
Ask for one page of items, the reading client's items read.
object可选string | |
cellKey可选string | null | |
cursor可选string | null |
PositioningRecord12
One positioning: its one plugin, its setup, its review setting, and its stepper.
ref必填PositioningRef | |
positioningId必填string | |
gridId可选string | null | |
pluginId必填string | |
language可选Language | The language every model-written, user-visible positioning text must use. |
brief必填string | |
ownerNote可选string | |
setup可选object | null | |
review可选object | |
phase必填Phase | |
status必填PhaseStatus | |
createdAt必填string |
PositioningRef2
One positioning, addressed by its owner and the host task that holds it.
owner必填OwnerScope | |
taskId必填string |
PostDraft3
POST_DRAFTS (1.4): one planned post written in its tone with text and images mixed.
step可选string | |
postKey必填string | |
post必填ComposedPost |
PostEntry3
One planned post and its latest content; post is empty until its draft lands.
plan必填PlannedPost | |
post可选ComposedPost | null | |
reviewNotes可选string | null |
PostPlan3
POST_PLAN (1.2): the tones, then how many posts in which order; the count bound is a Setting.
step可选string | |
tones必填ToneSpec[] | |
posts必填PlannedPost[] |
PostSelfReview4
SELF_REVIEW (1.5): the agent's own pass for a natural, human tone, and the revised post.
step可选string | |
postKey必填string | |
reviewNotes必填string | |
post必填ComposedPost |
PostSet8
The whole guided state: direction, plan with tones and posts, style examples, the parked step.
status必填PostSetStatus | |
parkedStep必填BlogStep | null | |
direction可选BlogDirection | null | |
tones可选ToneSpec[] | |
posts可选PostEntry[] | |
styleExamples可选StyleExample[] | |
sample可选SampleConfirmation | null | |
reviewRound可选integer |
PostSetStatus可选值 · 2
Where the post set stands.
PreviewSession4
The run's one preview copy: which theme, copied from which target, and which revision it holds.
copyThemeId必填string | |
createdFromThemeId必填string | |
documentRevisionOnCopy可选integer | null | |
createdAt必填string |
PreviewView3
Stateless answer to a preview request, with outcomes and diffs aligned to its batch.
batch必填ActionBatch | Requested action batch; nothing is persisted by preview. |
previews必填ActionOutcome[] | One live outcome per action, in order. |
diffs必填ActionDiff[] | One derived diff per action, in order. |
PriceClause5
Apply a typed monetary bound without binary-float price values.
kind可选string | |
op必填string | |
value必填MinorUnitMoney | |
metric可选string | |
averageDays可选integer | null |
Priority可选值 · 2
The initial human-attention levels.
PrivateValue3
One private leaf held outside its row; never returned by any read.
rowKey必填string | |
pointer必填string | |
value必填JsonValue |
Product27
Represent one provider-neutral sellable item.
kind可选string | |
channel必填Channel | |
externalId必填string | |
title可选string | null | |
description可选string | null | |
brand可选string | null | |
manufacturer可选string | null | |
modelNumber可选string | null | |
category可选string | null | |
categoryPath可选string[] | |
tags可选string[] | |
market可选string | null | |
url可选string | null | |
features可选string[] | |
attributes可选ProductOption[] | |
publishedAt可选string | null | |
releasedAt可选string | null | |
firstTrackedAt可选string | null | |
storeRef可选SourceSubject | null | |
storeName可选string | null | |
identities可选ExternalIdentity[] | |
variants可选ProductVariant[] | |
metrics可选MetricObservation[] | |
media可选MediaRef[] | |
status可选ListingStatus | |
observedAt必填string | |
provenance必填Provenance |
ProductBrief2
What the owner gave us: product photos (may be empty on a board, demo 3) and a plain description.
photos可选AssetRef[] | |
description必填string |
ProductContent9
The editable unpublished product draft; the whole value becomes one product.create.
title必填string | |
handleStem必填string | |
descriptionHtml可选string | null | |
vendor可选string | null | |
productType可选string | null | |
tags可选string[] | |
options可选ShopifyProductOption[] | |
variants必填ProductVariantFields[] | |
images可选ExistingShopifyFile[] | ShopifyRemoteImage[] | PostExportedImage[] |
ProductCreateRequest3
Create one draft pinned to exactly one ELTA store; it carries only store_id.
replayKey必填string | |
storeId必填string | |
content必填ProductContent |
ProductFamily4
A DP-derived product family with its count; members are resolved through the `VARIANT_OF` relation, never through an unscoped array.
kind可选string | Node discriminator; always PRODUCT_FAMILY. |
key必填string | The product family's own analyzed key. |
title必填string | null | Display title of the family; null when the source states none. |
memberCount必填integer | Number of products in this family. |
ProductFillRule2
The product's visible pixels span at least min_ratio of the frame's longer side (Amazon ~85%).
kind可选string | |
minRatio必填number |
ProductImagesDetailView可选值 · 1
What may be read in detail about one image set.
ProductOptionValue2
One option name/value pair that places a variant in the product's options.
optionName必填string | |
value必填string |
ProductProposalFiling3
The ids of one FiledApproval this artifect keeps, and which ELTA action type it filed.
proposalId必填string | |
inboxItemId必填string | |
actionTypeKey必填string |
ProductReleasedType可选值 · 4
ProductSimilarType可选值 · 4
ProductSnapshot9
The owner-visible draft at one revision, with its screen result and every filed proposal.
artifectRef必填ArtifectRef | |
storeId必填string | |
account必填AccountRef | |
revision必填integer | |
content必填ProductContent | |
screening必填ScreeningResult | |
proposals可选ProductProposalFiling[] | |
filingIntent可选StagedProposal | null | |
approvals可选ApprovalState[] |
ProductTypeSchema2
A resolved seller-specific definition with the pin that identifies its bytes.
reference必填ProductTypeSchemaRef | |
schemaDocument必填object |
ProductTypeSchemaRef3
Pin one target to the exact seller-specific Product Type Definition version and bytes.
target必填ListingTarget | |
version必填string | |
schemaSha256必填string |
ProductVariant6
Retain the observed SKU, model number, and options of one Product variant.
sku可选string | null | |
modelNumber可选string | null | |
options可选ProductOption[] | |
ref可选SourceSubject | null | |
price可选MinorUnitMoney | null | |
available可选boolean | null |
ProductVariantFields4
One variant sent in the same productSet call: option values, price, SKU and barcode.
optionValues可选ProductOptionValue[] | |
price必填number | string | |
sku可选string | null | |
barcode可选string | null |
ProfileInputsAdjustment11
Patch the seller's setup after finishing, then re-price the cohort.
suggestedPurchasingCost可选SuggestedPurchasingCost | null | The seller's own purchasing cost for one benchmark ASIN; never a Keble estimate. |
acosLowerbound可选integer | null | ACOS lower bound, whole percent. |
acosUpperbound可选integer | null | ACOS upper bound, whole percent. |
fixedLength可选number | null | Fixed length. |
fixedWidth可选number | null | Fixed width. |
fixedHeight可选number | null | Fixed height. |
fixedLengthUnit可选string | null | Unit of the fixed size; None means cm. |
fixedWeight可选number | null | Fixed weight. |
fixedWeightUnit可选string | null | Unit of the fixed weight; None means g. |
investmentDifficultyAmountThreshold可选MinorUnitMoney | null | Entry-budget threshold. |
adjustmentType可选string |
ProfitBreakdown9
One coherent scenario's exact selling-price-to-profit waterfall.
scenarioKey必填string | |
role必填ScenarioRole | |
shippingMode必填ShippingMode | |
isPeakPeriod必填boolean | |
sellingPrice必填MinorUnitMoney | |
lines必填ProfitBreakdownLine[] | |
profit必填MinorUnitMoney | |
margin必填number | |
sizing必填SizingDetail |
ProfitBreakdownLine7
One settled deduction between selling price and unit profit.
kind必填ProfitLineKind | |
amount必填MinorUnitMoney | |
shareOfPrice必填number | |
source必填EstimateSource | |
ratio可选number | null | |
storageDetail可选StorageLineDetail | null | |
firstLegDetail可选FirstLegLineDetail | null |
ProfitEnvelope8
Margin range produced by evaluating every coherent scenario.
expected必填ProfitBreakdown | |
optimistic必填ProfitBreakdown | |
pessimistic必填ProfitBreakdown | |
tierProbes必填ProfitBreakdown[] | |
marginLower必填number | |
marginUpper必填number | |
marginBoundScenarioKeys必填any[] | |
profitBoundScenarioKeys必填any[] |
ProfitInputOverride4
Named ASINs whose physical or purchasing inputs are replaced.
asins必填string[] | ASINs this override applies to. |
dimensions可选ReportMaterialDimensionsAnswer | null | Replacement three-axis dimensions. |
weight可选ReportMaterialWeightAnswer | null | Replacement weight. |
unitCost可选ReportMaterialCostAnswer | null | Replacement purchasing unit cost bounds. |
ProfitInputsAdjustment2
Replace profit-calculator inputs, then recompute the whole report.
adjustmentType可选string | |
overrides必填ProfitInputOverride[] | One override group per target ASIN set. |
ProfitLineKind可选值 · 8
One deductible economic line between selling price and unit profit.
ProgressTaskStage可选值 · 3
ProgressiveReportSnapshot18
Everything a reader needs about a V3 report at one committed revision.
created可选string | |
updated可选string | |
formatVersion可选string | Frozen V3 read-model format identity. |
rootTaskId必填string | Owning keble-task identity. |
reportRevision必填integer | Revision this snapshot reads. |
amazonMarketplace必填AmazonMarketplace | PRODUCT market this report actually analysed. |
completeness必填ReportCompleteness | Completeness right now. |
taskStage必填ProgressTaskStage | Owning task stage. |
readyUnits可选ReportUnitDescriptor[] | Phases with an accepted artifact. |
missingUnits可选ReportGapDescriptor[] | Phases with an explicit typed gap. |
conclusion可选ReportConclusion | null | Business verdict, when one was reached. |
terminalState可选ReportTerminalState | null | Operational stop state, when the run stopped. |
listings可选ReportListingPage | null | First cursor page of listing summaries. |
listingSummaries可选ReportListingSummaryView[] | null | Optional UNSLICED listing summaries for the whole committed LISTING_BUILD cohort; None on the Keble-line read. |
estimationMethodology可选ReportEstimationMethodologyView | null | How every material verdict was reached. |
openMaterialQuestions可选ReportMaterialQuestion[] | Typed material questions awaiting an owner answer. |
updatedAt必填string | Instant the read revision was committed. |
seoIndexable可选boolean | Backend-owned crawlability decision. |
ProposalAttribution3
Why a proposal exists and which origin asked for it; display data that grants no authority.
originKind必填string | Opaque origin label, such as an Artifect kind. |
originRef必填string | Origin reference, such as an Artifect id. |
reason可选string | null | Short display reason, if any. |
ProposalDecline3
Who declined an open proposal, when, and their optional display reason.
actor必填StoreActorRef | Verified actor that declined the proposal. |
declinedAt必填string | Instant the proposal was declined. |
reason可选string | null | Display reason for declining. |
ProposalFiling2
The two ids of one FiledApproval an artifect keeps: what to view and what to revert.
proposalId必填string | |
inboxItemId必填string |
ProposalRef2
Reference to the exact immutable proposal preview shown to a human.
source必填string | |
id必填string |
ProposalState可选值 · 5
Where a proposal stands in its one-time approval and apply lifecycle.
ProposalTarget可选值 · 2
What a model proposal is asked for.
ProposalView4
The response shared by every proposal route: stored proposal plus derived action diffs.
proposal必填ActionProposal | Stored proposal, preview or applied result. |
diffs必填ActionDiff[] | One derived diff per action, in batch order. |
applyScopes可选string[] | null | Each scope:level that approving (applying) this proposal needs, from the same access check approval runs; null when not stated. |
declineScopes可选string[] | null | Each scope:level that declining this proposal needs, from the same access check decline runs; null when not stated. |
Propose4
Ask the model for a new proposal, steered by a note (today's REFINE answer, and add-dimension).
type可选string | |
actionKey必填string | |
target必填ProposalTarget | |
note可选string |
Provenance7
Record non-provider-identifying capture facts attached to an entity.
capturedAt必填string | |
sourceChangedAt可选string | null | |
sourceRequestId可选string | null | |
artifactIds可选string[] | |
estimated可选boolean | |
confidence可选number | null | |
readFields可选string[] | null |
ProviderAction6
One requested provider change; its live before-value is read at apply time, not previewed.
actionKey必填string | Caller-owned key aligning outcomes with this action. |
actionTypeKey必填string | The declared action type to perform. |
account必填AccountRef | Provider account the change targets. |
target必填EntityRef | |
change必填JsonValue | The requested change payload. |
baseVersion可选string | null | Live token the caller based this draft on. |
ProviderFailureCode可选值 · 7
The finite, sanitized provider failure vocabulary (consumers never parse provider text).
ProviderIssue8
A provider refusal or failure, carried as data instead of raised as an error.
object可选string | Fixed tag marking this object as a provider issue. |
kind必填IssueKind | Why the provider refused or failed the call. |
permission可选Permission | null | The missing permission; only for a permission-missing issue. |
credential可选Credential | null | The updatable value to renew; only for an auth-invalid issue that names one. |
retryAfter可选string | null | When to retry a wait-style issue; none uses the default back-off. |
providerCode可选string | null | The provider's own code, kept for support. |
providerMessage可选string | The provider's text, kept for support; never a secret. |
resolution可选Resolution | Who must resolve it; derived from kind and permission. |
ProviderRegion可选值 · 3
Sales region chosen before consent.
QueryPage5
One bounded aggregation result page, reusing the shared cursor/total contract.
rows必填QueryRow[] | Rows in this page. |
nextCursor可选string | null | Continuation cursor; null on the last page. |
totalRows必填integer | Rows matching the whole read, across all pages. |
emptyReason可选string | null | Why this page is empty and what selection or source to check. |
object可选string | Document type: aggregation query page. |
QueryRequest5
Select a logical target and optionally narrow the authenticated owner's stores/accounts.
target必填QueryTarget | Catalog fact family to read, or METRIC_DAYS for calculated daily values. |
storeIds可选string[] | Stores to include; empty selects the asserted owner's stores. |
accountIds可选string[] | Accounts to include within those stores; empty selects all their accounts. |
pipeline必填QueryStage[] | Read-only aggregation stages over the selected logical rows. |
page可选PageRequest | Page size and continuation cursor for this exact read. |
QueryRow0
没有字段。
QueryStage0
没有字段。
QueryTarget以下之一 · 2
QuoteBlock2
One pull quote or customer quote the merchant supplied.
kind可选string | |
text必填string |
RadialGradient2
A fill from the box centre to its farthest corner for a vignette or spotlight.
stops必填GradientStop[] | |
gradient可选string |
RangeValue5
One range an assessment produced for a cell, with its own evidence and references.
label必填string | |
low必填number | string | |
high必填number | string | |
evidence可选string | |
references可选SourceReference[] |
RankingWindow2
Identify one calendar ranking-board edition without a trend date span.
windowType必填RankingWindowType | |
windowValue必填string |
RankingWindowType可选值 · 3
Name calendar editions for provider ranking boards, not metric periods.
RatioCombine3
Range value = sum(numerator) / sum(denominator) over the same days and entity.
kind可选string | Range combination: ratio of summed operands. |
numerator必填string | Metric summed for the ratio's numerator. |
denominator必填string | Metric summed for the ratio's denominator. |
RecordAddress3
The ONE public record address: one analyzed record's kind and key.
kind必填AnalyzedRecordKind | |
recordKey必填string | |
seriesWindow可选DateWindow | null | Inclusive date window for an opt-in record-level metric series; null requests no series. |
RecordDetail17
A public detail object for one analyzed record.
object必填string | Public object discriminator. |
recordKind必填AnalyzedRecordKind | Record family. |
recordKey必填string | Stable record key. |
channel必填Channel | null | Source channel, when applicable. |
freshness可选RecordFreshnessTimes | |
observedAt可选string | null | When the pinned revision's facts were observed (capture instant); null when unknown. Distinct from freshness.last_checked_at. |
externalId可选string | null | Channel-native id of the source subject (the ASIN of an Amazon product), when stored. |
market可选string | null | ISO 3166-1 alpha-2 market of the source subject, when stored. |
label可选string | null | Readable display label, when known. |
relations可选RelationRef[] | Observed relations to other served nodes. |
unlinkedMentions可选UnlinkedMention[] | Claims of the record that name an entity no held record matched; at most 16. |
fields必填object | Authorized record scalar fields. |
absentFields可选string[] | null | Recipe fields with DIC FieldState.ABSENT: read but empty, unlike fields not read; omitted when unknown. |
fieldValues可选object | null | Effective values per field code with their basis and inference; omitted when not read. |
concepts必填ConceptRef[] | Concepts attached to the record. |
metrics可选MetricObservation[] | Latest typed observation heads for this record; at most 128. |
series可选MetricObservation[] | Opt-in dated observations for the requested window; at most 32 points. |
RecordFieldValue3
ONE stored field value together with where that value came from.
value必填string | integer | number | string | boolean | The stored scalar value; money stays an exact major-unit Decimal. |
basis必填ValueBasis | Where the value came from: OBSERVED or INFERRED. |
inferred可选InferredFact | null | Provenance of an inferred value; explicitly null when the source stated it. |
RecordFreshnessTimes3
Stored, pinned freshness facts of one current material revision.
sourceChangedAt可选string | null | |
lastCheckedAt可选string | null | |
lastNewValueAt可选string | null |
RectGeometry2
A rectangle filling the box; corner_radius in pixels (badges, panels).
kind可选string | |
cornerRadius可选number |
RedeemCodeRefusalReason可选值 · 10
Finite refusal facts for code updates, redemption and trial application.
ReferencesDetailValue4
A REFERENCES detail row: the cell's deduplicated source references.
object可选string | |
kind可选string | |
key必填string | |
references可选SourceReference[] |
ReferencesRow1
Every source reference of the cell's assessments and items, deduplicated.
kind可选string |
Refusal3
One typed refusal: the code, the request field it concerns, and one DP-worded sentence.
code必填RefusalCode | Stable refusal code. |
field可选string | string | null | Request field the refusal concerns; null when it concerns the whole request. |
detail必填string | Safe explanation of the refusal. |
RefusalCode可选值 · 24
THE ONE refusal vocabulary: every way DP declines to serve a request or a plan as asked, in a code an agent can act on.
RelationClause7
A HOP along a relation — it binds a `RelationBinding`, and its index is what a `FeatureClause` with `on=TARGET` points at.
kind必填string | |
relation必填AnalyzedRelationKind | |
direction必填string | |
targetKind必填NodeKind | ConceptKind | |
targetRefs可选NodeRef[] | |
targetWindow可选ResolvedWindow | null | |
targetChannel可选Channel | null |
RelationHop3
ONE typed step of a relation path, so an answer can say HOW two records were connected instead of asserting that they are.
relation必填AnalyzedRelationKind | The relation this hop traverses. |
fromKey必填string | Analyzed key of the hop's subject node. |
toKey必填string | Analyzed key of the hop's object node. |
RelationRef13
One typed relation shared by analyzed details and public node results.
stance可选ClaimStance | null | What the source item does toward the named entity in the cited claim; null when no claim is cited, the claim predates mention capture, or (on a relation) the edge's basis is SIMILAR (its claim names no such record). |
mainSubject可选boolean | null | Whether the cited claim names what the source item mainly promotes or is about; null when stance is null. |
emotion可选ClaimEmotion | null | How the source item feels about the named entity in the cited claim, STRONGLY_NEGATIVE to STRONGLY_POSITIVE; null when stance is null. |
phrase可选string | null | The source item's own words showing how it brings the named entity up, from the cited claim; null when not found verbatim, visual only, captured before mention capture, (on a relation) the basis is SIMILAR, or no claim is cited. |
relation必填AnalyzedRelationKind | Canonical relation joining the record to its other end. |
direction必填string | Direction of the relation relative to the record: OUT or IN. |
other必填NodeRef | Scoped reference to the node at the relation's other end. |
otherLabel可选string | null | Readable label of the related node, when known. |
otherRecordKey可选string | null | Analyzed record key of the related node when served. |
evidence必填string | Stored citation that supports the relation. |
basis必填EvidenceBasis | Evidence basis of this relation: RECORDED, MENTIONED or SIMILAR. |
placements可选SearchPlacement[] | Display placements carried by a RANKED_FOR relation; empty otherwise. |
metrics可选MetricObservation[] | Metric observations carried by any relation kind. |
RelativeTargetBidChange2
A percentage change of the row's observed keyword, target or default bid.
kind可选string | |
percentChange必填number | string |
RemoveBlock3
Remove one block from a section.
action可选string | |
sectionKey必填string | |
blockKey必填string |
RemoveDesign2
Remove any board object; HAS_VARIANTS while a variant or plan still names it.
action可选string | |
designId必填string |
RemoveItems3
Delete items; their placements go with them (a placement of a missing item reads as nothing).
type可选string | |
actionKey必填string | |
keys必填string[] |
RemoveLayers3
Remove layers (and a group's children with it).
action可选string | |
designId必填string | |
layerIds必填string[] |
RemoveScope可选值 · 2
The targets a REMOVE action is declared to be allowed to delete.
RemoveSection2
Remove one section from the document; publish then removes its placement.
action可选string | |
sectionKey必填string |
RenderFormat可选值 · 3
Export encodings the stores accept and we produce (WEBP: agent previews and owner downloads).
ReorderViews5
Put the viewer's saved views in a new order (every existing view id, once).
type可选string | |
actionKey必填string | |
viewer必填ViewerRef | |
expectedRevision必填integer | |
viewIds必填string[] |
ReportAdjudication8
The adjudicator's structured choice between the two analyses.
created可选string | |
updated可选string | |
candidate必填ReportAdjudicationCandidate | The single outcome chosen from the closed candidate set. |
reasonCode可选ReportReasonCode | null | Closed-set reason for a concluding candidate; None for CONTINUE or CONCLUDE_SUITABLE. |
userReasoning必填string | null | Reader-facing justification of the choice. |
evidenceRefs可选ReportEvidenceRef[] | Citations into accepted artifacts. |
overruledDissent可选string | What the losing analysis argued and why it was overruled. |
proseWithheld可选boolean | True only where a public read withheld this adjudication's prose. |
ReportAdjudicationCandidate可选值 · 4
The closed set of outcomes an adjudicator may choose.
ReportAnalystFinding5
One structured finding from a risk or opportunity analyst.
created可选string | |
updated可选string | |
headline必填string | Short headline of the finding. |
reasoning必填string | Why the cited evidence produces this finding. |
evidenceRefs可选ReportEvidenceRef[] | Citations into accepted artifacts. |
ReportAnalystRole可选值 · 3
Which independently prompted role produced a structured analysis.
ReportClosureKind可选值 · 2
Whether the report closed before or after every required phase ran.
ReportCohortBandCount4
How many members fall into ONE margin band.
created可选string | |
updated可选string | |
band必填ReportCohortMarginBand | The margin band. |
count必填integer | Members in the band. |
ReportCohortBrandAge可选值 · 3
Whether a brand entered the analysed market recently.
ReportCohortBrandRow9
ONE brand of the population with its lead product.
created可选string | |
updated可选string | |
brand必填string | Provider brand. |
brandAge必填ReportCohortBrandAge | NEW, OLD or UNKNOWN. |
enteredAt可选string | null | Earliest population release of the brand. |
memberCount必填integer | |
newReleaseCount必填integer | |
profitableNewReleaseCount必填integer | |
lead必填ReportCohortMemberRow | Member with the highest monthly units (None last, then ASIN). |
ReportCohortBrandScope可选值 · 3
Which brands one brand-scope summary covers.
ReportCohortBrandScopeView18
New-release outcomes of the brands in ONE brand scope.
created可选string | |
updated可选string | |
scope必填ReportCohortBrandScope | Which brands are covered. |
brandCount必填integer | |
brandNames可选string[] | |
brandsWithNewReleaseCount必填integer | |
newReleaseCount必填integer | |
profitableNewReleaseCount必填integer | |
notProfitableNewReleaseCount必填integer | |
unresolvedNewReleaseCount必填integer | |
profitableNewReleasedCount必填integer | |
profitableNewReleasedOnOldAsinCount必填integer | |
newReleaseSuccessRate必填ReportSuccessRate | Profitable / determinate new releases. |
newReleaseFailureRate必填ReportSuccessRate | Not profitable / determinate new releases. |
profitableBrandNames可选string[] | Brands with at least one profitable new release. |
notProfitableBrandNames可选string[] | Brands with at least one not-profitable new release. |
successByBrand可选ReportCohortBrandSlice[] | Profitable new releases: top brands, then OTHER. |
failureByBrand可选ReportCohortBrandSlice[] | Not-profitable new releases: top brands, then OTHER. |
ReportCohortBrandSlice5
One donut slice of new releases by brand.
created可选string | |
updated可选string | |
brand可选string | null | Brand; None = OTHER. |
count必填integer | New releases in the slice. |
otherBrands可选string[] | Brands folded into the OTHER slice. |
ReportCohortMarginBand可选值 · 8
One [gte, lt) band of the expected-scenario margin ratio, or OTHER.
ReportCohortMarginDistribution5
The margin-band histogram of one member population, under two rules.
created可选string | |
updated可选string | |
populationCount必填integer | Members partitioned. |
byResolvedSales必填ReportCohortBandCount[] | OTHER = no margin OR an unresolved sale; 8 bands in order. |
byKnownMargin必填ReportCohortBandCount[] | OTHER = no margin only; 8 bands in order. |
ReportCohortMemberRow22
ONE competitor as every cohort table, card and brand lead shows it.
created可选string | |
updated可选string | |
economicListingKey可选string | null | Internal listing identity; owner reads only. |
publicListingHandle可选string | null | Opaque public listing handle; public reads only. |
asin必填string | DISPLAY ONLY provider ASIN. |
title可选string | null | Provider title. |
brand可选string | null | Provider brand. |
imageUrl可选string | null | Primary image. |
ratingInt可选integer | null | Star rating in tenths (0-50). |
reviewCount可选integer | null | Provider review count. |
releasedAt可选string | null | Credible observed release instant. |
releasedType可选ProductReleasedType | null | Retained lifecycle classification. |
isProfitable可选boolean | null | The report's profitable flag; None unresolved. |
sellingPrice可选MinorUnitMoney | null | Expected-scenario selling price. |
monthlySold可选integer | null | Latest observed monthly units. |
monthlyRevenue可选MinorUnitMoney | null | Selling price x monthly units. |
expectedProfit可选MinorUnitMoney | null | Expected-scenario unit profit. |
monthlyProfit可选MinorUnitMoney | null | Expected unit profit x monthly units. |
margin可选number | string | null | Expected-scenario margin ratio. |
profitableCostBasis可选ReportPurchasingCostProvenance | null | Purchase-cost provenance the profitable flag was priced with. |
economicsCostBasis可选ReportPurchasingCostProvenance | null | Purchase-cost provenance the expected scenario used. |
profitWithheld可选boolean | True only where a public read withholds per-row profit. |
ReportCohortPeriodCount11
New releases released in ONE UTC calendar period, by type and outcome.
created可选string | |
updated可选string | |
periodStart必填string | Inclusive UTC period start. |
periodEnd必填string | Exclusive UTC period end. |
newProfitable必填integer | |
newNotProfitable必填integer | |
newUnresolved必填integer | |
newOnOldProfitable必填integer | |
newOnOldNotProfitable必填integer | |
newOnOldUnresolved必填integer | |
marginBands可选ReportCohortBandCount[] | Resolved-sales bands; empty before economics. |
ReportCohortRankTable6
One profit ranking: the top rows plus the size of the ranked population.
created可选string | |
updated可选string | |
key必填ReportCohortRankTableKey | Which ranking this is. |
populationCount必填integer | Full filtered population. |
rows可选ReportCohortMemberRow[] | Ranked rows with a known monthly profit. |
profitWithheld可选boolean | True only where a public read withheld this table's rows. |
ReportCohortRankTableKey可选值 · 4
Which profit ranking one rank table is.
ReportCohortStandoutCase4
ONE STANDOUT pick as a case card: its listing row plus the agent's reason.
created可选string | |
updated可选string | |
row必填ReportCohortMemberRow | The pick's listing representative. |
reason必填string | null | Why this product stands out; None on owner-costed public reads. |
ReportCohortSubjectDisplay8
How the report's OWN product looks on the cover: display facts only.
created可选string | |
updated可选string | |
asin必填string | DISPLAY ONLY subject ASIN. |
title可选string | null | Provider title. |
brand可选string | null | Provider brand. |
imageUrl可选string | null | Primary image. |
ratingInt可选integer | null | Star rating in tenths (0-50). |
reviewCount可选integer | null | Provider review count. |
ReportCompactAbsence5
One requested section that is explicitly unavailable, with its reason.
created可选string | |
updated可选string | |
section必填ReportCompactSection | Section that is unavailable. |
reason必填ReportCompactAbsenceReason | Typed reason it is absent. |
detail必填string | Reader-facing explanation, safe to display. |
ReportCompactAbsenceReason可选值 · 4
Why a requested section is not available as data.
ReportCompactAnalysis7
One independently prompted analyst's structured output.
created可选string | |
updated可选string | |
role必填ReportAnalystRole | Which analyst produced this. |
summary必填string | null | One-paragraph summary; None only when prose_withheld. |
proseWithheld可选boolean | True only where a public owner-costed read withheld this prose. |
findings可选ReportCompactFinding[] | Structured findings, strongest first. |
missingEvidence可选string[] | Evidence this analyst says it lacked. |
ReportCompactCitation5
One citation into an accepted artifact, without its artifact key.
created可选string | |
updated可选string | |
phase必填ReportPhase | Phase whose accepted artifact is cited. |
claim必填string | The statement the artifact is cited for. |
strength必填ReportEvidenceStrength | How strongly it supports. |
ReportCompactConclusion9
The report's verdict in the smallest form a tool can reason over.
created可选string | |
updated可选string | |
verdict必填ReportVerdict | The business verdict reached. |
reasonCode可选ReportReasonCode | null | Closed-set reason; None only for SUITABLE. |
checkpoint必填ReportPhase | Phase the verdict was reached at. |
policyRevision可选string | null | Frozen policy revision; owner reads only, never public. |
userReasoning必填string | null | Reader-facing explanation; None only when prose_withheld. |
proseWithheld可选boolean | The adjudication's flag: True only where a public read of an owner-costed report withheld its prose. |
isPartial必填boolean | Whether the report closed before every phase ran. |
ReportCompactCorroboration6
One piece of evidence supporting or extending the lifecycle window.
created可选string | |
updated可选string | |
kind必填ReportCorroborationKind | Which evidence class this is. |
statement必填string | The concrete claim being made. |
sourceRef必填string | Where the claim was observed. |
observedAt可选string | null | Instant the claim was observed, when known. |
ReportCompactEconomics6
Market-level economics as a tool sees it.
created可选string | |
updated可选string | |
determinateListingCount必填integer | Listings with a defensible profit envelope. |
profitableListingCount必填integer | Listings whose expected profit is positive. |
unresolvedListingCount必填integer | Listings that could not be costed. |
successRates可选ReportSuccessRateProjection | null | Three-denominator market success rates. |
ReportCompactEstimation5
How the report's material inputs were resolved.
created可选string | |
updated可选string | |
verdictCounts可选object | EstimateSource value -> member count. |
unresolvedCount必填integer | Members with unresolved inputs. |
policyFingerprint必填string | Digest of thresholds plus policies. |
ReportCompactFinding5
One analyst finding with the citations it rests on.
created可选string | |
updated可选string | |
headline必填string | Short headline of the finding. |
reasoning必填string | Reader-facing reasoning for the finding. |
citations可选ReportCompactCitation[] | Citations supporting this finding. |
ReportCompactGap6
One explicit hole a tool must report rather than fill in.
created可选string | |
updated可选string | |
phase必填ReportPhase | Phase with no accepted artifact. |
kind必填ReportGapKind | Typed reason this phase is missing. |
detail必填string | Reader-facing explanation. |
resumePhase可选ReportPhase | null | Phase a resumable gap restarts from. |
ReportCompactLifecycle7
The market's lifecycle position as a tool sees it.
created可选string | |
updated可选string | |
verdict必填ReportLifecycleVerdict | Lifecycle position verdict. |
windowMonths必填integer | Frozen lifecycle window in months. |
earliestEntryAgeMonths可选integer | null | Whole months since the earliest entry. |
corroborationCount必填integer | Valid corroboration items supporting an extension. |
reasoning必填string | Deterministic explanation of the verdict. |
ReportCompactListing11
One comparable product as a tool sees it.
created可选string | |
updated可选string | |
economicListingKey必填string | Operational listing identity. |
representativeAsin必填string | DISPLAY ONLY provider ASIN. |
memberAsins可选string[] | DISPLAY ONLY member ASINs, for external lookup. |
outcome必填ReportListingOutcome | Listing-level verdict. |
memberCount必填integer | Members in the listing. |
familyEntryAgeMonths可选integer | null | Whole months since the family entered. |
expectedProfit可选MinorUnitMoney | null | Expected profit; None when not costed. |
marginLow可选number | null | Lower margin bound; None when not costed. |
marginHigh可选number | null | Upper margin bound; None when not costed. |
ReportCompactMaterialGap6
One member whose material inputs could not be resolved, and why.
created可选string | |
updated可选string | |
memberKey可选string | null | Member the gap belongs to, when member-scoped. |
economicListingKey可选string | null | Listing the gap belongs to, when listing-scoped. |
reason必填string | Typed upstream gap reason. |
detail必填string | Reader-facing explanation. |
ReportCompactQuestion5
One material question this revision is waiting on an owner to answer.
created可选string | |
updated可选string | |
economicListingKey必填string | Listing the question is about. |
fields可选ReportMaterialField[] | Which material inputs are being asked for. |
reason必填string | Why the answer is needed. |
ReportCompactSection可选值 · 6
The sections an agent query tool may ask a report for.
ReportCompactView15
Everything an agent query tool may read about one report.
created可选string | |
updated可选string | |
version必填ReportVersion | STORED report format identity. |
rootTaskId必填string | Owning keble-task identity. |
revision必填integer | Revision read; 0 for a V2 report. |
completeness必填ReportCompleteness | Completeness at read time. |
amazonMarketplace可选AmazonMarketplace | null | Product-market the report analysed. |
updatedAt可选string | null | Instant the read revision was committed. |
conclusion可选ReportCompactConclusion | null | Verdict, when one was reached. |
listings可选ReportCompactListing[] | Comparable products the report covered. |
lifecycle可选ReportCompactLifecycle | null | Market lifecycle position, when built. |
estimation可选ReportCompactEstimation | null | Material-input resolution, when built. |
economics可选ReportCompactEconomics | null | Market economics, when built. |
gaps可选ReportCompactGap[] | Explicit holes still open in the report. |
absences可选ReportCompactAbsence[] | Sections that are explicitly unavailable. |
ReportCompleteness可选值 · 6
How complete the report is RIGHT NOW, as an explicit persisted fact.
ReportConclusion12
The report's BUSINESS verdict with its full, auditable justification.
created可选string | |
updated可选string | |
verdict必填ReportVerdict | The business verdict reached. |
checkpoint必填ReportPhase | Phase at which the verdict was reached. |
closure必填ReportClosureKind | Whether this closure happened before the final phase. |
policyRevision可选string | null | Frozen policy revision; owner reads only, never public. |
reasonCode可选ReportReasonCode | null | Closed-set reason; None only for SUITABLE. |
userReasoning必填string | null | Reader-facing explanation of the verdict; None only when the adjudication's prose_withheld is True (owner-costed public read). |
evidenceRefs可选ReportEvidenceRef[] | Citations into accepted artifacts. |
riskAnalysis必填ReportRiskAnalysis | Independent risk analysis that fed the adjudication. |
opportunityAnalysis必填ReportOpportunityAnalysis | Independent opportunity analysis that fed the adjudication. |
adjudication必填ReportAdjudication | Structured adjudication that chose this outcome. |
ReportConclusionEvidenceView9
The verdict PLUS the reasoning chain that produced it.
created可选string | |
updated可选string | |
conclusion必填ReportCompactConclusion | The verdict reached. |
citations可选ReportCompactCitation[] | Citations the adjudicated verdict rests on. |
analyses可选ReportCompactAnalysis[] | Risk and opportunity analyses, in that order. |
riskBlocksSuitability必填boolean | Whether the risk analyst blocked a SUITABLE verdict. |
opportunitySupportsContinuation必填boolean | Whether the opportunity analyst supported continuing. |
adjudicationCandidate必填ReportAdjudicationCandidate | Outcome the adjudicator chose. |
overruledDissent必填string | What the adjudicator overruled; empty when none. |
ReportCorroborationKind可选值 · 2
The two independent evidence classes that may extend an older market.
ReportDecisionType可选值 · 5
One question the report may park on for a typed agent answer.
ReportEstimateConfidence可选值 · 4
Confidence attached to one member's effective material range.
ReportEstimationEvidenceView7
How the report resolved its material inputs, and what stayed open.
created可选string | |
updated可选string | |
estimation必填ReportCompactEstimation | Resolution counts. |
unresolvedMemberKeys可选string[] | Members whose material inputs stayed unresolved. |
excludedMemberKeys可选string[] | Members excluded as mismatched. |
completenessGaps可选ReportCompactMaterialGap[] | Typed holes in the material evidence. |
openQuestions可选ReportCompactQuestion[] | Material questions awaiting an owner answer. |
ReportEstimationMethodologyView6
Report-level record of how every material verdict was reached.
created可选string | |
updated可选string | |
verdictCounts可选object | EstimateSource value -> member count. |
excludedMismatchedMemberKeys可选string[] | Internal member keys excluded as mismatched; owner reads only. |
completenessGaps可选ReportMaterialGapView[] | Explicit unresolved holes. |
provenance可选ReportEstimationProvenance | null | Replay identity; owner reads only, never public. |
ReportEstimationProvenance8
The REPLAY identity of one estimation revision — never reader content.
created可选string | |
updated可选string | |
policyFingerprint必填string | Digest of thresholds plus policies. |
researchFingerprint必填string | Digest of the research selection. |
evidenceFingerprint必填string | Digest of every evidence key used. |
completenessFingerprint必填string | Digest of the completeness gaps. |
researchPolicyRevision必填string | Frozen MaterialResearchSelectionPolicy revision. |
ownerResolutionFingerprint可选string | Digest of the owner answers applied to this revision. |
ReportEvidenceQuery2
Ask for the evidence behind the verdict, the lifecycle or the estimation.
object可选string | |
topic必填string |
ReportEvidenceRef6
A citation into ONE accepted artifact of this report.
created可选string | |
updated可选string | |
phase必填ReportPhase | Phase whose accepted artifact is cited. |
artifactKey可选string | null | Immutable artifact key; owner reads only, never public. |
claim必填string | The concrete claim this artifact supports. |
strength必填ReportEvidenceStrength | How strongly the cited artifact supports the claim. |
ReportEvidenceStrength可选值 · 3
How strongly one cited artifact supports the statement that cites it.
ReportExcludedGroup5
One group of listings removed from the rate cohort, and why.
created可选string | |
updated可选string | |
reason必填string | Policy reason for the exclusion. |
count必填integer | Listings removed for this reason. |
economicListingKeys可选string[] | Operational identities of the removed listings. |
ReportFamilyEntrySource可选值 · 3
Which observation class supplied a family's earliest credible entry.
ReportFinalOverviewSectionView6
The closing headline and summary of a fully built report.
created可选string | |
updated可选string | |
kind可选string | |
headline必填string | null | Reader-facing headline; None only when withheld. |
summary必填string | null | Reader-facing closing summary; None only when withheld. |
proseWithheld可选boolean | True only where a public read withheld the overview prose. |
ReportGapDescriptor7
One EXPLICIT hole in the report, with the reason it is a hole.
created可选string | |
updated可选string | |
phase必填ReportPhase | Phase with no accepted artifact. |
kind必填ReportGapKind | Typed reason this phase is missing. |
detail必填string | Reviewer-visible explanation of the gap. |
awaitingInputKey可选string | null | Stable key of the input this gap waits on. |
resumePhase可选ReportPhase | null | Phase the backend should run to continue. |
ReportGapKind可选值 · 5
Why one phase has no accepted artifact yet.
ReportJudgmentAnswer4
The create-time conclusion for one revision (07a §2.1).
decisionType可选string | |
verdict可选ReportJudgmentVerdict | null | Required iff the question's verdict is open. |
sections必填ReportJudgmentSection[] | Exactly the question's section kinds, once each. |
overview必填ReportOverviewEvidence | Headline and summary. |
ReportJudgmentEvidenceItem3
One citable accepted artifact: its block from build_evidence_digest.
itemKey必填string | The artifact_key a ReportEvidenceRef cites. |
phase必填ReportPhase | Phase of the cited artifact. |
evidence必填string | Rendered evidence block. |
ReportJudgmentQuery1
Ask for the HEAD revision's conclusion question, so an agent can cite it.
object可选string |
ReportJudgmentSection2
One old-page interpretation slot's text; number-free.
sectionKind必填ReportNarrativeSectionKind | Old-page slot. |
body必填string | Number-free reader text. |
ReportJudgmentVerdict3
The three analyses one agent now writes.
riskAnalysis必填ReportRiskAnalysis | Risk analysis. |
opportunityAnalysis必填ReportOpportunityAnalysis | Opportunity analysis. |
adjudication必填ReportAdjudication | Candidate, reason code and citations. |
ReportLengthUnit可选值 · 2
The length units a material question may be asked and answered in.
ReportLifecycleEvidenceView8
The market's lifecycle position PLUS the evidence behind the verdict.
created可选string | |
updated可选string | |
lifecycle必填ReportCompactLifecycle | Lifecycle position. |
evaluatedAt必填string | Frozen instant ages were measured at. |
earliestEntryAt可选string | null | Earliest credible family entry, when known. |
contributingListingKeys可选string[] | Listings that fixed the earliest entry. |
corroboration可选ReportCompactCorroboration[] | Evidence supporting or extending the window. |
droppedCorroborationCount可选integer | null | Search results not retained; None for historical artifacts. |
ReportLifecycleVerdict可选值 · 4
Where the market sits against the frozen lifecycle window.
ReportListingCohortSectionView18
The competitor cohort of ONE revision, ready for the old-report layout.
created可选string | |
updated可选string | |
kind可选string | |
evaluatedAt必填string | Frozen INPUT_FREEZE evaluation instant. |
memberCount必填integer | Population ASIN members. |
excludedMemberCount必填integer | Loaded market members excluded by policy. |
newReleaseCount必填integer | Population new releases. |
economicsReady必填boolean | Whether LISTING_ECONOMICS is accepted. |
marginAll可选ReportCohortMarginDistribution | null | Every population member; by_resolved_sales puts an unresolved sale in OTHER, by_known_margin only a missing margin. |
marginNew可选ReportCohortMarginDistribution | null | Population new releases; by_resolved_sales puts an unresolved sale in OTHER, by_known_margin only a missing margin. |
rankTables可选ReportCohortRankTable[] | Four profit rankings in key order. |
timelineYearly可选ReportCohortPeriodCount[] | New releases per UTC calendar year, oldest first. |
timelineMonthly可选ReportCohortPeriodCount[] | New releases per UTC calendar month, oldest first. |
brandScopes可选ReportCohortBrandScopeView[] | ALL, NEW_BRANDS and OLD_BRANDS, in that order. |
oldBrandNewReleaseShare必填ReportSuccessRate | OLD_BRANDS new releases / ALL new releases. |
brands可选ReportCohortBrandRow[] | Brands by member count desc, then name. |
standoutCases可选ReportCohortStandoutCase[] | null | None = no STANDOUT artifact; () = ran with no picks. |
subject可选ReportCohortSubjectDisplay | null | Subject product display facts; None when not loaded. |
ReportListingDetailView7
One listing with its members, evidence counts, and economics.
created可选string | |
updated可选string | |
summary必填ReportListingSummaryView | The paged summary view. |
members必填ReportListingMemberView[] | Every projected member of this listing. |
outcomeReasoning必填string | Deterministic explanation of the listing verdict. |
groupingEvidenceCount必填integer | Number of retained pair-scoring evidence records. |
economics可选ReportListingEconomicsView | null | Listing economics when the phase produced them. |
ReportListingEconomicsView10
The economics of ONE listing, with scenario ranges kept honest.
created可选string | |
updated可选string | |
economicListingKey必填string | Operational listing identity. |
sellingPrice可选ReportMoneyPoint | null | Observed selling price of the representative. |
profit可选ReportMoneyEnvelope | null | Profit envelope; None when inputs are unresolved. |
purchasingCost可选ReportPurchasingCostView | null | Effective purchasing cost with its authorisation. |
margin可选ReportRatioRange | null | Margin range with its explicit range kind. |
scenarios可选ProfitEnvelope | null | Every coherent scenario waterfall, verbatim. |
sizing可选ReportListingSizingView | null | Physical size and fee tier behind the scenarios. |
unresolvedDetail可选string | null | Why this listing has no economics, when it has none. |
ReportListingMemberKind可选值 · 2
Whether a projected member was actually loaded from the provider.
ReportListingMemberView10
One member of an economic listing, projected for display and citation.
created可选string | |
updated可选string | |
memberKey必填string | Operational member identity. |
asin必填string | DISPLAY ONLY provider ASIN. |
kind必填ReportListingMemberKind | LOADED or PLACEHOLDER. |
isRepresentative必填boolean | Whether this member is the listing's representative. |
excludedReason可选string | null | Policy exclusion reason, when excluded. |
excludedDetail可选string | null | Reviewer-visible exclusion explanation. |
releasedAt可选string | null | Credible observed release instant. |
ageMonths可选integer | null | Whole months since this member's release. |
ReportListingOutcome可选值 · 3
Whether a listing proves success, proves a failed launch, or neither.
ReportListingPage5
One cursor page of listing summaries.
created可选string | |
updated可选string | |
items必填ReportListingSummaryView[] | Ordered listing summaries in this page. |
nextCursor可选string | null | Opaque cursor for the next page; None at the end. |
totalKnown必填integer | Total listings known at the read revision. |
ReportListingQuery2
Ask for the one listing that CONTAINS an Amazon ASIN.
object可选string | |
asin必填string | Any member ASIN. |
ReportListingSizingView9
What the report shows about ONE listing's physical size and fee tier.
created可选string | |
updated可选string | |
accepted必填SizingDetail | Sizing the expected scenario used. |
materialBounds可选ReportMaterialBoundsView | null | Accepted low/high physical correction range. |
materialSource可选EstimateSource | null | Provenance of the accepted correction. |
materialConfidence可选ReportEstimateConfidence | null | Confidence of the accepted correction. |
anomalyHeadlines可选string[] | Typed anomaly labels observed for this listing. |
tierProbeSizeTiers可选string[] | Size tiers of the retained fee-tier probes. |
reasoning可选string | null | Deterministic explanation of the accepted size. |
ReportListingSummaryView25
A listing as it appears in a paged list, for ONE audience at a time.
created可选string | |
updated可选string | |
economicListingKey可选string | null | Internal listing identity; owner reads only, never public. |
publicListingHandle可选string | null | Opaque public listing reference; public reads only. |
representativeMemberKey可选string | null | Internal member identity; owner reads only, never public. |
representativeAsin必填string | DISPLAY ONLY provider ASIN. |
representativeQuality必填ReportRepresentativeQuality | Whether a real sales signal chose the representative. |
marketplace可选AmazonMarketplace | null | Product marketplace this listing was analysed in. |
outcome必填ReportListingOutcome | Listing-level success verdict. |
memberCount必填integer | All members of the listing. |
loadedMemberCount必填integer | Members loaded from provider. |
excludedMemberCount必填integer | Members excluded by policy. |
familyEntryAt可选string | null | Earliest credible family entry instant. |
familyEntryAgeMonths可选integer | null | Whole months since the family entered. |
familyEntrySource必填ReportFamilyEntrySource | Which observation supplied the family entry. |
sellingPrice可选MinorUnitMoney | null | Expected-scenario selling price; None until costed. |
monthlySold可选integer | null | Representative member's latest observed monthly units. |
expectedProfit可选MinorUnitMoney | null | Expected-scenario profit; None until costed. |
margin可选number | string | null | Expected-scenario margin ratio; None until costed. |
title可选string | null | Representative member's provider title, read-time. |
brand可选string | null | Representative member's provider brand, read-time. |
imageUrl可选string | null | Representative member's primary image; None before 2.62.0. |
profitableCostBasis可选ReportPurchasingCostProvenance | null | Purchase-cost provenance the profitable flag was priced with; stored at LISTING_BUILD, None before 2.62.0. |
economicsCostBasis可选ReportPurchasingCostProvenance | null | Purchase-cost provenance the expected scenario used, owner answers included; read-time, None without economics. |
profitWithheld可选boolean | True only on a public owner-costed read, where per-row profit and margin are withheld rather than absent. |
ReportListingsQuery2
Ask for one cursor page of the report's comparable listings.
object可选string | |
cursor可选string | null | Previous page's next cursor. |
ReportMarketSectionView6
The market's success rates and the capital needed to enter it.
created可选string | |
updated可选string | |
kind可选string | |
successRates必填ReportSuccessRateProjection | Three-denominator market success rates. |
entryInvestment可选ReportMoneyPoint | null | Entry investment point plus peer benchmark. |
marginBenchmark可选ReportRatioRange | null | Peer margin benchmark for the covered cohort. |
ReportMassUnit可选值 · 2
The mass units a material question may be asked and answered in.
ReportMaterialBoundsView12
The effective low/high physical and purchasing-cost bounds of a member.
created可选string | |
updated可选string | |
lowLengthCm可选number | null | Lower length bound. |
lowWidthCm可选number | null | Lower width bound. |
lowHeightCm可选number | null | Lower height bound. |
lowWeightG可选number | null | Lower weight bound. |
highLengthCm可选number | null | Upper length bound. |
highWidthCm可选number | null | Upper width bound. |
highHeightCm可选number | null | Upper height bound. |
highWeightG可选number | null | Upper weight bound. |
lowUnitCost可选MinorUnitMoney | null | Lower purchasing unit cost bound. |
highUnitCost可选MinorUnitMoney | null | Upper purchasing unit cost bound. |
ReportMaterialCostAnswer2
One purchasing unit cost, as a point or an inclusive range.
low必填MinorUnitMoney | Lower purchasing unit cost bound. |
high必填MinorUnitMoney | Upper purchasing unit cost bound. |
ReportMaterialDimensionsAnswer4
The three physical axes of one product, with the unit they are in.
unit必填ReportLengthUnit | Unit the three axes are given in. |
length必填number | Longest axis, in unit. |
width必填number | Second axis, in unit. |
height必填number | Third axis, in unit. |
ReportMaterialEstimateView12
One member's effective material range with its provenance.
created可选string | |
updated可选string | |
estimateKey必填string | Stable identity of the upstream estimate. |
memberKey必填string | Operational member identity. |
economicListingKey必填string | Operational listing identity. |
source必填EstimateSource | Where the effective range came from. |
confidence必填ReportEstimateConfidence | Confidence in the range. |
unitCostSource可选EstimateSource | null | Where the purchasing cost came from, if judged. |
unitCostConfidence可选ReportEstimateConfidence | null | Confidence in the purchasing cost, if judged. |
bounds必填ReportMaterialBoundsView | Effective low/high bounds. |
anomalyHeadlines可选string[] | Typed anomaly labels observed for this member. |
reasoning必填string | Deterministic explanation of the verdict. |
ReportMaterialField可选值 · 5
One physical or cost input a report may have to ask its owner about.
ReportMaterialGapView6
One explicitly reported hole in the material picture.
created可选string | |
updated可选string | |
memberKey可选string | null | Internal member identity; owner reads only, never public. |
economicListingKey可选string | null | Internal listing identity; owner reads only, never public. |
reason必填string | Typed upstream gap reason. |
detail必填string | Inputs still unmeasured and excluded from profit figures. |
ReportMaterialQuestion12
One economic listing's unresolved material facts and safe choices.
created可选string | |
updated可选string | |
questionKey必填string | Stable question identity. |
economicListingKey必填string | Operational listing identity. |
fields必填ReportMaterialField[] | Inputs the answer must supply. |
lengthUnit可选ReportLengthUnit | Unit a dimensions answer must be given in. |
massUnit可选ReportMassUnit | Unit a weight answer must be given in. |
currency可选Currency | null | Currency a cost answer must be given in. |
observed可选ReportMaterialEstimateView | null | The estimate that is missing these inputs. |
analysed可选ReportMaterialBoundsView | null | The analysis's own low/high bounds for a disputed input; None when the analysis never established a range. |
suggestedResolutions可选ReportMaterialResolution[] | Server suggestions the owner may pick. |
reason必填string | Reviewer-visible reason the answer is needed. |
ReportMaterialResolution5
ONE typed answer to ONE material question.
source必填ReportMaterialResolutionSource | Whether the owner picked a suggestion or typed values. |
suggestionKey可选string | null | Stable key of the picked server suggestion. |
dimensions可选ReportMaterialDimensionsAnswer | null | Typed three-axis answer, when supplied. |
weight可选ReportMaterialWeightAnswer | null | Typed weight answer, when supplied. |
unitCost可选ReportMaterialCostAnswer | null | Typed purchasing unit cost answer, when supplied. |
ReportMaterialResolutionSource可选值 · 2
Where one owner answer came from.
ReportMaterialWeightAnswer2
One product's weight, with the unit it is expressed in.
unit必填ReportMassUnit | Unit the weight is given in. |
weight必填number | Product weight, in unit. |
ReportMoneyEnvelope5
An expected value with a DEFENSIBLE scenario range around it.
created可选string | |
updated可选string | |
expected必填MinorUnitMoney | Expected-scenario value. |
bounds必填ReportMoneyRange | Pessimistic/optimistic bounds. |
boundScenarioKeys必填any[] | Frozen scenario keys that produced the low and high bounds. |
ReportMoneyPoint4
One money value, optionally accompanied by a LABELLED peer benchmark.
created可选string | |
updated可选string | |
value必填MinorUnitMoney | The single defensible value. |
benchmark可选ReportMoneyRange | null | Separately labelled peer comparison range. |
ReportMoneyRange7
A money low/high pair that always states what kind of range it is.
created可选string | |
updated可选string | |
low必填MinorUnitMoney | Lower bound. |
high必填MinorUnitMoney | Upper bound. |
kind必填ReportRangeKind | Scenario bound or cohort benchmark. |
cohortLabel可选string | null | Peer cohort described; required for a benchmark. |
cohortSize可选integer | null | Peer cohort size; required for a benchmark. |
ReportNarrativeSection6
One rendered narrative section keyed by the phase it explains.
created可选string | |
updated可选string | |
sectionKey必填string | Stable section identity. |
sourcePhase必填ReportPhase | Phase whose artifact it explains. |
body必填string | null | Reader-facing prose; None only when prose_withheld. |
proseWithheld可选boolean | True only where a public read withheld this section's prose. |
ReportNarrativeSectionKind可选值 · 5
The FIVE old-page interpretation slots the report's prose fills (07a §2.3).
ReportNarrativeSectionView4
The rendered prose sections in display order.
created可选string | |
updated可选string | |
kind可选string | |
sections必填ReportNarrativeSection[] | Rendered narrative sections in display order. |
ReportOpportunityAnalysis7
Independent OPPORTUNITY analysis of the accepted artifacts.
created可选string | |
updated可选string | |
findings可选ReportAnalystFinding[] | Concrete opportunities, each with citations. |
missingEvidence可选string[] | Evidence the analyst needed but did not find in the artifacts. |
supportsContinuation必填boolean | Whether the opportunities justify continuing the analysis. |
summary必填string | null | One-paragraph opportunity summary. |
proseWithheld可选boolean | True only where a public read withheld this analysis' prose. |
ReportOverviewEvidence2
Closing headline and summary for the FINAL_OVERVIEW phase.
headline必填string | Reader-facing headline. |
summary必填string | Reader-facing closing summary. |
ReportOverviewQuery1
Ask for the report's typed, absence-complete overview.
object可选string |
ReportPhase可选值 · 14
The ordered phases a V3 report walks; each produces exactly one artifact.
ReportProfileEconomicFields10
The seller-setup fields that map onto a run's frozen economic premise.
suggestedPurchasingCost可选SuggestedPurchasingCost | null | The seller's own purchasing cost for one benchmark ASIN; never a Keble estimate. |
acosLowerbound可选integer | null | ACOS lower bound, whole percent. |
acosUpperbound可选integer | null | ACOS upper bound, whole percent. |
fixedLength可选number | null | Fixed length. |
fixedWidth可选number | null | Fixed width. |
fixedHeight可选number | null | Fixed height. |
fixedLengthUnit可选string | null | Unit of the fixed size; None means cm. |
fixedWeight可选number | null | Fixed weight. |
fixedWeightUnit可选string | null | Unit of the fixed weight; None means g. |
investmentDifficultyAmountThreshold可选MinorUnitMoney | null | Entry-budget threshold. |
ReportPurchasingCostProvenance可选值 · 2
WHERE one priced listing's effective purchase cost came from.
ReportPurchasingCostView8
The expected purchasing cost plus the evidence that AUTHORISED it.
created可选string | |
updated可选string | |
amount必填ReportMoneyPoint | Settled expected purchasing cost. |
source必填EstimateSource | Provenance of the costed line. |
estimateKey可选string | null | Material estimate that authorised the amount. |
confidence可选ReportEstimateConfidence | null | Confidence of the authorising material estimate. |
bounds可选ReportMoneyRange | null | Low/high unit-cost range the estimate allowed. |
reason可选string | null | Deterministic reasoning behind the amount. |
ReportRangeKind可选值 · 2
Whether a range describes THIS product or a peer cohort.
ReportRateAbsenceReason可选值 · 2
Why a cohort rate is a typed absence rather than a percentage.
ReportRatioRange8
A unitless low/high pair (for example a margin) with its range kind.
created可选string | |
updated可选string | |
low必填number | Lower bound as a unitless ratio. |
high必填number | Upper bound as a unitless ratio. |
kind必填ReportRangeKind | Scenario bound or cohort benchmark. |
cohortLabel可选string | null | Peer cohort described; required for a benchmark. |
cohortSize可选integer | null | Peer cohort size; required for a benchmark. |
boundScenarioKeys可选any[] | null | Frozen scenario keys behind low/high; required for a bound. |
ReportReasonCode可选值 · 7
The closed set of reasons a report did not end SUITABLE.
ReportRepresentativeQuality可选值 · 2
Whether the representative was chosen from a real sales signal.
ReportRetryEligibility可选值 · 3
Whether a terminated run may be retried, and by whom.
ReportRiskAnalysis7
Independent RISK analysis of the accepted artifacts.
created可选string | |
updated可选string | |
findings可选ReportAnalystFinding[] | Concrete risks, each with citations. |
missingEvidence可选string[] | Evidence the analyst needed but did not find in the artifacts. |
blockingUnsuitable必填boolean | Whether the risks alone would close the report unsuitable. |
summary必填string | null | One-paragraph risk summary. |
proseWithheld可选boolean | True only where a public read withheld this analysis' prose. |
ReportScopeAnswer3
Store a category and the exact keyword text supplied for a report scope.
decisionType可选string | |
categoryId必填integer | Confirmed category id. |
keywords可选string[] | Stored keyword text; a NEW REPORT_SCOPE answer needs at least one owner-confirmed, non-blank keyword. |
ReportScopeCandidate3
One category candidate the agent may confirm for the report scope.
categoryId必填integer | Candidate Amazon category node id. |
categoryName必填string | Readable category name. |
keywords可选string[] | Empty: candidate discovery supplies no keywords. |
ReportSectionKind可选值 · 4
The EXACT set of report sections a reader may request.
ReportSectionQuery2
Ask for one written section (market numbers, narrative, final overview).
object可选string | |
section必填ReportSectionKind |
ReportStandoutMarketTraits7
The old report's market traits the agent may attach to its standout choice.
newProfitableMustPrivateMold必填boolean | True if profitable products generally have different designs from old market products (private mold / owned design, not common public molds); False if at least some profitable products (>=2) are likely public mold/common designs compared to old products. If no profitable products are provided, decide based on old market products. |
newProfitableSignificantRnd必填boolean | True if most profitable products require significant early-stage R&D (e.g., mold, design, technology, mobile app, patent); otherwise False. If no profitable products are provided, decide based on old market products. |
newProfitableHasBattery必填boolean | True if products explicitly include a lithium battery in the package; power adapter or rechargeable usage alone does not count. If no profitable products are provided, decide based on old market products. |
newProfitableHasBluetooth必填boolean | True if products have Bluetooth; otherwise False. If no profitable products are provided, decide based on old market products. |
newProfitableChildrenProduct必填boolean | True if products target children and are categorized as children products; otherwise False. If no profitable products are provided, decide based on old market products. |
productDiversity必填LlmProductDiversity | How standardized the category is and how much design matters. |
productAlternatives可选string[] | Alternatives a buyer would weigh; ten at most. |
ReportStandoutPick2
ONE chosen standout product, mirroring the legacy unique-product output.
itemKey必填string | Chosen listing identity. |
reason必填string | Why this product stands out, in judgements and names only; never quote figures. |
ReportSuccessRate6
One success rate with its explicit numerator, denominator, or absence.
created可选string | |
updated可选string | |
value可选number | null | Rate in [0, 1]; None when absent. |
numerator必填integer | Listings counted in the numerator. |
denominator必填integer | Listings counted in the denominator. |
absenceReason可选ReportRateAbsenceReason | null | Typed reason the rate has no value. |
ReportSuccessRateProjection11
The three cohort success rates plus everything excluded from them.
created可选string | |
updated可选string | |
eligibleCount必填integer | Listings with an eligible member. |
successCount必填integer | Eligible listings proving success. |
failureCount必填integer | Eligible listings proving failure. |
unresolvedCount必填integer | Eligible listings proving neither. |
robust必填ReportSuccessRate | successes / all eligible listings. |
expected必填ReportSuccessRate | successes / determinate listings. |
possible必填ReportSuccessRate | (successes + unresolved) / all eligible listings. |
excludedCount必填integer | Listings removed by policy. |
excludedGroups可选ReportExcludedGroup[] | Removed listings grouped by policy reason. |
ReportTerminalState8
Why a run stopped operationally, with the last durable revision.
created可选string | |
updated可选string | |
status必填ReportTerminalStatus | Operational stop status. |
reason必填string | Internal, reviewer-facing reason. |
userMessage必填string | Reader-facing message safe to display. |
committedRevision必填integer | Last committed revision; 0 when nothing was committed. |
retryEligibility必填ReportRetryEligibility | Whether and how this run may be retried. |
failedPhase可选ReportPhase | null | Phase that failed; required for FAILED_PARTIAL. |
ReportTerminalStatus可选值 · 2
Operational ways a run stops WITHOUT a business verdict.
ReportUnitDescriptor6
One phase artifact that is READY and safe to render.
created可选string | |
updated可选string | |
phase必填ReportPhase | Phase that produced the ready unit. |
artifactKey可选string | null | Immutable artifact id; owner reads only, never public. |
revision必填integer | Revision the artifact was committed in. |
committedAt必填string | Instant the artifact was committed. |
ReportV3ConclusionToolResult7
One V3 report's verdict plus its reasoning chain, or a typed absence.
created可选string | |
updated可选string | |
object可选string | |
consultedRevision必填integer | Revision this answer read. |
latestRevision必填integer | Latest committed revision. |
view可选ReportConclusionEvidenceView | null | Verdict and reasoning; None when not reached. |
absence可选ReportCompactAbsence | null | Typed reason no verdict exists at this revision. |
ReportV3EstimationToolResult7
One V3 report's material-estimation evidence, or a typed absence.
created可选string | |
updated可选string | |
object可选string | |
consultedRevision必填integer | Revision this answer read. |
latestRevision必填integer | Latest committed revision. |
view可选ReportEstimationEvidenceView | null | How material inputs were resolved. |
absence可选ReportCompactAbsence | null | Typed reason the methodology is unavailable. |
ReportV3JudgmentToolResult6
One V3 report's head conclusion question, pinned to the revision read.
created可选string | |
updated可选string | |
object可选string | |
consultedRevision必填integer | Revision this answer read. |
latestRevision必填integer | Latest committed revision. |
question必填JudgmentQuestion | The head's conclusion question. |
ReportV3LifecycleToolResult7
One V3 report's lifecycle evidence, or a typed absence.
created可选string | |
updated可选string | |
object可选string | |
consultedRevision必填integer | Revision this answer read. |
latestRevision必填integer | Latest committed revision. |
view可选ReportLifecycleEvidenceView | null | Lifecycle verdict and corroboration. |
absence可选ReportCompactAbsence | null | Typed reason the lifecycle is unavailable. |
ReportV3ListingDetailToolResult5
One economic listing's members and economics at a revision.
created可选string | |
updated可选string | |
object可选string | |
consultedRevision必填integer | Revision this answer read. |
detail必填ReportListingDetailView | Listing detail view. |
ReportV3ListingsToolResult5
One cursor page of a V3 report's comparable listings at a revision.
created可选string | |
updated可选string | |
object可选string | |
consultedRevision必填integer | Revision this answer read. |
page必填ReportListingPage | Ordered listing summaries. |
ReportV3OverviewToolResult6
One V3 report's typed facts at the exact revision that was consulted.
created可选string | |
updated可选string | |
object可选string | |
consultedRevision必填integer | Revision this answer read. |
latestRevision必填integer | Latest committed revision. |
view必填ReportCompactView | Typed, absence-complete facts. |
ReportV3SectionToolResult6
One display-safe written section of a V3 report, or its typed gap.
created可选string | |
updated可选string | |
object可选string | |
consultedRevision必填integer | Revision this answer read. |
section可选ReportListingCohortSectionView | ReportMarketSectionView | ReportNarrativeSectionView | ReportFinalOverviewSectionView | null | Display-safe section view; None when not built. |
absence可选ReportGapDescriptor | null | Typed gap of a section this revision has not built. |
ReportVerdict可选值 · 3
The three business verdicts a V3 report may reach.
ReportVersion可选值 · 2
Persisted report FORMAT identity, read from storage and never inferred.
ResizeDesign5
Move an OWN image to another preset (e.g. secondary 2000x2000 -> A+ header 970x600).
action可选string | |
designId必填string | |
preset必填string | |
size可选PixelSize | null | |
mode必填ResizeMode |
ResizeMode可选值 · 2
How layers follow a canvas resize (the Magic-Resize choice; also a variant recipe's fit).
Resolution可选值 · 5
Who resolves an issue, derived from its kind and permission.
ResolvedWindow2
ONE resolved time window: its axis and the span it was resolved to.
axis必填TimeAxis | Which instant the window is measured on. |
span必填DateWindow | The resolved inclusive span. |
RestoreRow2
Bring a discarded row back into the next proposal.
op可选string | |
rowKey必填string |
ResumeStoreRequest1
One store, addressed by its id.
storeId必填string | The store's id. |
RevertFidelity可选值 · 3
How completely an action can be undone, shown on every action diff.
RevertLink2
Identify the apply-record row a revert action undoes.
actionKey必填string | Revert action row key. |
recordId必填string | Apply record being reverted. |
RevertRequest4
Ask the service to construct the undo of one proposal; callers choose rows, never undo values.
proposalId必填string | Proposal to revert. |
actionKeys可选string[] | Optional rows to revert; empty means every revertible row. |
replayKey可选string | null | Caller-owned idempotency key. |
attribution可选ProposalAttribution | null | Origin and reason of this undo; excluded from its hash. |
RevokeReach可选值 · 2
Whether removing a connection also asks the provider to withdraw access.
RoomCell2
One rendered cell: the computed cell plus its stored score and tier (None when unscored).
cell必填Cell | |
score可选CellScore | null |
RoomPublicAssessment5
One declared judgement as a customer sees it, without its model brief or dependencies.
object可选string | |
key必填string | |
label必填LocalizedText | |
kind必填AssessmentKind | |
ranges可选AssessmentRange[] |
RoomPublicDecisionOffer4
Whether a decision run can start, without the internal decision-input size.
object可选string | |
eligible必填boolean | |
refusal可选DecisionRefusal | null | |
offeredCells可选integer |
RoomPublicDecisionRead5
The decision read a customer sees, with request_chars dropped.
object可选string | |
scorecard可选RoomPublicScorecard | null | |
decision可选DecisionRecord | null | |
offer必填RoomPublicDecisionOffer | |
scoredCells可选RoomCell[] |
RoomPublicDeclaration13
One plugin declaration as a customer room renders it.
object可选string | |
pluginId必填string | |
title必填LocalizedText | |
description必填LocalizedText | |
itemNoun必填LocalizedText | |
setup必填SetupField[] | |
facts必填FactSpec[] | |
measures必填RoomPublicMeasure[] | |
assessments必填RoomPublicAssessment[] | |
dimensions必填RoomPublicDimensions | |
grid必填GridSpec | |
detail必填DetailSection[] | |
itemCard必填ItemCardSpec |
RoomPublicDimensions2
Which dimensions a positioning may use, without the classifier brief.
object可选string | |
computed可选BandedDimension[] |
RoomPublicMeasure4
One declared measure as a customer sees it, without its computation rule.
object可选string | |
key必填string | |
label必填LocalizedText | |
format必填MeasureFormat |
RoomPublicPositioning10
The customer-visible half of one positioning record.
object可选string | |
positioningId必填string | |
taskId必填string | |
gridId可选string | null | |
pluginId必填string | |
language必填Language | |
brief必填string | |
phase必填Phase | |
status必填PhaseStatus | |
createdAt必填string |
RoomPublicRead8
Everything the customer room renders, with the plugin declaration projected safe.
object可选string | |
positioning必填RoomPublicPositioning | |
declaration必填RoomPublicDeclaration | |
viewport必填Viewport | |
view必填ViewDefinition | |
dimensions必填DimensionRecord[] | |
criteria必填CriterionRecord[] | |
cells必填RoomCell[] |
RoomPublicScorecard6
One stored scorecard as a customer sees it, without request_chars.
object可选string | |
profile必填string | |
cells必填CellScore[] | |
excluded可选string[] | |
threshold可选integer | |
scoredAt必填string |
RouteHints5
The pinned read preferences carried with a public question.
channel可选Channel | null | Channel pinned for the question; null lets the router choose. |
market可选string | null | Market pinned for the selected channel and node family. |
resultKind可选AnalyzedRecordKind | null | Record family pinned for the answer. |
nodeKind可选NodeKind | null | Node family pinned for a node answer. |
windowDays可选integer | null | Time window in days pinned for windowed metrics; refused when the cell cannot apply one. |
RowPreview2
ELTA's preview of one kept row at the list's current revision.
diff必填ActionDiff | |
outcome必填ActionOutcome |
RunEnding3
How a finished run ended, kept on its run state after the durable event is delivered.
outcome必填RunOutcome | |
failureCode可选RunFailureCode | null | |
step可选RunStep | null |
RunFailureCode可选值 · 4
The finite reasons a run ended without success.
RunOutcome可选值 · 3
The execution outcome of a run. The host owns settlement.
RunRead8
Where the run stands: the stepper, the step waiting for review, queued work, the grid's shape.
positioning必填PositioningRecord | |
nextStep必填RunStep | null | |
waitingAfter必填RunStep | null | |
waitingUntil必填string | null | |
queued必填ChangeActionType[] | |
ending必填RunEnding | null | |
dimensions必填DimensionRecord[] | |
criteria必填CriterionRecord[] |
RunStep可选值 · 6
The six run steps, in order. Each of the first five can be reviewed by the caller.
SampleConfirmation5
SAMPLE_CONFIRMATION (1.6): the sample shown, the seller's verdict, and what to change.
step可选string | |
shownPostKeys必填string[] | |
verdict必填SampleVerdict | |
feedback可选string | null | |
revisePostKeys可选string[] |
SampleRelevanceAnswer2
A fragment of the delegated sample-relevance decision.
decisionType可选string | |
verdicts必填SampleRelevanceVerdict[] | One verdict per judged item. |
SampleRelevanceItem6
ONE frozen product projection: a labelled baseline or a candidate.
itemKey必填string | Stable candidate identity. |
asin必填string | Display ASIN. |
title可选string | null | Display title. |
brand可选string | null | Display brand. |
imageUrl可选string | null | Display image URL. |
price可选MinorUnitMoney | null | Observed selling price. |
SampleRelevanceVerdict5
ONE verdict on whether a candidate belongs to the analysed product.
itemKey必填string | Judged candidate identity. |
similarity必填ProductSimilarType | Matcher similarity level. |
isBattery可选boolean | null | Whether the candidate contains a battery. |
isApparel可选boolean | null | Whether the candidate is apparel. |
reason可选string | Short justification. |
SampleVerdict可选值 · 2
The seller's reaction to the sample the agent showed (1.6).
SaveCriterion3
Create or replace one criterion; its results are judged only when asked (ASSESS).
type可选string | |
actionKey必填string | |
criterion必填CriterionRecord |
SaveDimension3
Create or replace one dimension with its ordered options (rename, reorder, drop in one save).
type可选string | |
actionKey必填string | |
dimension必填DimensionRecord |
SaveView5
Create or replace one saved view in the viewer's own viewport.
type可选string | |
actionKey必填string | |
viewer必填ViewerRef | |
expectedRevision必填integer | |
view必填ViewDefinition |
ScenarioRole可选值 · 4
Role of one coherent economic scenario inside a profit envelope.
SceneCueBinding1
A plan column whose non-empty cell queues one paid GenerateScene(replaces=…) on that row's image.
binding可选string |
Score2
Recompute the scorecard from the cells as they are now (after edits, if the caller wants).
type可选string | |
actionKey必填string |
ScreeningEnforcement可选值 · 2
Whether a cited screening finding blocks proposing or is shown as guidance.
ScreeningFinding5
One finding: why, where, matched text, rule and copied enforcement.
reason必填ScreeningRefusal | |
pointer必填string | |
matchedText必填string | |
rule必填ScreeningRule | |
enforcement必填ScreeningEnforcement |
ScreeningRefusal可选值 · 4
Why a text leaf is blocked; each value has its own user-facing explanation key.
ScreeningResult3
Cited findings under one deployed rule bundle and one frozen brand corpus.
policyBundleVersion必填string | |
brandCorpus必填BrandCorpusRef | |
findings必填ScreeningFinding[] |
ScreeningRule3
One checked-in rule, its citation and whether its findings block.
ruleId必填string | |
citation必填PolicyCitation | |
enforcement必填ScreeningEnforcement |
Search3
A direct target query or a shortest typed path from a source object.
fromObject必填FromObject | null | Source object the path starts from; null runs one query for the target kind from search alone. |
search必填SearchObject | The requested target kind, exact identities and typed predicates. |
sourceMode可选SourceMode | Which source the read executes against: live sources, published analyzed rows, or analyzed with a live fallback. |
SearchAnswer2
A public decoded single-subject answer.
object必填string | Public object discriminator. |
answer必填string | Decoded answer text for the caller. |
SearchClarify4
A public clarification request.
object必填string | Public object discriminator. |
askUser必填string | Question the caller must answer. |
choices必填string[] | Allowed clarification choices. |
queryKey必填string | Stored partial-query key being resumed. |
SearchItem8
One public result item of the text-routed search page.
object必填string | Public object discriminator. |
recordKind必填AnalyzedRecordKind | Record family of the item. |
recordKey必填string | Stable record key. |
channel必填Channel | null | Source channel, when applicable. |
label可选string | null | Readable display label, when known. |
fields必填object | Authorized dynamic scalar values for the record. |
evidence必填MatchedFact[] | Evidence explaining the matched query clauses. |
relations可选RelationRef[] | Observed relationships to other served nodes; at most 16. |
SearchObject21
The requested target kind, exact identities and typed target predicates.
kind必填NodeKind | Node kind requested as the target of the search. |
targetIds可选NodeRef[] | null | Explicit target identities to restrict the result to; null means no explicit selection. |
clauses可选TextClause[] | BrandClause[] | CategoryClause[] | MetricClause[] | PriceClause[] | DateClause[] | ContactClause[] | RelationClause[] | Predicates ANDed over the target; CONTACT and RELATION are tested by the stored read only, on kinds whose read bindings declare them, and cannot appear in any_of. |
anyOf可选TextClause[][] | BrandClause[][] | CategoryClause[][] | MetricClause[][] | PriceClause[][] | DateClause[][] | Groups whose member predicates are ORed together; the groups themselves are ANDed. |
channel可选Channel | null | Channel to search; null searches stored rows across channels, and a live search needs a channel. |
peers可选PeerIntent | null | Same-kind peer meaning (competitors/lookalikes); valid only when the source and target kinds match. |
evidenceBases可选EvidenceBasis[] | null | Keep only hits whose path basis (the weakest hop on the strongest path from from_object) is in this nonempty, unique set; omission/null keeps every basis. Search-only; requires from_object. RECORDED includes recorded promotion links. NodeHit.promoted separately indicates a recorded promotional link or explicit paid sponsorship; when the hit's claim about the matched entity carries a stance, paid sponsorship counts only if that claim recommends the entity as the item's main subject. It does not determine the path basis. MENTIONED: the content's text names it, with no platform link. SIMILAR: resemblance only. This selector never re-admits stored SIMILAR promotion rows excluded by platform rules. |
observedOnly可选boolean | Search observed values only; false searches the effective value. |
market可选string | null | Market the search runs in; null uses the searcher's default. |
sort可选Sort | null | Ordering of the returned target rows. |
require可选string[] | Fields that every returned record must carry. |
conceptKind可选ConceptKind | null | Concept kind filter when the target kind is CONCEPT. |
preset可选MotifSection | null | Named motif section preset; valid only for a MOTIF target read in ANALYZED mode. |
textFrom可选string | null | Which source fact becomes the target's search text; null keeps the standard builder. |
dateWindow可选DateWindow | null | Inclusive calendar span for a KEYWORD or CONTENT target. |
motifWindow可选MotifWindow | null | Motif comparison window: the selected days and the equally long window before them. |
livePage可选integer | null | LIVE-only page number carried to the DIC query; null uses the DIC default. A stored read refuses it with UNSUPPORTED_QUESTION. |
buyBoxFulfilledByMarketplace可选boolean | null | PRODUCT LIVE only: carried to the DIC ProductQuery field of the same name; a stored read refuses it with UNSUPPORTED_QUESTION. |
oneVariantPerParent可选boolean | null | PRODUCT LIVE only: collapse to one variant per parent; null keeps the DIC default (every variant). A stored read refuses it with UNSUPPORTED_QUESTION. |
acquisition可选AcquisitionMode | null | Acquisition path copied to DIC; null or LIVE is the normal read. PUBLIC_PAGE is allowed only on a discovery refresh exact-id re-fetch, never serving. SNAPSHOT is a dataset opt-in allowed only on a non-seeded LIVE discovery root. |
limit可选integer | Maximum number of target rows returned. |
SearchPage9
A public page of text-routed search items and its opaque cursor.
coveragePartial可选boolean | Coverage notes were counted over a candidate batch or suppressed, so whole-cell counts are unknown; also set when the page's rows, including a successful empty page, cover only a frozen lexical candidate set, leaving records with no PHRASE hit or ranked beyond the retained window unreachable. |
object必填string | Public object discriminator. |
resultKind必填AnalyzedRecordKind | Family shared by all page items. |
items必填SearchItem[] | Result items in page order. |
coverage必填CoverageNote[] | Disclosed coverage gaps. |
windowEnd必填string | Resolved window end for this page. |
cursor必填string | null | Opaque signed token for the next page. |
unapplied可选string[] | Verbatim question substrings the router could not apply; at most 8. |
emptyCause可选GapKind | null | Why this page returned no items; null when it carries items. |
SearchPending3
A public search whose source has not settled yet.
object必填string | Public object discriminator. |
detail必填string | Safe explanation: results are still being collected; repeat the same search shortly. |
retryAfterSeconds必填integer | Seconds after which the caller may repeat the same search. |
SearchPlacement4
One typed display placement of a RANKED_FOR relationship.
placement必填SearchPlacementType | |
rank可选integer | null | |
page可选integer | null | |
pageRank可选integer | null |
SearchPlacementType可选值 · 7
Name one documented Amazon search-result placement in plain channel terms.
SearchRefused6
A typed public refusal with honest, topic-free next steps.
object必填string | Public object discriminator. |
reason必填string | Stable public refusal reason. |
detail必填string | Safe explanation of the refusal. |
refusal必填Refusal | Typed refusal code, field and DP-worded detail. |
suggestions可选CreatorHandleSuggestion[] | TopByMetricSuggestion[] | Supported next steps that do not reuse an unapplied topic. |
failureRef可选FailureRef | null | Public request-ledger id this refusal was recorded as. |
SearchRequest7
One question or structured search with an optional per-call row ceiling.
maxRows可选integer | null | Optional row ceiling for this call; the smaller of this and the normal page size is returned. Omission preserves the normal page size. |
answerLanguage可选AnswerLanguage | Language of seller-facing clarifications and refusals. |
question可选string | null | The natural-language question to answer. |
search可选Search | null | The typed structured search to execute. |
hints可选RouteHints | null | Optional predicates pinned into the stored plan. |
clarification可选ClarificationAnswer | null | The stored clarification choice being resumed. |
fields可选string[] | null | Authorized display-field whitelist; null means all authorized fields. |
SeedCallBound4
Declare a finite physical-call ceiling for one exact seeded route.
selector必填string | |
subjectKind必填ObjectKind | |
callsPerSubjectPage必填integer | |
maxPages必填integer |
SetBackground3
Set an image's background colour (literal or kit ref); on a VARIANT it is a BACKGROUND override.
action可选string | |
designId必填string | |
color必填Color | BrandColorRef |
SetBoardTitle2
Rename the board through the same revisioned edit batch as every other change.
action可选string | |
title必填string |
SetBox4
Move, resize or rotate one layer; on a group, its children move and scale so their bounds become box.
action可选string | |
designId必填string | |
layerId必填string | |
box必填Box |
SetDailyBudgetValue2
The suggested daily budget of one Sponsored Products campaign.
kind可选string | |
dailyBudget必填number | string |
SetImageTransform6
Set an image layer's flips and crop together (all stated, like SetLayerFlags); free.
action可选string | |
objectId必填string | |
layerId必填string | |
flipX必填boolean | |
flipY必填boolean | |
crop必填Box | null |
SetLayerFlags8
Set a layer's name, opacity, blend, visibility and lock together (all stated, none optional).
action可选string | |
designId必填string | |
layerId必填string | |
name必填string | |
opacity必填number | |
blendMode必填BlendMode | |
visible必填boolean | |
locked必填boolean |
SetObjectFrame4
Rename and/or move any object on the board; allowed while AI-busy (a landing never reads position).
action可选string | |
objectId必填string | |
name可选string | null | |
position可选BoardPoint | null |
SetObjectLock3
Lock or unlock one object against agent edits; sole in its batch, USER only, writes only the lock map.
action可选string | |
objectId必填string | |
locked必填boolean |
SetPlacements4
Put groups into options of one dimension by hand (None takes a group out).
type可选string | |
actionKey必填string | |
dimensionKey必填string | |
placements必填object |
SetPlan5
Edit a plan: replace its columns, upsert rows by id, delete rows (merges rev 1's two plan actions).
action可选string | |
planId必填string | |
columns可选PlanColumn[] | null | |
upsertRows可选PlanRow[] | |
deletedRowIds可选string[] |
SetResults4
Write cells' results of one assessment or criterion by hand (the ASSESS review's answer).
type可选string | |
actionKey必填string | |
assessment必填string | |
results必填object |
SetReview3
Change who decides the named steps; takes effect at the next step that ends.
type可选string | |
actionKey必填string | |
review必填object |
SetSettings4
Set values on one section, or on one of its blocks when block_key is given.
action可选string | |
sectionKey必填string | |
blockKey可选string | null | |
settings必填object |
SetSetup3
Replace the named setup values (the SCOPE review's answer, or a later correction).
type可选string | |
actionKey必填string | |
values必填object |
SetShadow4
Set or clear the drop shadow of any leaf layer (image, text or shape).
action可选string | |
designId必填string | |
layerId必填string | |
shadow必填DropShadow | null |
SetShapeStyle6
Replace a shape layer's fill and stroke, and optionally its geometry (None keeps the current one).
action可选string | |
designId必填string | |
layerId必填string | |
fill必填Color | BrandColorRef | LinearGradient | RadialGradient | null | |
stroke必填Stroke | null | |
geometry可选RectGeometry | EllipseGeometry | LineGeometry | PolygonGeometry | PathGeometry | null |
SetStatus7
Where a set is: head revision and its commit time, paid steps, last refusal, AI pause, non-READY objects.
setId必填string | |
headRevision必填integer | |
headCommittedAt可选string | null | |
steps可选PaidStepView[] | |
lastRefusal可选EditRefusal | null | |
aiPausedUntil可选string | null | |
objects可选ObjectStatus[] |
SetText4
Replace a text layer's text.
action可选string | |
designId必填string | |
layerId必填string | |
text必填string |
SetTextStyle4
Replace a text layer's whole style (font, weight, size, colour, alignment).
action可选string | |
designId必填string | |
layerId必填string | |
style必填TextStyle |
SetVariantRecipe3
Replace a variant's recipe: the one writer of its preset, size, fit, colour map and plan row.
action可选string | |
objectId必填string | |
recipe必填VariantRecipe |
SetupField8
One input a positioning of this plugin needs before sourcing.
key必填string | |
label必填LocalizedText | |
help必填LocalizedText | |
kind必填SetupFieldKind | |
options可选SetupOption[] | |
required可选boolean | |
maxItems可选integer | null | |
minimum可选number | string | null |
SetupFieldKind可选值 · 5
How one setup input is entered in the create form and filled by the scope model.
ShadowField2
Override value: a leaf layer's drop shadow (None = no shadow).
field可选string | |
shadow必填DropShadow | null |
ShapeLayer12
Free vector composition: panels, bands, badges, outlines and icons.
layerId必填string | |
name必填string | |
opacity可选number | |
blendMode可选BlendMode | |
visible可选boolean | |
locked可选boolean | |
box必填Box | |
shadow可选DropShadow | null | |
kind可选string | |
geometry必填RectGeometry | EllipseGeometry | LineGeometry | PolygonGeometry | PathGeometry | |
fill可选Color | BrandColorRef | LinearGradient | RadialGradient | null | |
stroke可选Stroke | null |
ShippingMode可选值 · 3
First-leg transport mode from the manufacturer to the marketplace.
ShippingProfile5
Canonical shipping-rate inputs for legacy float weight formulas.
exchangeRates必填ExchangeRateInUsd[] | |
freightPerKg必填MinorUnitMoney | |
airPerKg必填MinorUnitMoney | |
railPerKg可选MinorUnitMoney | null | |
cubicCmBreakpoint可选integer |
ShopifyRemoteImage2
An HTTPS image source Shopify must ingest through fileCreate before content write.
url必填string | |
alt_text可选string |
SizingDetail18
Typed replacement for the legacy === METADATA === sizing prose.
sizeTier必填string | |
longestSideInches必填number | |
medianSideInches必填number | |
shortestSideInches必填number | |
longestSideCm必填number | |
medianSideCm必填number | |
shortestSideCm必填number | |
weightLb必填number | |
weightKg必填number | |
dimensionalWeightLb可选number | null | |
dimensionalWeightKg可选number | null | |
shippingWeightLb可选number | null | |
shippingWeightKg可选number | null | |
volumeCubicMeter必填number | |
girth必填number | |
girthUnit必填string | |
feeCategory必填string | |
source必填EstimateSource |
SlotFinding4
One rule checked on one design: passed or not, with the measured value when numeric.
designId必填string | |
rule必填WhiteBackgroundRule | MinLongestSideRule | MaxLongestSideRule | ProductFillRule | NoTextRule | NoGraphicsRule | NoEdgeCropRule | NoBadgeClaimsRule | LayerClippedRule | |
passed必填boolean | |
measured可选number | null |
SocialTextTrack8
Retain one bounded transcript or caption with truthful truncation facts.
language可选string | null | |
kind必填SocialTextTrackKind | |
text可选string | null | |
capturedAt必填string | |
provenance必填Provenance | |
truncated可选boolean | |
omitted可选boolean | |
originalLength可选integer | null |
SocialTextTrackKind可选值 · 2
Distinguish transcript and caption text without provider-specific kinds.
Sort5
Request ordering by one typed metric, or by one launch instant.
metric可选MetricKind | null | |
field可选string | null | |
direction可选string | |
window可选RankingWindow | null | |
change可选boolean |
Source13
One thing an owner binds: a provider grant that reaches one or more accounts.
key必填string | Connectable catalog source identifier. |
title必填StoreLocalizedText | Display name of this source, in both languages. |
connect必填ConnectStyle[] | Ways this deployment offers to bind. |
credentials必填Credential[] | Access fields used by this source. |
regions可选ProviderRegion[] | Sales regions the owner picks from before consent; empty means no region step. |
available可选boolean | False when this deployment cannot connect the source yet. |
consentLifetimeDays可选integer | null | Provider-forced consent lifetime in days, when declared. |
accountAttributes可选Attribute[] | Metadata attributes discovery reports for each account. |
datasets可选Dataset[] | Datasets captured and retained. |
lookups可选Lookup[] | Reads answered live without storing their results. |
actions可选ProviderWriteActionType[] | Writes applied only after approval. |
revokeReach可选RevokeReach | Whether removal asks the provider to revoke access; LOCAL destroys only the stored credentials. |
revokeUrl可选string | null | The provider page where the owner withdraws this access; https only. |
SourceDescriptionKind可选值 · 10
DP-owned: WHICH descriptive field of a source a string came from.
SourceMode可选值 · 3
WHICH READ SOURCE one search step executes against.
SourceReference5
A link that supports an item or an assessment, with the source context people saw.
url必填string | |
title可选string | null | |
snippet可选string | null | |
publisher可选string | null | |
publishedAt可选string | null |
SourceSubject3
Identify one source object by channel, content kind, and exact external ID.
channel必填Channel | |
kind必填ObjectKind | |
externalId必填string |
SourcedItem7
One item a plugin found: identity, facts and what models see.
key必填string | |
name必填string | |
groupKey可选string | null | |
main可选boolean | |
facts可选object | |
prompt必填ItemPrompt | |
references可选SourceReference[] |
SpanEvidence3
The transcript span or caption an element cites.
kind必填string | Citation shape: TRANSCRIPT for a timed span, CAPTION for a whole caption. |
startMs可选integer | null | Start offset of the cited transcript span in milliseconds; null for a CAPTION. |
endMs可选integer | null | End offset of the cited transcript span in milliseconds; null for a CAPTION. |
StageGuide2
The kind's instruction to the agent for the current stage, returned on every read.
stage必填ChangeListStage | |
instruction必填string |
StagedProposal3
The exact create batch staged on an artifect snapshot BEFORE propose is called.
replayKey必填string | |
batch必填ActionBatch | |
validUntil必填string |
StalePart2
One out-of-date part of an image; the editor dims it with a "Refresh · N 次请求" chip.
reason必填StaleReason | |
layerId可选string | null |
StaleReason可选值 · 1
Why part of a variant is out of date (free parts never go stale: they resolve live).
StandingAdjust2
MIRROR wire ArtifectStandingAdjust: pause, resume or run a standing artifect now.
adjustmentType可选string | |
command必填StandingControl |
StandingControl可选值 · 3
The core-owned standing commands (MIRROR wire ArtifectStandingAdjust.command).
StandingPauseBy可选值 · 3
Who paused a standing run (StandingFacts.paused_by); core sets it on every move to PAUSED.
StandingState可选值 · 4
Where one standing artifect is (MIRROR wire ArtifectStandingState); core owns the moves.
StandoutItem13
ONE already-built listing the agent may choose as a standout.
itemKey必填string | Stable listing identity. |
asin必填string | Display ASIN. |
title可选string | null | Display title. |
brand可选string | null | Display brand. |
imageUrl可选string | null | Display image URL. |
price可选MinorUnitMoney | null | Observed selling price. |
latestMonthlySold可选integer | null | The representative member's latest observed monthly sold units from the LISTING_BUILD cohort. This is ONE member's signal, NOT a family total. None means not measured. |
ratingInt可选integer | null | Star rating in tenths (0 through 50); the same name and meaning as ReportAsinDisplayFact.rating_int. |
reviewCount可选integer | null | Retained review count; the same name and meaning as ReportAsinDisplayFact.review_count. |
memberCount可选integer | null | Members the listing summary retained. |
familyEntryAgeMonths可选integer | null | Family entry age in months; a FAMILY age, not the member's. |
expectedProfit可选MinorUnitMoney | null | LISTING_ECONOMICS expected-scenario profit; None when the listing's profit inputs are unresolved. |
margin可选ReportRatioRange | null | LISTING_ECONOMICS margin range, verbatim. |
StandoutSelectionAnswer4
The agent's standout choice for a completed analysis.
decisionType可选string | |
picks必填ReportStandoutPick[] | Chosen standouts, in display order. |
market可选ReportStandoutMarketTraits | null | Optional old-report market traits; omit to hide the market-traits part. |
commonItemKeys可选string[] | Offered itemKeys of typical, NOT standout, listings; omit to hide the common-products part. |
StdMoneyAmount1
Store one immutable signed-Int64 monetary minor-unit amount.
value必填integer |
StorageLineDetail4
Per-month composition of one aggregated storage breakdown line.
months必填integer[] | |
volumeCubic必填number | |
cubicUnit必填string | |
perMonth必填MonthlyStorageFee[] |
Store11
Represent a selling entity with a stable channel ID and alias fields.
kind可选string | |
channel必填Channel | |
externalId必填string | |
name可选string | null | |
description可选string | null | |
domain可选string | null | |
market可选string | null | |
publishedAt可选string | null | |
metrics可选MetricObservation[] | |
observedAt必填string | |
provenance必填Provenance |
StoreCapabilities5
What the installed sources can do right now for one store: live reads, writes and captures.
object可选string | Document type: store capabilities. |
storeId必填string | Store whose current abilities this document describes. |
lookups必填CapabilityRow[] | Installed live reads: one row per (key, account). |
actions必填CapabilityRow[] | Installed provider writes: one row per (key, account). |
datasets必填CapabilityRow[] | Installed captured datasets: one row per (key, account). |
StoreOwner可选值 · 2
Which service's least-privilege byte API serves this ref (fixes the 'same ref type, unknown store' hole).
StoreRecord12
One owner's store spanning installed sources, with lifecycle state and stored rows.
object可选string | Document type: store record. |
storeId必填string | Store identifier within the asserted owner scope. |
title必填string | Owner's display name for the store. |
region必填ProviderRegion | null | Sales region chosen before consent; null while the store has no region. |
status必填StoreStatus | Whether this store may sync. |
pauseReason可选PauseReason | null | Why sync is paused; null when active. |
connections可选ConnectionRecord[] | Connectors bound to this store; empty means connection is unfinished. |
createdAt必填string | When the store was created. |
lastSyncedAt可选string | null | Display-only aggregate: the oldest last_synced_at among active connections, excluding blocked and parked lanes; null while any active connection has never synced. ConnectionRecord's last_synced_at and synced_through are authoritative. |
storedRows可选integer | Current stored fact rows across the store's connectors, never a per-sync count. |
writePolicy可选WritePolicy | Owner-controlled provider-write families. |
removing可选boolean | A removal started and has not finished. The record is kept only so the same DELETE can finish it: capture, binding and lifecycle commands refuse it. False for every normal record. |
StoreStatus可选值 · 2
Whether capture may run for the store; paused reads remain available.
StoresResponse2
The stores belonging to the asserted owner, including unfinished stores.
object可选string | Document type: stores response. |
stores必填StoreRecord[] | Stores belonging to the asserted owner. |
StrokeField2
Override value: a shape layer's stroke (None = no stroke).
field可选string | |
stroke必填Stroke | null |
StyleExample5
One real article the agent found as a model for one tone (1.3); dated on/after the Setting.
toneKey必填string | |
articleUrl必填string | |
title必填string | |
publishedOn必填string | |
styleNotes必填string |
StyleExamples2
STYLE_EXAMPLES (1.3): at least one example for every tone the plan declares.
step可选string | |
examples必填StyleExample[] |
SuggestedKeywordEvidence1
A term no server-read report row matched: a suggestion, explicitly not a measurement.
kind可选string |
SuggestedPurchasingCost5
User suggestion calibrated against one marketplace benchmark product.
asin必填string | |
suggestedPurchasingCost必填MinorUnitMoney | |
benchmarkSellingPrice必填MinorUnitMoney | |
amazonMarketplace必填AmazonMarketplace | |
suggestedPurchasingCostUpper可选MinorUnitMoney | null | Upper bound when the seller's cost is a range; None for a single value. Same currency as suggested_purchasing_cost, never below it. |
SumCombine1
Range value = the sum of the days' values.
kind可选string | Range combination: sum of daily values. |
TaskExceptionType可选值 · 7
Closed persisted task-failure classifications shared by maintained lines.
TaskStage可选值 · 5
TextAlign可选值 · 3
Horizontal alignment inside the text box.
TextClause4
Search one named text field or request broad text discovery.
kind可选string | |
field可选string | null | |
value必填string | |
op可选string |
TextField2
Override value: a text layer's text.
field可选string | |
text必填string |
TextFill2
Fill a HEADLINE/BODY_TEXT placeholder.
placeholder必填string | |
text必填string |
TextHunk3
One contiguous text edit with its zero-based old/new origins and line operations.
oldStart必填integer | Zero-based old-file hunk start. |
newStart必填integer | Zero-based new-file hunk start. |
lines必填TextLine[] | Changed and context lines. |
TextLayer12
Text wrapped inside its box width (line breaks computed by the one keble-core scene mapper).
layerId必填string | |
name必填string | |
opacity可选number | |
blendMode可选BlendMode | |
visible可选boolean | |
locked可选boolean | |
box必填Box | |
shadow可选DropShadow | null | |
kind可选string | |
text必填string | |
style必填TextStyle | |
placeholder可选string | null |
TextLayerBinding2
A plan column whose cell text replaces one TEXT layer of the plan's source image.
binding可选string | |
layerId必填string |
TextLine4
One raw source line with one-based before/after coordinates.
operation必填TextLineOperation | Context, inserted or deleted line. |
text必填string | Raw text of the line. |
oldLine可选integer | null | One-based old-file line number. |
newLine可选integer | null | One-based new-file line number. |
TextLineOperation可选值 · 3
One unchanged, inserted or deleted source line in a text diff.
TextStyle7
How a text layer is set; font is a reference (stored as its key).
font必填string | BrandFontRef | |
weight可选FontWeight | |
size必填number | |
color必填Color | BrandColorRef | |
align可选TextAlign | |
lineHeight可选number | |
letterSpacing可选number |
ThemeBlockInstance3
One block inside one Keble section: its stable key, its kind and its setting values.
blockKey必填string | |
kind必填KebleBlockKind | |
settings可选object |
ThemeChangeSet6
Removed in the first theme release after SEO and GEO migrate.
changeSetId必填string | |
draft必填ThemeChangeSetDraft | |
bases可选ThemeFileBase[] | |
preview可选ThemePreviewCopy | null | |
proposals可选ThemeProposalLink[] | |
createdAt必填string |
ThemeChangeSetDraft3
Removed in the first theme release after SEO and GEO migrate.
title必填string | |
edits必填ThemeFileEdit[] | |
newPage可选NewThemePage | null |
ThemeCreateLedger9
Removed in the first theme release after SEO and GEO migrate.
artifectRefId必填string | |
owner必填string | |
replayKey必填string | |
storeId必填string | |
account必填AccountRef | |
targetThemeId必填string | |
changeSets必填ThemeChangeSet[] | |
revision必填integer | |
createdAt必填string |
ThemeDocument1
The whole Keble document of one run: its pages, each placing Keble sections on one template.
pages可选ThemePage[] |
ThemeDocumentCreateRequest6
The document-run create input: store, optional target, title, author and first actions.
replayKey必填string | |
storeId必填string | |
targetThemeId可选string | null | |
title必填string | |
author必填ThemeEditAuthor | |
initialActions可选AddPage[] | AddSection[] | MoveSection[] | RemoveSection[] | SetSettings[] | AddBlock[] | MoveBlock[] | RemoveBlock[] | ShopifyThemeRestoreRevision[] |
ThemeDocumentOperation可选值 · 4
The document commands a caller may run next (the guide's vocabulary; the host maps its arms).
ThemeDocumentProposalLink4
A document run's proposal link: the 0.3.x link plus the revision the proposal compiled.
purpose必填ThemeProposalPurpose | |
proposalId必填string | |
inboxItemId可选string | null | The backend To do approval item this proposal was filed as. None means a link recorded before keble-shopify-theme 0.3.0, which kept no inbox id: such links exist only on keble-test, expire naturally, and are never looked up by proposal id. |
documentRevision可选integer | null |
ThemeDocumentProposalStateRead4
The live inbox state of one document-run proposal link, read by the theme host on every read.
purpose必填ThemeProposalPurpose | |
proposalId必填string | |
documentRevision可选integer | null | |
approval必填ApprovalState | null |
ThemeDocumentSnapshot6
The owner-fenced document-run snapshot: head, head document, guide, publish summary, link.
runKind可选string | |
head必填ThemeRunHead | |
document必填ThemeDocument | |
guide必填ThemeStageGuide | |
publishSummary可选ThemePublishSummary | null | |
previewLink可选string | null |
ThemeEditAuthor可选值 · 2
Who submitted an edit: the chat agent or the person in the editor (revision provenance).
ThemeEditReceipt2
One recorded edit replay: its key and the revision it committed.
replayKey必填string | |
revision必填integer |
ThemeFileBase3
One theme file's stamped base: its filename and the checksum ELTA's drift law compares.
filename必填string | |
checksum_md5必填string | |
body可选null |
ThemeFileEdit2
Removed in the first theme release after SEO and GEO migrate.
filename必填string | |
after必填string |
ThemeFrameSource可选值 · 2
Which theme a page frame renders: the run's preview copy or its target (live vs draft).
ThemePage4
One page of the document: the template it places on, its preview path, and its sections.
template必填ThemeTemplateRef | |
previewPath必填string | |
newPage可选NewKeblePage | null | |
sections可选ThemePlacedSection[] |
ThemePageChange3
One changed page of a publish summary: the page's own change and/or its changed Keble sections.
page必填ThemeTemplateRef | |
change可选ThemeSectionChangeKind | null | |
sections可选ThemeSectionChange[] |
ThemePlacedSection2
One Keble section placed on a page: the section plus its anchor in the template's order.
section必填ThemeSectionInstance | |
after可选string | null |
ThemePreviewCopy3
Removed in the first theme release after SEO and GEO migrate.
previewThemeId必填string | |
previewLink可选string | null | |
createdAt必填string |
ThemeProposalLink3
One ELTA proposal this artifect opened: purpose, ELTA proposal id and its inbox item.
purpose必填ThemeProposalPurpose | |
proposalId必填string | |
inboxItemId可选string | null | The backend To do approval item this proposal was filed as. None means a link recorded before keble-shopify-theme 0.3.0, which kept no inbox id: such links exist only on keble-test, expire naturally, and are never looked up by proposal id. |
ThemeProposalPurpose可选值 · 5
Why one ELTA proposal was opened for a change set or a document revision.
ThemeProposalStateRead4
The live inbox state of one theme proposal link, read by the keble-artifect theme host.
changeSetId必填string | |
purpose必填ThemeProposalPurpose | |
proposalId必填string | |
approval必填ApprovalState | null |
ThemePublishSummary5
What publishing would change, where, and whether the target moved since it was read.
revision必填integer | |
publishedRevision可选integer | null | |
targetTheme必填ThemeRef | |
pages可选ThemePageChange[] | |
drift可选string[] |
ThemeRef3
One theme as the store reports it now: its GID, display name and role.
theme_id必填string | |
name必填string | |
role必填ThemeRole |
ThemeRevision7
One immutable committed revision of a document run: the document and the actions that made it.
runKind可选string | |
artifectRefId必填string | |
revision必填integer | |
document必填ThemeDocument | |
actions可选AddPage[] | AddSection[] | MoveSection[] | RemoveSection[] | SetSettings[] | AddBlock[] | MoveBlock[] | RemoveBlock[] | ShopifyThemeRestoreRevision[] | |
author必填ThemeEditAuthor | |
createdAt必填string |
ThemeRole可选值 · 6
A Shopify theme's role; only MAIN is the published, write-protected live theme.
ThemeRunHead15
The small owner-scoped head row of one document run; revisions live beside it.
runKind可选string | |
artifectRefId必填string | |
owner必填string | |
replayKey必填string | |
createRequestHash必填string | |
storeId必填string | |
account必填AccountRef | |
targetThemeId必填string | |
title必填string | |
headRevision必填integer | |
editReceipts可选ThemeEditReceipt[] | |
preview可选PreviewSession | null | |
proposals可选ThemeDocumentProposalLink[] | |
createdAt必填string | |
updatedAt必填string |
ThemeSectionChange3
One changed Keble section in a publish summary; the web names it from its kind's label.
sectionKey必填string | |
kind必填KebleSectionKind | |
change必填ThemeSectionChangeKind |
ThemeSectionChangeKind可选值 · 3
How one Keble section differs between the published revision and the one being published.
ThemeSectionInstance4
One Keble section on a page: stable key (also its JSON-template entry id), kind, settings, blocks.
sectionKey必填string | |
kind必填KebleSectionKind | |
settings可选object | |
blocks可选ThemeBlockInstance[] |
ThemeStage可选值 · 5
Where a document run stands, derived on every read and never stored.
ThemeStageGuide4
The stage and the commands allowed in it, computed by the runtime from one rule set.
stage必填ThemeStage | |
allowed可选ThemeDocumentOperation[] | |
undoRevision可选integer | null | |
liveIsUndo可选boolean |
ThemeTemplateEntry4
One entry of a theme's JSON template as the runtime parsed it: id, section type and display name.
entryId必填string | |
sectionType必填string | |
name可选string | null | |
disabled可选boolean |
ThemeTemplateOutline4
One template of the copy or the target with its merchant entries in order (this run's own excluded).
template必填ThemeTemplateRef | |
entries可选ThemeTemplateEntry[] | |
order可选string[] | |
unresolvedSectionKeys可选string[] |
ThemeTemplateRef2
Typed identity of one JSON template: a template type plus an optional alternate suffix.
templateType必填ThemeTemplateType | |
suffix可选string | null |
ThemeTemplateType可选值 · 6
The JSON template types a Keble section may be placed on in v1 (templates/<type>[.<suffix>].json).
TimeAxis可选值 · 3
WHICH INSTANT a time window is measured on.
TodoCreate3
Immutable original intent for an ordinary todo.
kind可选string | |
content必填ItemContent | |
key可选string | null |
TodoItem11
Ordinary todo with immutable creation and mutable current content.
id必填string | |
owner必填OwnerRef | |
current必填ItemContent | |
created_at必填string | |
revision必填integer | |
created_by可选ActorRef | null | |
kind可选string | |
object可选string | |
creation必填TodoCreate | |
status必填TodoStatus | |
resolved_by可选ActorRef | null |
TodoStatus可选值 · 3
An ordinary item remains stored and readable after completion.
Tone可选值 · 2
The tint of a cell's conclusion.
ToneSpec2
One tone the plan uses, defined once and referenced by key (round-3 m2).
toneKey必填string | |
description必填string |
TopByMetricSuggestion5
An executable alternative over a declared numeric cell field.
kind可选string | Ranked-search suggestion discriminator. |
nodeKind必填NodeKind | Node family to rank. |
channel必填Channel | Channel of the ranked nodes. |
metric必填string | Declared numeric field code of the selected cell. |
windowDays可选integer | null | Applicable metric window in days; null for a current field value. |
UnboundAction5
The account-free ELTA action accepted at every public change-list boundary.
actionKey必填string | |
actionTypeKey必填string | |
target必填EntityRef | |
change必填JsonValue | |
baseVersion可选string | null |
UngroupLayer3
Dissolve a group, keeping its children in place.
action可选string | |
designId必填string | |
groupId必填string |
Unit可选值 · 3
The physical unit of a measure or metric, so money, counts and ratios stay apart.
UnlinkedMention6
ONE claim of a source item that no held record matched.
stance可选ClaimStance | null | What the source item does toward the named entity in the cited claim; null when no claim is cited, the claim predates mention capture, or (on a relation) the edge's basis is SIMILAR (its claim names no such record). |
mainSubject可选boolean | null | Whether the cited claim names what the source item mainly promotes or is about; null when stance is null. |
emotion可选ClaimEmotion | null | How the source item feels about the named entity in the cited claim, STRONGLY_NEGATIVE to STRONGLY_POSITIVE; null when stance is null. |
phrase可选string | null | The source item's own words showing how it brings the named entity up, from the cited claim; null when not found verbatim, visual only, captured before mention capture, (on a relation) the basis is SIMILAR, or no claim is cited. |
relation必填AnalyzedRelationKind | Relation the claim would draw if a record matched it; FEATURES_BRAND today. |
label必填string | The named entity as the source item says it, from the claim. |
UnresolvedBrandRef4
A kit ref whose entry (or kit) no longer exists; nothing is substituted silently (§4.3).
layerId必填string | null | |
field必填LayerField | |
kitId必填string | |
entryId必填string |
UpdateItems3
Change items' names, facts or relevance (the SOURCE review's answer, or any later edit).
type可选string | |
actionKey必填string | |
updates必填ItemUpdate[] |
ValueBasis可选值 · 2
Where one stored field value came from (PLAN §2.1, owner 1700 #).
ValueStatus可选值 · 3
Whether a value exists; missing is never zero (existing ruling).
VariantRecipe5
How a variant differs from its parent; the parts compose ("Heat at 4:5" = color_map + preset).
preset可选string | null | |
size可选PixelSize | null | |
fit可选ResizeMode | |
colorMap可选ColorRemap[] | |
planRow可选PlanRowRef | null |
VariantSpec5
One variant to create; its recipe composes, and an optional prompt queues one paid scene on it.
objectId必填string | |
name必填string | |
position可选BoardPoint | null | |
recipe可选VariantRecipe | |
scenePrompt可选string | null |
ViewDefinition5
One saved display of a positioning: axes, circle size and number, optional criterion.
viewId必填string | |
dimensionKeys必填string[] | |
sizeMeasure必填string | |
numberMeasure必填string | |
criterion可选string | null |
ViewHandledBy可选值 · 2
Whose viewport a view row is: a person's, or the agent working for them (existing values).
ViewerRef2
Who is looking: every viewer keeps their own views; the agent never overwrites the person's.
viewer必填string | |
handledBy可选ViewHandledBy |
Viewport3
One viewer's ordered saved views of one positioning, guarded by a revision.
viewer必填ViewerRef | |
definitions必填ViewDefinition[] | |
revision可选integer |
VisibleField2
Override value: a layer's visibility.
field可选string | |
visible必填boolean |
WhiteBackgroundRule1
Every pixel outside the product is pure white RGB 255,255,255 (Amazon main image).
kind可选string |
WindowCapture3
A dataset re-requested over its recent reporting days on every run.
kind可选string | Capture style: recent reporting-day window. |
lookbackDays必填integer | Recent reporting days re-read on each sync. |
maxWindowDays必填integer | Maximum reporting days in one capture request. |
WritePolicy1
The store's enabled action-family keys; an empty set keeps every write disabled.
enabled可选string[] | Write families enabled for this store. |
WriteRefusal3
One catalog refusal: its key, bilingual title and target or direct-only undo meaning.
key必填string | Refusal key carried by action rows. |
title必填StoreLocalizedText | Display name of the reason, in both languages. |
means可选string | null | For a plugin code, the standard target reason it is a case of, or REVERT_ONLY for a field only undo rows may change (for example SEO_FIELD_REVERT_ONLY). |
MinorUnitMoney2
Exact monetary value stored as ISO minor units plus its currency.
amount必填StdMoneyAmount | |
currency必填Currency |
DecimalMoney2
An amount with its currency; core never adds two currencies.
amount必填number | string | |
currency必填string |
ProviderWriteActionType19
One provider write, with optional neutral intent, typed change and undo/drift policy.
key必填string | Approved-write action identifier. |
kind必填ActionKind | Whether the action sets, adds or removes a target. |
level必填string | Granularity of the write target: a catalog level key. |
intent可选ActionIntent | null | Neutral write meaning; null when the action declares none. |
familyKey必填string | Owner-facing write family controlled by the store policy. |
changeSchema必填JsonValue | JSON Schema of the requested change. |
title必填StoreLocalizedText | Owner-facing name of this write. |
fieldTitles可选ChangeFieldTitle[] | Human titles of this change's top-level fields. |
requires可选Permission[] | Permissions needed to apply this action. |
creates可选string | null | Entity level created by an addressable ADD action. |
createdFrom可选string | null | Top-level change field containing an ADD's caller-assigned id. |
revertActionKey可选string | null | Action used to cancel or restore this action. |
revertNote可选StoreLocalizedText | null | Provider-specific undo limitation shown before approval, in both languages. |
refreshDatasetKeys可选string[] | Datasets captured after this action applies. |
fidelity必填RevertFidelity | Declared completeness of the action's undo. |
drift必填DriftPolicy | Whether a changed target is refused before apply. |
removeScope可选RemoveScope | Targets this REMOVE may delete. |
revertOnly可选boolean | Whether this action is valid only while reverting another action. |
quoted可选boolean | Whether provider estimates are retained on action outcomes. |
PluginDeclarationCatalog4
Every installed plugin's declaration plus the shared vocabulary.
object可选string | Document type: catalog. |
declarations必填PluginDeclaration[] | Declarations of every installed plugin. |
levels可选EntityLevel[] | Every level a value may carry, with its title and parent. |
refusals可选WriteRefusal[] | Every refusal an action row may carry, with its title and meaning. |
TemporalFactKind可选值 · 3
How one fact family is placed in time.
StoreLocalizedText2
One display text in both product languages, declared once by the owning plugin.
en必填string | English display text. |
zh必填string | Simplified Chinese display text. |
LocalizedText2
One human label in both product languages.
en必填string | |
zh必填string |
StoreActorKind可选值 · 3
Who caused a change, as the calling service verified it.
StoreActorRef2
One verified actor: its kind and its stable identity within that kind.
kind必填StoreActorKind | Kind of actor that caused the change. |
id必填string | Verified actor identity. |
ActorKind可选值 · 4
Who made an item request or transition.
CapabilityCatalog5
The public catalog object.
object必填string | Public object discriminator. |
cells必填CatalogCellView[] | Public capability cells. |
edges必填CatalogEdgeView[] | Enabled topology edges a caller may traverse. |
motifSections必填MotifSection[] | Named motif sections available through the Trending route. |
pairs可选CatalogPairView[] |
ChangeActionType可选值 · 21
Every change a person or agent makes after create, in three families.
FactValueKind可选值 · 8
What kind of value one item fact holds, which fixes what core may compute from it.
ItemPage4
One ranked pending page and the owner's full matching open count.
object可选string | |
items必填TodoItem[] | AlertItem[] | ApprovalItem[] | NotificationItem[] | |
next_cursor可选string | null | |
total必填integer |
PositioningItemPage2
One page of items, groups kept together, for the side panel and agents.
items必填ItemRead[] | |
nextCursor可选string | null |
TodoApprovalStatus可选值 · 5
A decision remains separate from ordinary todo completion.
ArtifectHostApprovalStatus可选值 · 4
Inbox status mapped exhaustively by the backend adapter from its todo enum.
ExportedImage8
One immutable exported image, in board order, with its name, format, findings and AI fact.
position必填integer | |
designId必填string | |
name必填string | |
preset必填string | |
format必填RenderFormat | |
asset必填AssetRef | |
findings必填SlotFinding[] | |
aiGenerated可选boolean |
PostExportedImage2
One design of one immutable export; its HTTPS URL is minted only at Propose.
export必填ImageExportRef | |
altText可选string |
ProductOption2
Retain one named dimension/value pair for a Product variant.
name必填string | |
value必填string |
ShopifyProductOption2
One product option name and its values, e.g. Size: S, M, L.
name必填string | |
values必填string[] |
ProductImagesActorKind可选值 · 2
Who submitted an edit: the chat agent or the person in the editor (revision provenance).
ShopifyThemeRestoreRevision2
Make an earlier revision's document the new head (Keep/Undo on a change card).
action可选string | |
revision必填integer |
RestoreRevision3
Restore an earlier revision: the whole board (version history) or only object_ids (my-own undo).
action可选string | |
revision必填integer | |
objectIds可选string[] | null |
PauseReason可选值 · 4
Why sync stopped, including when a top-up is required.
MonitorPauseReason可选值 · 3
Why a monitor is paused; every value except OWNER is an auto-pause with a notice.
MonitorOwnerScope2
The owner one monitor belongs to: a user or an organization (keble-helpers OwnerType).
ownerType必填OwnerType | |
ownerId必填string |
OwnerScope1
The single owner every positioning read and write is scoped to.
owner必填string |
MonitorAgentBinding2
Which agent narrates: Keble's agent in the chat the monitor was created in, or the owner's own agent.
kind必填MonitorAgentKind | |
conversationId可选string | null |
MonitorAgentKind可选值 · 2
Which agent narrates reported cycles, decided by where the monitor was created.
MonitorCadenceUnit可选值 · 5
Units a cadence counts in; MINUTE stays in the contract while v1's floor is 60 minutes.
MonitorCapabilityOffer10
One watchable capability as offered to the agent: backend-authored and safe to show.
capabilityKey必填string | |
title必填string | |
channelLabel必填string | |
subjectHint必填string | |
policies必填MonitorFindingPolicy[] | |
freshnessLabel必填string | |
fetches必填boolean | |
minInterval必填string | |
readsPerCheck必填integer | |
markets可选string[] |
MonitorChangeKind可选值 · 3
The discriminator of what a finding reports.
MonitorChannelDelivery2
Where one channel's delivery of one cycle stands, read from its outbox row.
channel必填MonitorDeliveryChannel | |
status必填MonitorDeliveryStatus |
MonitorCoverageReason可选值 · 10
The one reason a watch's coverage is PARTIAL or NOT_CHECKED (the digest's "couldn't check X").
MonitorCycleState可选值 · 7
Where one scheduled check is; QUEUED, FETCHING and PROCESSING are open, the rest terminal.
MonitorDeliveryChannel可选值 · 3
Where one reported cycle (or an auto-pause notice) is delivered; one delivery row per channel.
MonitorDeliveryStatus可选值 · 5
Where one delivery row (one channel of one cycle) is; shown on the cycle row.
MonitorFetchHandle1
Opaque handle of one shared fetch, stored on the watch's cycle while it runs.
fetchKey必填string |
MonitorFindingItem9
One item as a finding shows it: display-safe labels, its public link, and its times.
ref必填MonitorRecordRef | |
title必填string | |
channelLabel必填string | |
link可选string | null | |
image可选string | null | |
publishedAt可选string | null | |
observedAt必填string | |
metrics可选MonitorItemMetric[] | |
rank可选integer | null |
MonitorFindingKey5
One finding's identity inside its monitor: cycle, watch, item and what changed.
cycleSeq必填integer | |
watchKey必填string | |
ref必填MonitorRecordRef | |
change必填MonitorChangeKind | |
metricKey可选string | null |
MonitorFindingPolicy可选值 · 3
How a watch decides what is new; owned by the monitor, not by the data platform.
MonitorItemMetric4
One tracked value of an item, with the smallest change worth reporting (backend-authored).
metricKey必填string | |
label必填string | |
value必填number | string | |
minChange必填number | string |
MonitorNewItem1
The item was never reported before by this watch.
kind可选string |
MonitorRankMove3
An entry entered (was None) or rose in a ranked list.
kind可选string | |
was可选integer | null | |
now必填integer |
MonitorRecordRef2
One record of the shared data, opaque to the core: a subject the agent found, or an item a fetch found.
recordKind必填string | |
recordKey必填string |
MonitorSetCadence2
Change the schedule; the next due is recomputed, an open cycle keeps its frozen spec.
command可选string | |
cadence必填MonitorCadence |
MonitorSetWatches2
Replace the watch list at once: compiles under the spec-revision fence, never re-enters setup.
command可选string | |
watches必填MonitorWatchRequest[] |
MonitorValueChange5
A tracked value moved by at least its minimum change since it was last reported (was -> now).
kind可选string | |
metricKey必填string | |
label必填string | |
was必填number | string | |
now必填number | string |
MonitorWatchCoverage可选值 · 4
What one watch could check this cycle, so "nothing new" is never "could not check".
MonitorWatchCycle12
One watch's progress and result inside one cycle.
watch必填MonitorWatch | |
fetch可选MonitorFetchHandle | null | |
fetchDeadlineAt可选string | null | |
fetchDelayed可选boolean | |
fetchReady可选boolean | |
found可选MonitorRecordRef[] | |
coverage可选MonitorWatchCoverage | null | |
reason可选MonitorCoverageReason | null | |
findings可选integer | |
readCalls可选integer | |
windowEnd可选string | null | |
dataAsOf可选string | null |
MonitorWatchRequest4
What the agent sends for one watch: a capability, a finding policy and its subjects.
capabilityKey必填string | |
policy必填MonitorFindingPolicy | |
subjects必填MonitorRecordRef[] | string[] | |
market可选string | null |
错误码
被拒绝的调用会返回一个错误体,包含错误码和你所用语言的说明。
| 错误码 | 含义 | 怎么办 |
|---|---|---|
INVALID_API_KEY | 密钥不存在或已撤销。 | 创建新密钥并替换旧密钥。 |
SIGNED_IN_ONLY | 这是网页内操作,API 密钥不可调用。 | 在 Keble 网页登录后操作。 |
ACCOUNT_DISABLED | 账号已注销。 | 如需恢复请联系 hi@keble.ai。 |
LAST_ORG_OWNER | 组织至少需要一位所有者。 | 请先将其他成员设为所有者。 |
ORG_DELETE_BLOCKED | 组织仍有余额、生效中的 Pro 或店铺,暂时不能删除。 | 按错误中列出的项逐一处理(将余额用至 0、等待 Pro 到期、移除店铺)后再删除。 |
IDENTITY_VERIFICATION_REQUIRED | 账户需要先验证身份。 | 在 Keble 网页完成验证后重试。 |
INVALID_REQUEST | 部分参数不正确,错误体会列出字段。 | 修正列出的字段后重试。 |
NOT_FOUND | 对象不存在,或你的账户无权查看。 | 检查 id,或重新列出以获取当前的 id。 |
STATE_CONFLICT | 调用被拒绝。 | 查看错误体中的说明。 |
ACCESS_REFUSED | 调用被拒绝。 | 查看错误体中的说明。 |
INVALID_QUERY | 调用被拒绝。 | 查看错误体中的说明。 |
RATE_LIMITED | 当前方案在本时段的请求次数已用完。 | 按 Retry-After 的时间等待,或升级方案。 |
INSUFFICIENT_BALANCE | 余额不足以完成这次调用。 | 充值后重试。 |
FEATURE_UNAVAILABLE | 该功能暂未开放。 | 改用其他能力,或联系支持。 |
STORE_PLAN_REQUIRED | 免费版不能同步店铺。 | 升级 Pro 或充值。 |
STORE_SLOT_LIMIT | 当前方案同时只能同步 1 个店铺,槽位已被其他店铺占用。 | 暂停另一个店铺,或充值。 |
STORE_TOP_UP_REQUIRED | 付费余额已用完,店铺已暂停。 | 充值后恢复。 |
STORE_CHANGE_IN_PROGRESS | 店铺正在更新。 | 请几秒后重试。 |
APPROVAL_EXPIRED | 修改提议在批准前已过期。 | 重新提议这次修改。 |
UPGRADE_REQUIRED | 需要 Pro、企业版或账户余额。 | 在 Keble 网页升级或充值。 |
LEGACY_PLAN | 旧版方案在新版本中不再支持。 | 在 Keble 网页转换会员。 |
TRYOUT_LIMIT_REACHED | 免费试用次数已用完。 | 登录后继续。 |
FREE_ALLOWANCE_UNAVAILABLE | 已有关联账号在使用免费额度。 | 升级 Pro 或充值即可继续使用。 |
UPSTREAM_UNAVAILABLE | Keble 依赖的服务暂时不可用。 | 稍后重试。 |
UPSTREAM_FAILED | 所需服务暂时故障。 | 请稍后重试。 |
TIMED_OUT | 调用超时。 | 重试;如果反复出现,请缩小问题范围。 |