开发者文档

Keble API 与 MCP

通过 MCP 或 HTTPS 把你自己的 AI Agent 或代码接入 Keble:搜索市场数据、读取已连接的店铺、生成报告、管理待办,只需一把 API 密钥。

1
登录后创建一把 API 密钥。密钥只显示一次,请妥善保存。
2
连接你的 AI Agent
把下方配置粘贴到你的 AI 工具,或在代码里直接调用 REST 路由。
3
调用一个接口
例如:“用 Keble 看看我能查哪些数据。”你的 AI Agent 会调用 dp_catalog。

38 个接口 · 37 个 MCP 工具 · OpenAPI (JSON)

部分接口会消耗余额,每个接口都标明价格;每次调用都记录在用量日志中。 价格 · 用量日志

认证与 MCP

写入 ~/.codex/config.toml

把占位符换成你在密钥页创建的密钥。 登录后创建密钥

每次调用都在 Authorization 请求头里带上你的 API 密钥。同一把密钥可用于 MCP 和 HTTPS。

请求头
Authorization: Bearer PASTE_YOUR_KEY_HERE
MCP 地址
/api/v3/mcp
REST 地址
/api/v3
调用方式说明

HTTPS:接口为 POST <REST 地址>/gateway/<工具名>,请求体为 JSON;下载类接口为 GET,参数放在查询字符串里。通过 MCP 调用时,用 tools/call 传入工具名,并把同一份请求体放在 "request" 里。

API 密钥
让你的 AI Agent 或代码代表你的账户操作,可随时在密钥页撤销。
MCP
AI 工具调用 Keble 这类服务的开放协议。
接口
一个可调用的操作;它的名称既是 REST 路径的最后一段,也是 MCP 工具名。

API 参考

38

API 密钥可调用的全部接口。每个接口都是一个 REST 路由(除下载表格外均为 POST);标注了 MCP 的,同时是同名的 MCP 工具,两者参数是同一份 JSON。字段说明为英文。

数据

搜索下一页MCP 工具 · dp_continue

POST/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.

以下之一: SearchPage | EntityPage | SearchPending | SearchRefused · 区分字段 object
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

POST/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.
默认: false
返回 · CustomerDpCatalogResponse

Expose the DP catalog or its typed refusal as one customer root schema.

以下之一: CapabilityCatalog | SearchRefused · 区分字段 object
curl -X POST \
  "/api/v3/gateway/dp_catalog" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{}'

数据新鲜度MCP 工具 · dp_freshness

POST/api/v3/gateway/dp_freshness

每类可搜索数据有多新。

认证
API 密钥:Authorization: Bearer <密钥>
价格
免费
请求体 · NoArguments
参数

无参数,发送 {} 即可。

返回 · CustomerDpFreshnessResponse

Expose the DP freshness projection or its typed refusal.

以下之一: Freshness | SearchRefused · 区分字段 object
curl -X POST \
  "/api/v3/gateway/dp_freshness" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{}'

记录详情MCP 工具 · dp_record

POST/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.

以下之一: RecordDetail | SearchRefused · 区分字段 object
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

POST/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.

以下之一: EntityPage | SearchPending | SearchRefused · 区分字段 object
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

POST/api/v3/gateway/elta_catalog

可以连接的店铺和数据来源。

认证
API 密钥:Authorization: Bearer <密钥>
价格
免费
请求体 · NoArguments
参数

无参数,发送 {} 即可。

返回 · PluginDeclarationCatalog

Every installed plugin's declaration plus the shared vocabulary.

object可选string
Document type: catalog.
可选值: catalog
默认: "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

POST/api/v3/gateway/elta_stores

已连接的店铺、它们的连接方式和同步状态。

认证
API 密钥:Authorization: Bearer <密钥>
价格
免费
请求体 · NoArguments
参数

无参数,发送 {} 即可。

返回 · StoresResponse

The stores belonging to the asserted owner, including unfinished stores.

object可选string
Document type: stores response.
可选值: stores_response
默认: "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

POST/api/v3/gateway/elta_store_capabilities

一个店铺现在能做什么:哪些实时查询、修改和数据可用,以及其余项因何不可用。

认证
API 密钥:Authorization: Bearer <密钥>
价格
免费
请求体 · ResumeStoreRequest
参数

One store, addressed by its id.

storeId必填string
The store's id.
返回 · StoreCapabilities

What the installed sources can do right now for one store: live reads, writes and captures.

object可选string
Document type: store capabilities.
可选值: store_capabilities
默认: "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

POST/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.
默认: {"limit":200}
返回 · 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.
可选值: metric_page
默认: "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

POST/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.
默认: {"limit":200}
返回 · 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.
可选值: fact_page
默认: "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

POST/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.
默认: {"limit":200}
返回 · 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.
可选值: fact_history_response
默认: "fact_history_response"
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

POST/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.
默认: {"limit":200}
返回 · 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

POST/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.
默认: {"limit":200}
返回 · 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.
可选值: lookup_page
默认: "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

POST/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.
默认: {"limit":200}
返回 · 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.
可选值: query_page
默认: "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

POST/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

POST/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
可选值: AMZ_PRODUCT_REPORT
默认: "AMZ_PRODUCT_REPORT"
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
可选值: POSITIONING
默认: "POSITIONING"
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
可选值: AMZ_ADS_ADVICE
默认: "AMZ_ADS_ADVICE"
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
可选值: PRODUCT_IMAGES
默认: "PRODUCT_IMAGES"
request必填CreateImageSet

Create one Shopify theme document workspace from the theme contract's document request.

kind可选string
可选值: SHOPIFY_THEME_UPDATE
默认: "SHOPIFY_THEME_UPDATE"
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
可选值: AMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGES
request必填ChangeListCreatePremise

Create one guided Shopify blog post set from the kind's own BlogCreate.

kind可选string
可选值: SHOPIFY_BLOG_POSTS
默认: "SHOPIFY_BLOG_POSTS"
request必填BlogCreate

Create one unpublished Shopify product draft from the kind's ProductCreateRequest.

kind可选string
可选值: SHOPIFY_PRODUCT
默认: "SHOPIFY_PRODUCT"
request必填ProductCreateRequest

Create one owner-fenced new Amazon listing draft from the kind's own ListingCreate.

kind可选string
可选值: AMZ_LISTING
默认: "AMZ_LISTING"
request必填ListingCreate

Create one Amazon FBA inbound plan artifect and file its plan proposal.

kind可选string
可选值: AMZ_FBA_INBOUND_PLAN
默认: "AMZ_FBA_INBOUND_PLAN"
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
可选值: MONITOR
默认: "MONITOR"
replayKey必填string
title必填string
返回 · CustomerArtifectCreateResponse

Expose an Artifect reference or sanitized Artifect failure.

以下之一: ArtifectRef | ArtifectAccountRequired | ArtifectFailure · 区分字段 object
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

POST/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

POST/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

POST/api/v3/gateway/artifect_cancel

取消正在运行的报告。

认证
API 密钥:Authorization: Bearer <密钥>
价格
免费
请求体 · ArtifectRef
参数

Identify one durable Artifect instance by its opaque public id.

object可选string
可选值: artifect_ref
默认: "artifect_ref"
id必填string
返回 · CustomerArtifectStatusResponse

Expose an Artifect lifecycle status or sanitized failure.

以下之一: ArtifectStatus | ArtifectFailure · 区分字段 object
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

POST/api/v3/gateway/artifect_status

报告进行到哪一步,以及它在等待什么。

认证
API 密钥:Authorization: Bearer <密钥>
价格
免费
请求体 · ArtifectRef
参数

Identify one durable Artifect instance by its opaque public id.

object可选string
可选值: artifect_ref
默认: "artifect_ref"
id必填string
返回 · CustomerArtifectStatusResponse

Expose an Artifect lifecycle status or sanitized failure.

以下之一: ArtifectStatus | ArtifectFailure · 区分字段 object
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

POST/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

POST/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.

以下之一: ArtifectSnapshot | ArtifectFailure · 区分字段 object
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

POST/api/v3/gateway/artifect_detail

按报告自身的类型,读取其中一部分,例如一个商品、一个单元格或一行广告建议。

认证
API 密钥:Authorization: Bearer <密钥>
价格
免费
请求体 · ArtifectDetailRequest
参数
返回 · CustomerArtifectDetailResponse

Expose one kind-typed Artifect detail answer or sanitized failure.

以下之一: ArtifectDetail | ArtifectFailure · 区分字段 object
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

POST/api/v3/gateway/artifect_plugins

定位分析可以使用的插件。

认证
API 密钥:Authorization: Bearer <密钥>
价格
免费
请求体 · NoArguments
参数

无参数,发送 {} 即可。

返回 · CustomerArtifectPluginListResponse

Expose the installed positioning plugins in a JSON-object envelope.

object可选string
可选值: artifect_plugin_list
默认: "artifect_plugin_list"
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

POST/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
默认: 5
before可选string | null
返回 · ArtifectRunList

One newest-first page; next_before is set only when an older run exists.

object可选string
可选值: artifect_run_list
默认: "artifect_run_list"
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

POST/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.
可选值: AMZ_PRODUCT_REPORTPOSITIONINGAMZ_ADS_ADVICEPRODUCT_IMAGESSHOPIFY_THEME_UPDATEAMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGESSHOPIFY_BLOG_POSTSSHOPIFY_PRODUCTAMZ_LISTINGAMZ_FBA_INBOUND_PLANMONITOR
返回 · 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"}'

下载建议表格

GET/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

POST/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

POST/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

POST/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

POST/api/v3/gateway/todo_create

添加一条待办;同一个幂等键重复提交返回第一条。

认证
API 密钥:Authorization: Bearer <密钥>
价格
免费
请求体 · TodoCreate
参数

Immutable original intent for an ordinary todo.

kind可选string
可选值: TODO
默认: "TODO"
content必填ItemContent
key可选string | null
返回 · CreateResult

Stored item and whether the call admitted a new row.

object可选string
可选值: create_result
默认: "create_result"
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

POST/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
可选值: TODO
默认: "TODO"
object可选string
可选值: todo_item
默认: "todo_item"
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

POST/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.

以下之一: TodoItem | AlertItem | ApprovalItem | NotificationItem · 区分字段 kind
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

POST/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
默认: 20
返回 · ItemPage

One ranked pending page and the owner's full matching open count.

object可选string
可选值: item_page
默认: "item_page"
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

POST/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.

以下之一: TodoItem | AlertItem | ApprovalItem | NotificationItem · 区分字段 kind
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

POST/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
默认: "FREIGHT"
isPeakPeriod可选boolean
默认: false
返回 · 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.

可选值: ZERO_WHEN_COVEREDUNKNOWN
AbsoluteTargetBidValue2

An absolute bid for a keyword, a product target or an exact-harvest keyword.

kind可选string
可选值: target_bid
默认: "target_bid"
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.

可选值: LIVESNAPSHOTPUBLIC_PAGE
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.
默认: false
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.

可选值: SET_BIDSET_STATESET_DAILY_BUDGETADD_KEYWORDADD_NEGATIVE_KEYWORD
ActionKind可选值 · 3

What one action does to its target; it selects the shared gate and diff colour.

可选值: SETADDREMOVE
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.
可选值: action_proposal
默认: "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.
默认: "PROPOSED"
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.

可选值: ACCEPTEDAPPLIEDNO_CHANGEREJECTEDUNKNOWN
AddBlock4

Add one block (caller-chosen stable key) to a section after another block (None: at the end).

action可选string
可选值: ADD_BLOCK
默认: "ADD_BLOCK"
sectionKey必填string
block必填ThemeBlockInstance
after可选string | null
AddDesign6

Add an empty OWN image; layouts come only from ApplyTemplate (one template path).

action可选string
可选值: ADD_DESIGN
默认: "ADD_DESIGN"
designId必填string
name必填string
preset必填string
可选值: amazon.aplus.banneramazon.aplus.comparisonamazon.aplus.four_imageamazon.aplus.headeramazon.aplus.logoamazon.aplus.quadrantamazon.aplus.singleamazon.aplus_premium.full_widthamazon.brand_story.backgroundamazon.brand_story.cardamazon.mainamazon.secondarycustomshopify.blog_featuredshopify.collectionshopify.product
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
可选值: ADD_ITEMS
默认: "ADD_ITEMS"
actionKey必填string
items必填SourcedItem[]
AddLayer5

Insert a layer (caller-minted id) above above, or at the top when None.

action可选string
可选值: ADD_LAYER
默认: "ADD_LAYER"
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
可选值: negative_keyword
默认: "negative_keyword"
matchType必填AdsNegativeMatch
AddPage4

Add an empty page for one template (UNKNOWN target refusals are the runtime's).

action可选string
可选值: ADD_PAGE
默认: "ADD_PAGE"
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
可选值: ADD_PLAN
默认: "ADD_PLAN"
objectId必填string
name必填string
sourceId必填string
columns必填PlanColumn[]
rows可选PlanRow[]
默认: []
position可选BoardPoint | null
AddRows2

Append rows (create also uses this shape).

op可选string
可选值: ADD_ROWS
默认: "ADD_ROWS"
rows必填NewChangeRow[]
AddSection4

Place a new section (caller-chosen stable key) on a page after an anchor (None: at the end).

action可选string
可选值: ADD_SECTION
默认: "ADD_SECTION"
page必填ThemeTemplateRef
section必填ThemeSectionInstance
after可选string | null
AdsAdType可选值 · 3

Amazon Ads product family one row belongs to (ELTA1 TodoAdType).

可选值: SPSBSD
AdsAdviceAction可选值 · 7

The one action the AI picks for one reviewed row (ELTA1 TodayAdviceAction).

可选值: LOWER_BIDNEGATEPAUSERAISE_BIDRAISE_BUDGETHARVEST_EXACTHOLD
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.

可选值: NO_ONE_CLICK_ROWSNO_ADS_ACCOUNTNOT_HOSTEDCREATE_FAILED
AdsDecisionType可选值 · 1

The Ads kind's one agent decision on the shared decision_type discriminator.

可选值: ADS_ROW_AUDIT
AdsEvidenceField可选值 · 8

The non-metric source facts of one AdsAdviceRow a citation may name.

可选值: namecampaign_namead_group_namestatebudgetbidtrigger_codesadvertised_asin
AdsEvidenceRole可选值 · 2

Whether one cited fact supports or cautions against the advice.

可选值: SUPPORTSCAUTION
AdsLevel可选值 · 6

Advice grain, mapped explicitly onto ELTA's EntityLevel.

可选值: CAMPAIGNAD_GROUPKEYWORDTARGETSEARCH_TERMADVERTISED_PRODUCT
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
默认: false
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
可选值: ads_marketplace
默认: "ads_marketplace"
marketplace必填AmazonMarketplace
action可选AdsAdviceAction | null
AdsMatchType可选值 · 3

Keyword-only match identity from the existing ELTA datasets.

可选值: EXACTPHRASEBROAD
AdsMetricEvidenceRef5

Cite one measured cell of the reviewed row by window and metric.

kind可选string
可选值: metric
默认: "metric"
rowKey必填string
window必填AdsMetricWindow
metric必填AdsMetricName
role必填AdsEvidenceRole
AdsMetricName可选值 · 6

The AdsWindowMetrics fields a metric citation may name.

可选值: impressionsclicksspendorderssalesacos_pct
AdsMetricWindow可选值 · 5

The five metric-window fields of one AdsAdviceRow a citation may name.

可选值: dd_minus_1d_minus_7l7p7
AdsNegativeMatch可选值 · 2

The agent's negative-keyword match choice; mapped once to ELTA's type.

可选值: EXACTPHRASE
AdsReadOnlyReason可选值 · 5

Why one shown advice row has no one-click change.

可选值: NO_ELTA_ACTIONNOT_SPONSORED_PRODUCTSNO_VALUEASIN_TERMOVER_ROW_CAP
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
可选值: ADS_ROW_AUDIT
默认: "ADS_ROW_AUDIT"
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
可选值: row_field
默认: "row_field"
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
可选值: ads_row
默认: "ads_row"
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).

可选值: SPEND_SPIKEZERO_ORDER_SPENDACOS_ABOVE_TARGETHARVEST_SEARCH_TERMSCALE_WINNERBUDGET_CAPPED
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
可选值: ALERT
默认: "ALERT"
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
可选值: ALERT
默认: "ALERT"
object可选string
可选值: alert_item
默认: "alert_item"
creation必填AlertCreate
status必填AlertStatus
resolved_by可选ActorRef | null
AlertStatus可选值 · 2

An alert is cleared only after its source confirms recovery.

可选值: OPENCLEARED
AlignField2

Override value: a text layer's alignment.

field可选string
可选值: ALIGN
默认: "ALIGN"
align必填TextAlign
AmazonMarketplace可选值 · 13
可选值: USCAMXJPUKDEESFRITNLSEPLBE
AmzProfitCalculateRequest4

One product's cost and shipping observations for the profit calculator.

costProfile必填CostProfile
shippingProfile必填ShippingProfile
shippingMode可选ShippingMode
默认: "FREIGHT"
isPeakPeriod可选boolean
默认: false
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.

可选值: NODEIDEACONCEPTRELATIONTREND
AnalyzedRelationKind可选值 · 13

Every relation row the platform may write: subject --kind--> object.

可选值: VARIANT_OFBRANDED_BYSOLD_BYPUBLISHED_BYBELONGS_TO_CATEGORYSAME_PRODUCT_ASFEATURES_PRODUCTFEATURES_BRANDRANKED_FORMEMBER_OF_MOTIFPROMOTESSAME_CREATOR_ASCOMPETES_WITH
AnswerLanguage可选值 · 2

Language of seller-facing clarification and refusal wording.

可选值: ZHEN
ApplyTemplate4

Replace a design's layers with a template's, filling its placeholders (the one template path).

action可选string
可选值: APPLY_TEMPLATE
默认: "APPLY_TEMPLATE"
designId必填string
template必填string
可选值: amazon.aplus.header.headlineamazon.main.packshotamazon.secondary.lifestyleamazon.secondary.three_calloutsshopify.blog_featured.headlineshopify.product.bold_dropshopify.product.packshot
fills可选TextFill[] | ImageFill[]
默认: []
ApprovalCreate7

Immutable SYSTEM-written proposal intent, verified proposer and expiry.

kind可选string
可选值: APPROVAL
默认: "APPROVAL"
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
可选值: APPROVAL
默认: "APPROVAL"
object可选string
可选值: approval_item
默认: "approval_item"
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
默认: false
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
可选值: artifect_account_required
默认: "artifect_account_required"
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
可选值: AMZ_ADS_ADVICE
默认: "AMZ_ADS_ADVICE"
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
可选值: AMZ_ADS_ADVICE
默认: "AMZ_ADS_ADVICE"
answer必填AdsMarketplaceAdvice | AdsRowDetail
ArtifectAdsAdviceDetailQuery2

Wrap the ads-advice detail query (owned by ads_advice).

kind可选string
可选值: AMZ_ADS_ADVICE
默认: "AMZ_ADS_ADVICE"
query必填AdsMarketplaceQuery | AdsRowQuery
ArtifectAdsAdviceRemove3

Remove advice rows in one marketplace, including manual-only advice.

adjustmentType可选string
可选值: ADS_ADVICE_REMOVE
默认: "ADS_ADVICE_REMOVE"
marketplace必填AmazonMarketplace
rowKeys必填string[]
ArtifectAdsAdviceSnapshot8

Expose one completed Ads optimization-suggestions run, per marketplace.

kind可选string
可选值: AMZ_ADS_ADVICE
默认: "AMZ_ADS_ADVICE"
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
ArtifectAdsRowAuditInputPage10

Input page for ADS_ROW_AUDIT: one page of flagged Ads rows to audit.

object可选string
可选值: artifect_input_page
默认: "artifect_input_page"
inputKey必填string
ownerRevision必填integer
instructions必填string
items可选AdsRowAuditItem[]
默认: []
coveredItemCount必填integer
itemCount必填integer
nextCursor可选string | null
deadline必填string
decisionType可选string
可选值: ADS_ROW_AUDIT
默认: "ADS_ROW_AUDIT"
ArtifectAmzListingCreate2

Create one owner-fenced new Amazon listing draft from the kind's own ListingCreate.

kind可选string
可选值: AMZ_LISTING
默认: "AMZ_LISTING"
request必填ListingCreate
ArtifectAmzListingEdit2

Replace an AMZ_LISTING draft's whole content (editor or agent edit).

adjustmentType可选string
可选值: AMZ_LISTING_EDIT
默认: "AMZ_LISTING_EDIT"
content必填ListingContent
ArtifectAmzListingPropose1

File the draft's one ADD for approval at the envelope's base_revision.

adjustmentType可选string
可选值: AMZ_LISTING_PROPOSE
默认: "AMZ_LISTING_PROPOSE"
ArtifectAmzListingProposeRevert1

File the undo (seller-SKU removal) of a LISTED draft at the envelope's base_revision.

adjustmentType可选string
可选值: AMZ_LISTING_PROPOSE_REVERT
默认: "AMZ_LISTING_PROPOSE_REVERT"
ArtifectAmzListingSnapshot2

Carry the listing core's current ListingSnapshot under its kind tag.

kind可选string
可选值: AMZ_LISTING
默认: "AMZ_LISTING"
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
可选值: AMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGES
request必填ChangeListCreatePremise
ArtifectChangeListEdit2

Submit the shared engine's typed edit operations through artifect_adjust.

adjustmentType可选string
可选值: CHANGE_LIST_EDIT
默认: "CHANGE_LIST_EDIT"
ops必填AddRows[] | EditRow[] | DiscardRow[] | RestoreRow[]
ArtifectChangeListPropose2

Ask the shared engine to file selected rows; empty selects every eligible row.

adjustmentType可选string
可选值: CHANGE_LIST_PROPOSE
默认: "CHANGE_LIST_PROPOSE"
rowKeys可选string[]
默认: []
ArtifectChangeListProposeRevert2

Ask the engine to revert selected applied rows; empty selects all eligible rows.

adjustmentType可选string
可选值: CHANGE_LIST_PROPOSE_REVERT
默认: "CHANGE_LIST_PROPOSE_REVERT"
rowKeys可选string[]
默认: []
ArtifectChangeListSnapshot2

Carry the engine's canonical current change-list snapshot under its kind tag.

kind可选string
可选值: AMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGESAMZ_MCF_ORDER
默认: "AMZ_LISTING_CHANGES"
snapshot必填ChangeListSnapshot
ArtifectDecisionRejection8

Report one typed refusal without failing the Artifect run.

object可选string
可选值: artifect_rejection
默认: "artifect_rejection"
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.
可选值: AMZ_PRODUCT_REPORTPOSITIONINGAMZ_ADS_ADVICEPRODUCT_IMAGESSHOPIFY_THEME_UPDATEAMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGESSHOPIFY_BLOG_POSTSSHOPIFY_PRODUCTAMZ_LISTINGAMZ_FBA_INBOUND_PLANMONITOR
ArtifectDetail4

One typed detail answer about one artifect.

object可选string
可选值: artifect_detail
默认: "artifect_detail"
ref必填ArtifectRef
payload必填ArtifectReportDetail | ArtifectPositioningDetail | ArtifectAdsAdviceDetail | ArtifectProductImagesDetail | ArtifectShopifyThemeRunDetail | ArtifectMonitorDetail | ArtifectOccurrences
capturedAt必填string
ArtifectDetailRequest2

Address one artifect and ask it one kind-typed detail question.

ref必填ArtifectRef
query必填ArtifectReportDetailQuery | ArtifectPositioningDetailQuery | ArtifectAdsAdviceDetailQuery | ArtifectProductImagesDetailQuery | ArtifectShopifyThemeQuery | ArtifectMonitorDetailQuery | ArtifectOccurrencesQuery
ArtifectFailure4

The provider-free failure one customer answer may carry.

object可选string
可选值: artifect_failure
默认: "artifect_failure"
code必填ArtifectFailureCode
retryable必填boolean
message必填string
ArtifectFailureCode可选值 · 7

Classify one sanitized failure a customer may see for an Artifect run.

可选值: NOT_FOUNDINVALID_REQUESTCONFLICTRATE_LIMITEDQUOTA_EXHAUSTEDUNAVAILABLEINTERNAL
ArtifectFbaInboundPlanCreate5

Create one Amazon FBA inbound plan artifect and file its plan proposal.

kind可选string
可选值: AMZ_FBA_INBOUND_PLAN
默认: "AMZ_FBA_INBOUND_PLAN"
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
可选值: AMZ_FBA_INBOUND_PLAN
默认: "AMZ_FBA_INBOUND_PLAN"
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
可选值: AMZ_FBA_INBOUND_PLAN_PROPOSE_PACKING
默认: "AMZ_FBA_INBOUND_PLAN_PROPOSE_PACKING"
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
可选值: AMZ_FBA_INBOUND_PLAN_PROPOSE_PLAN
默认: "AMZ_FBA_INBOUND_PLAN_PROPOSE_PLAN"
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
可选值: AMZ_FBA_INBOUND_PLAN_PROPOSE_REVERT
默认: "AMZ_FBA_INBOUND_PLAN_PROPOSE_REVERT"
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
可选值: artifect_input_page
默认: "artifect_input_page"
inputKey必填string
ownerRevision必填integer
instructions必填string
items可选ReportJudgmentEvidenceItem[]
Citable accepted artifacts.
默认: []
coveredItemCount必填integer
itemCount必填integer
nextCursor可选string | null
deadline必填string
decisionType可选string
可选值: JUDGMENT
默认: "JUDGMENT"
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.

可选值: AMZ_PRODUCT_REPORTPOSITIONINGAMZ_ADS_ADVICEPRODUCT_IMAGESSHOPIFY_THEME_UPDATEAMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGESSHOPIFY_BLOG_POSTSSHOPIFY_PRODUCTAMZ_MCF_ORDERAMZ_LISTINGAMZ_FBA_INBOUND_PLANMONITOR
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
可选值: artifect_input_page
默认: "artifect_input_page"
inputKey必填string
ownerRevision必填integer
instructions必填string
items可选ReportMaterialQuestion[]
默认: []
coveredItemCount必填integer
itemCount必填integer
nextCursor可选string | null
deadline必填string
decisionType可选string
可选值: MATERIAL_FACTS
默认: "MATERIAL_FACTS"
ArtifectMonitorAdjust2

Edit a monitor's watches, schedule or delivery at the status's revision (0.25.0).

adjustmentType可选string
可选值: MONITOR_ADJUST
默认: "MONITOR_ADJUST"
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
可选值: MONITOR_CONFIRM
默认: "MONITOR_CONFIRM"
ArtifectMonitorConfirmInputPage7

The MONITOR confirm page (0.25.0): "What we'll monitor" for the person to confirm.

object可选string
可选值: artifect_input_page
默认: "artifect_input_page"
decisionType可选string
可选值: MONITOR_CONFIRM
默认: "MONITOR_CONFIRM"
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
可选值: MONITOR
默认: "MONITOR"
replayKey必填string
title必填string
ArtifectMonitorDecisionType可选值 · 2

The two inputs a MONITOR draft parks on (0.25.0): setup, then the person's confirm.

可选值: MONITOR_SETUPMONITOR_CONFIRM
ArtifectMonitorDetail4

One monitor check in full (0.25.0), the answer to ArtifectMonitorDetailQuery.

kind可选string
可选值: MONITOR
默认: "MONITOR"
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
可选值: MONITOR
默认: "MONITOR"
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
可选值: MONITOR_SETUP
默认: "MONITOR_SETUP"
watches必填MonitorWatchRequest[]
cadence必填MonitorCadence
delivery可选MonitorDelivery
默认: {"chat":true,"email":false}
ArtifectMonitorSetupInputPage7

The MONITOR setup page (0.25.0): the core-rendered capability offers and the cadence floor.

object可选string
可选值: artifect_input_page
默认: "artifect_input_page"
decisionType可选string
可选值: MONITOR_SETUP
默认: "MONITOR_SETUP"
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
可选值: MONITOR
默认: "MONITOR"
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.

可选值: RUNNINGREPORTEDQUIETSKIPPEDFAILED
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
可选值: OCCURRENCES
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
可选值: POSITIONING_EDITS
默认: "POSITIONING_EDITS"
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
可选值: POSITIONING
默认: "POSITIONING"
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.

可选值: POSITIONING_STEP
ArtifectPositioningDetail2

Carry positioning's own answered detail and the labels its answer uses.

kind可选string
可选值: POSITIONING
默认: "POSITIONING"
answer必填PositioningDetail
ArtifectPositioningDetailQuery2

Wrap the POSITIONING package's own detail query for one positioning.

kind可选string
可选值: POSITIONING
默认: "POSITIONING"
query必填PositioningCellQuery | PositioningItemsQuery
ArtifectPositioningSnapshot3

Expose one committed POSITIONING revision through customer projections.

kind可选string
可选值: POSITIONING
默认: "POSITIONING"
room必填RoomPublicRead
decision必填RoomPublicDecisionRead
ArtifectPositioningStepCell2

One assessed cell the waiting step produced (the ASSESS review).

resultType可选string
可选值: CELL
默认: "CELL"
cell必填RoomCell
ArtifectPositioningStepDecision3

Answer a waiting positioning step: apply these edits, then continue.

decisionType可选string
可选值: POSITIONING_STEP
默认: "POSITIONING_STEP"
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
可选值: artifect_input_page
默认: "artifect_input_page"
decisionType可选string
可选值: POSITIONING_STEP
默认: "POSITIONING_STEP"
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
默认: "ITEM"
item必填ItemRead
ArtifectProductImagesCreate2

Create one product-image set from photos already uploaded through the image artifect.

kind可选string
可选值: PRODUCT_IMAGES
默认: "PRODUCT_IMAGES"
request必填CreateImageSet
ArtifectProductImagesDetail3

Carry the board's EXPORTS view and ephemeral links for its newest export.

kind可选string
可选值: PRODUCT_IMAGES
默认: "PRODUCT_IMAGES"
exports可选ExportSet[]
默认: []
newestUrls可选HostedImage[]
默认: []
ArtifectProductImagesDetailQuery2

Ask one image set one detail view.

kind可选string
可选值: PRODUCT_IMAGES
默认: "PRODUCT_IMAGES"
view必填ProductImagesDetailView
ArtifectProductImagesEdit3

Edit or quote one board using the image contract's own action batch.

adjustmentType可选string
可选值: PRODUCT_IMAGES_EDIT
默认: "PRODUCT_IMAGES_EDIT"
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
默认: false
ArtifectProductImagesExport3

Export one revision of an image set (head when revision is None).

adjustmentType可选string
可选值: PRODUCT_IMAGES_EXPORT
默认: "PRODUCT_IMAGES_EXPORT"
revision可选integer | null
options可选ExportOptions
ArtifectProductImagesQuote2

The no-write quote returned only by a product-images dry-run adjustment.

object可选string
可选值: artifect_quote
默认: "artifect_quote"
quote必填BatchQuote
ArtifectProductImagesSnapshot2

Expose the image contract's canonical multi-object board outline.

kind可选string
可选值: PRODUCT_IMAGES
默认: "PRODUCT_IMAGES"
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
可选值: artifect_ref
默认: "artifect_ref"
id必填string
ArtifectRejectionReason可选值 · 11

Why an answer or adjustment was refused with state left unchanged.

可选值: STALE_REVISIONWRONG_INPUTUNKNOWN_ITEMITEM_ALREADY_ANSWEREDCONFLICTNOT_IN_SAMPLEEVIDENCE_NOT_RETAINEDREVISION_CONFLICTRUN_TERMINALINVALID_EVIDENCEINVALID_VALUE
ArtifectReportCreate12

Carry the complete V3 report premise accepted by the runtime.

kind可选string
可选值: AMZ_PRODUCT_REPORT
默认: "AMZ_PRODUCT_REPORT"
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.

kind可选string
可选值: AMZ_PRODUCT_REPORT
默认: "AMZ_PRODUCT_REPORT"
answer必填ReportV3OverviewToolResult | ReportV3ListingsToolResult | ReportV3ListingDetailToolResult | ReportV3SectionToolResult | ReportV3ConclusionToolResult | ReportV3LifecycleToolResult | ReportV3EstimationToolResult | ReportV3JudgmentToolResult
ArtifectReportDetailQuery2

Wrap the REPORT package's own detail query for one report artifect.

kind可选string
可选值: AMZ_PRODUCT_REPORT
默认: "AMZ_PRODUCT_REPORT"
query必填ReportOverviewQuery | ReportListingsQuery | ReportListingQuery | ReportSectionQuery | ReportEvidenceQuery | ReportJudgmentQuery
ArtifectReportScopeInputPage10

Input page for REPORT_SCOPE: the offered category candidates.

object可选string
可选值: artifect_input_page
默认: "artifect_input_page"
inputKey必填string
ownerRevision必填integer
instructions必填string
items可选ReportScopeCandidate[]
默认: []
coveredItemCount必填integer
itemCount必填integer
nextCursor可选string | null
deadline必填string
decisionType可选string
可选值: REPORT_SCOPE
默认: "REPORT_SCOPE"
ArtifectReportSnapshot2

Expose one immutable progressive REPORT snapshot from report CRUD.

kind可选string
可选值: AMZ_PRODUCT_REPORT
默认: "AMZ_PRODUCT_REPORT"
payload必填ProgressiveReportSnapshot
ArtifectReportSystemEstimatedPurchaseCost2

Carry the seller's explicit agreement to let Keble estimate the cost.

source可选string
可选值: SYSTEM_ESTIMATED
默认: "SYSTEM_ESTIMATED"
sellerAgreed必填boolean
The seller agreed to use Keble's estimate; must be true. A create never assumes this agreement.
可选值: true
ArtifectReportUserPurchaseCost3

Carry the seller's own purchasing cost, as one value or a low/high range.

source可选string
可选值: USER_SUPPLIED
默认: "USER_SUPPLIED"
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
可选值: artifect_run_list
默认: "artifect_run_list"
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
默认: 5
before可选string | null
ArtifectSampleRelevanceInputPage10

Input page for SAMPLE_RELEVANCE: one page of frozen candidates.

object可选string
可选值: artifect_input_page
默认: "artifect_input_page"
inputKey必填string
ownerRevision必填integer
instructions必填string
items可选SampleRelevanceItem[]
默认: []
coveredItemCount必填integer
itemCount必填integer
nextCursor可选string | null
deadline必填string
decisionType可选string
可选值: SAMPLE_RELEVANCE
默认: "SAMPLE_RELEVANCE"
ArtifectShopifyBlogPostsCreate2

Create one guided Shopify blog post set from the kind's own BlogCreate.

kind可选string
可选值: SHOPIFY_BLOG_POSTS
默认: "SHOPIFY_BLOG_POSTS"
request必填BlogCreate
ArtifectShopifyBlogPostsDecisionType可选值 · 1

The one blog-posts answer family: the parked guided step's answer.

可选值: SHOPIFY_BLOG_POSTS_STEP
ArtifectShopifyBlogPostsEdits2

Edit a READY blog post set before create-all: replace or drop posts.

adjustmentType可选string
可选值: SHOPIFY_BLOG_POSTS_EDITS
默认: "SHOPIFY_BLOG_POSTS_EDITS"
edits必填ReplacePost[] | DropPost[]
ArtifectShopifyBlogPostsPropose1

File create-all for the READY post set at the envelope's base_revision.

adjustmentType可选string
可选值: SHOPIFY_BLOG_POSTS_PROPOSE
默认: "SHOPIFY_BLOG_POSTS_PROPOSE"
ArtifectShopifyBlogPostsProposeRevert1

File revert-all of the applied create-all's still-live articles at base_revision.

adjustmentType可选string
可选值: SHOPIFY_BLOG_POSTS_PROPOSE_REVERT
默认: "SHOPIFY_BLOG_POSTS_PROPOSE_REVERT"
ArtifectShopifyBlogPostsSnapshot2

Carry the blog-posts kind's revisioned BlogSnapshot under its kind tag, minus its staged batch.

kind可选string
可选值: SHOPIFY_BLOG_POSTS
默认: "SHOPIFY_BLOG_POSTS"
snapshot必填BlogSnapshot
ArtifectShopifyBlogPostsStepDecision2

Answer the parked guided blog step with that step's own answer model.

decisionType可选string
可选值: SHOPIFY_BLOG_POSTS_STEP
默认: "SHOPIFY_BLOG_POSTS_STEP"
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
可选值: artifect_input_page
默认: "artifect_input_page"
inputKey必填string
ownerRevision必填integer
instructions必填string
items可选PlannedPost[]
默认: []
coveredItemCount必填integer
itemCount必填integer
nextCursor可选string | null
deadline必填string
decisionType可选string
可选值: SHOPIFY_BLOG_POSTS_STEP
默认: "SHOPIFY_BLOG_POSTS_STEP"
step必填BlogStep
ArtifectShopifyProductCreate2

Create one unpublished Shopify product draft from the kind's ProductCreateRequest.

kind可选string
可选值: SHOPIFY_PRODUCT
默认: "SHOPIFY_PRODUCT"
request必填ProductCreateRequest
ArtifectShopifyProductEdit2

Replace a Shopify product draft's whole content (pane or agent edit).

adjustmentType可选string
可选值: SHOPIFY_PRODUCT_EDIT
默认: "SHOPIFY_PRODUCT_EDIT"
content必填ProductContent
ArtifectShopifyProductPropose1

File the draft's one product.create at the envelope's base_revision.

adjustmentType可选string
可选值: SHOPIFY_PRODUCT_PROPOSE
默认: "SHOPIFY_PRODUCT_PROPOSE"
ArtifectShopifyProductProposeRevert1

File one product.delete for the run's single live product, at base_revision.

adjustmentType可选string
可选值: SHOPIFY_PRODUCT_PROPOSE_REVERT
默认: "SHOPIFY_PRODUCT_PROPOSE_REVERT"
ArtifectShopifyProductSnapshot2

Carry the product kind's revisioned ProductSnapshot under its kind tag, minus its staged batch.

kind可选string
可选值: SHOPIFY_PRODUCT
默认: "SHOPIFY_PRODUCT"
snapshot必填ProductSnapshot
ArtifectShopifyThemeCreate2

Create one Shopify theme document workspace from the theme contract's document request.

kind可选string
可选值: SHOPIFY_THEME_UPDATE
默认: "SHOPIFY_THEME_UPDATE"
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
可选值: SHOPIFY_THEME_UPDATE
默认: "SHOPIFY_THEME_UPDATE"
changeSet必填ThemeChangeSet
proposalStates可选ThemeProposalStateRead[]
默认: []
ArtifectShopifyThemeDetailQuery2

Legacy change-set runs only: address one change set of the run for a detail read.

kind可选string
可选值: SHOPIFY_THEME_UPDATE
默认: "SHOPIFY_THEME_UPDATE"
changeSetId必填string
ArtifectShopifyThemeDiscardPreview1

File the delete of the run's one preview copy (explicit only; abandonment never discards).

adjustmentType可选string
可选值: SHOPIFY_THEME_UPDATE_DISCARD_PREVIEW
默认: "SHOPIFY_THEME_UPDATE_DISCARD_PREVIEW"
ArtifectShopifyThemeDocumentDetail3

Carry one detail answer of a theme DOCUMENT run (the report/positioning nested-answer pattern).

kind可选string
可选值: SHOPIFY_THEME_UPDATE
默认: "SHOPIFY_THEME_UPDATE"
runKind可选string
可选值: DOCUMENT
默认: "DOCUMENT"
answer必填ArtifectShopifyThemeRevisionAnswer | ArtifectShopifyThemeTemplatesAnswer | ArtifectShopifyThemeTemplateOutlineAnswer
ArtifectShopifyThemeDocumentQuery3

Address one detail view of a theme DOCUMENT run (the report/positioning nested-query pattern).

kind可选string
可选值: SHOPIFY_THEME_UPDATE
默认: "SHOPIFY_THEME_UPDATE"
runKind必填string
可选值: DOCUMENT
query必填ArtifectShopifyThemeRevisionQuery | ArtifectShopifyThemeTemplatesQuery | ArtifectShopifyThemeTemplateOutlineQuery
ArtifectShopifyThemeDocumentSnapshot4

Expose a theme DOCUMENT run's snapshot: the theme contract's document snapshot plus live states.

kind可选string
可选值: SHOPIFY_THEME_UPDATE
默认: "SHOPIFY_THEME_UPDATE"
runKind可选string
可选值: DOCUMENT
默认: "DOCUMENT"
snapshot必填ThemeDocumentSnapshot
proposalStates可选ThemeDocumentProposalStateRead[]
默认: []
ArtifectShopifyThemeEdit2

Edit one theme document: the theme contract's own typed page actions, applied as one batch.

adjustmentType可选string
可选值: SHOPIFY_THEME_UPDATE_EDIT
默认: "SHOPIFY_THEME_UPDATE_EDIT"
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
可选值: SHOPIFY_THEME_UPDATE_PROPOSE_DISCARD
默认: "SHOPIFY_THEME_UPDATE_PROPOSE_DISCARD"
changeSetId必填string
ArtifectShopifyThemeProposeRevert2

Legacy change-set runs only: propose ELTA's undo of one accepted change set.

adjustmentType可选string
可选值: SHOPIFY_THEME_UPDATE_PROPOSE_REVERT
默认: "SHOPIFY_THEME_UPDATE_PROPOSE_REVERT"
changeSetId必填string
ArtifectShopifyThemePublish2

File one publish of a document revision onto the run's target theme.

adjustmentType可选string
可选值: SHOPIFY_THEME_UPDATE_PUBLISH
默认: "SHOPIFY_THEME_UPDATE_PUBLISH"
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
默认: "REVISION"
revision必填ThemeRevision
ArtifectShopifyThemeRevisionQuery2

Ask a theme DOCUMENT run for one committed revision (the REVISION(n) view).

view可选string
可选值: REVISION
默认: "REVISION"
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
可选值: SHOPIFY_THEME_UPDATE
默认: "SHOPIFY_THEME_UPDATE"
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
可选值: TEMPLATE_OUTLINE
默认: "TEMPLATE_OUTLINE"
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_OUTLINE
默认: "TEMPLATE_OUTLINE"
template必填ThemeTemplateRef
source可选ThemeFrameSource
默认: "TARGET"
ArtifectShopifyThemeTemplatesAnswer3

Answer the TEMPLATES view: the placeable JSON page templates the read theme has now.

view可选string
可选值: TEMPLATES
默认: "TEMPLATES"
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
可选值: TEMPLATES
默认: "TEMPLATES"
source可选ThemeFrameSource
默认: "TARGET"
ArtifectShopifyThemeUpdatePreview1

File one step toward the run's preview copy holding the head revision; it waits in To do for a person.

adjustmentType可选string
可选值: SHOPIFY_THEME_UPDATE_UPDATE_PREVIEW
默认: "SHOPIFY_THEME_UPDATE_UPDATE_PREVIEW"
ArtifectSnapshot4

Expose one immutable domain snapshot and optional ephemeral image parts.

object可选string
可选值: artifect_snapshot
默认: "artifect_snapshot"
ref必填ArtifectRef
payload必填ArtifectReportSnapshot | ArtifectPositioningSnapshot | ArtifectAdsAdviceSnapshot | ArtifectProductImagesSnapshot | ArtifectShopifyThemeRunSnapshot | ArtifectChangeListSnapshot | ArtifectShopifyBlogPostsSnapshot | ArtifectShopifyProductSnapshot | ArtifectAmzListingSnapshot | ArtifectFbaInboundPlanSnapshot | ArtifectMonitorSnapshot
capturedAt必填string
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
可选值: artifect_input_page
默认: "artifect_input_page"
inputKey必填string
ownerRevision必填integer
instructions必填string
items可选StandoutItem[]
默认: []
coveredItemCount必填integer
itemCount必填integer
nextCursor可选string | null
deadline必填string
decisionType可选string
可选值: STANDOUT_SELECTION
默认: "STANDOUT_SELECTION"
ArtifectStatus14

Report the lifecycle projection of one Artifect instance.

object可选string
可选值: artifect_status
默认: "artifect_status"
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
可选值: ASSESS
默认: "ASSESS"
actionKey必填string
assessments必填string[]
cellKeys可选string[] | null
missingOnly可选boolean
默认: false
AssessmentDetailValue4

An ASSESSMENT detail row: one stored judgement for the cell.

object可选string
可选值: assessment_detail_value
默认: "assessment_detail_value"
kind可选string
可选值: ASSESSMENT
默认: "ASSESSMENT"
key必填string
assessment可选AssessmentResult | null
AssessmentDisplay可选值 · 2

How an assessment row is drawn; the frontend owns the visuals.

可选值: TEXTINTERVAL
AssessmentKind可选值 · 2

What a model returns for one cell: numeric ranges, or yes/no with reasoning.

可选值: RANGEFLAG
AssessmentRange2

One numeric range an assessment returns.

label必填string
unit必填LocalizedText
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
默认: "ASSESSMENT"
assessment必填string
display可选AssessmentDisplay
默认: "TEXT"
AssetOrigin可选值 · 5

How an asset came to exist (provenance; the fidelity law and check read it).

可选值: UPLOADCUTOUT_MASKGENERATEDEXPORTREFERENCE
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.
可选值: attribute
默认: "attribute"
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.

可选值: AVAILABLEINCOMPLETEUNAVAILABLE
BackgroundField2

Override value: the variant canvas background.

field可选string
可选值: BACKGROUND
默认: "BACKGROUND"
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
可选值: BLEND
默认: "BLEND"
blendMode必填BlendMode
BlendMode可选值 · 6

How a layer mixes with pixels under it inside the same image.

可选值: NORMALMULTIPLYSCREENOVERLAYSOFT_LIGHTCOLOR
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
可选值: DIRECTION
默认: "DIRECTION"
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).

可选值: DIRECTIONPOST_PLANSTYLE_EXAMPLESPOST_DRAFTSSELF_REVIEWSAMPLE_CONFIRMATION
BoardObjectKind可选值 · 3

The board object kinds (discriminator of BoardObject).

可选值: IMAGEPLANBRAND_KIT
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
默认: 0
BoxField2

Override value: the layer's box.

field可选string
可选值: BOX
默认: "BOX"
box必填Box
Brand4

A DP-derived brand label and its existing product count.

kind可选string
Node discriminator; always BRAND.
可选值: BRAND
默认: "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
可选值: BRAND
默认: "BRAND"
values必填string[]
BrandColorRef3

A colour that follows one kit entry. Swapping kits never re-points it (owner: any number of colours).

ref可选string
可选值: BRAND
默认: "BRAND"
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
可选值: BRAND
默认: "BRAND"
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
可选值: CANCEL
默认: "CANCEL"
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.

可选值: READYGRANT_UNKNOWNPERMISSION_MISSINGFAMILY_OFFSTORE_PAUSEDNOT_CONNECTEDRECONSENT_REQUIREDBLOCKED
CaptureStyle以下之一 · 3
以下之一: WindowCapture | ChangeCapture | ListingCapture · 区分字段 kind
CatalogAvailability可选值 · 3

Whether a source or published analyzed rows can answer a cell.

可选值: SUPPORTEDEXACT_ID_ONLYNONE
CatalogCellView11

One channel and kind's public capability cell.

object必填string
Public object discriminator.
可选值: catalog_cell
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.
默认: false
acceptsWindow可选boolean
Published rows of this kind have a windowed metric or feature binding.
默认: false
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.
可选值: catalog_edge
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.
可选值: catalog_pair
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
可选值: CATEGORY
默认: "CATEGORY"
values必填string[]
op可选string
可选值: INNOT_IN
默认: "IN"
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.
可选值: changes
默认: "changes"
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.

可选值: DRAFTREADYPROPOSEDDECIDED
ChangeRow6

One proposed write: a bound ELTA action, its rationale and local inclusion state.

rowKey必填string
action必填ProviderAction
rationale必填string
status可选ChangeRowStatus
默认: "KEPT"
origin必填ChangeRowOrigin
preview可选RowPreview | null
ChangeRowOrigin可选值 · 2

Who wrote a row first; set once by the engine and kept through every edit.

可选值: KIND_CREATEAGENT_ADD
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.

可选值: KEPTDISCARDED
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.
默认: {"limit":200}
Channel可选值 · 7

Identify a source channel without exposing its provider implementation.

可选值: AMAZONTIKTOKSHOPIFYALIBABA_1688YOUTUBEINSTAGRAMREDDIT
ChargeRefusalCode可选值 · 1

Why the money owner refused one paid step, when the payer can act on it (0.6.0).

可选值: INSUFFICIENT_BALANCE
ClaimEmotion可选值 · 5

How the item feels about the claimed entity, on a 5-level scale.

可选值: STRONGLY_NEGATIVENEGATIVENEUTRALPOSITIVESTRONGLY_POSITIVE
ClaimStance可选值 · 4

The stance one claim's supporting text shows toward the entity.

可选值: RECOMMENDSNEUTRALCRITICIZESCOMPARES_AGAINST
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
可选值: CLASSIFY
默认: "CLASSIFY"
actionKey必填string
dimensionKeys必填string[]
itemKeys可选string[] | null
Color1

An sRGB colour with alpha, stored as #rrggbbaa.

hex必填string
ColorField2

Override value: a text layer's colour.

field可选string
可选值: COLOR
默认: "COLOR"
color必填Color | BrandColorRef
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.
可选值: STRINTFLOATBOOLTIMESTAMPDECIMALNULL
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
以下之一: SumCombine | LastCombine | RatioCombine · 区分字段 kind
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
默认: 0
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.
可选值: CONCEPT
默认: "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.

可选值: CATEGORYATTRIBUTEPROBLEMUSER_NEEDMECHANISMINDUSTRYHOOKFORMATSELLING_POINTSCENEVISUALLOGOICONPATTERN
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
可选值: conclusion_detail_value
默认: "conclusion_detail_value"
kind可选string
可选值: CONCLUSION
默认: "CONCLUSION"
key必填string
conclusion必填ConclusionStatus
assessment可选AssessmentResult | null
ConclusionRow2

The cell's tinted conclusion: the first raised signal wins, else NEUTRAL.

kind可选string
可选值: CONCLUSION
默认: "CONCLUSION"
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).

可选值: OPPORTUNITYCAUTIONNEUTRALUNAVAILABLE
ConnectStyle可选值 · 2

How an owner binds a source: a consent redirect, or credentials they enter.

可选值: CONSENTCREDENTIALS
ConnectionRecord15

One owner's grant for one plugin source, and the accounts it reaches.

object可选string
Document type: connector record.
可选值: connection_record
默认: "connection_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.
默认: false
ConnectionStatus可选值 · 3

Where one bound connection stands.

可选值: PENDINGACTIVERECONSENT_REQUIRED
Contact9

Represent one creator-linked contact record with optional contact facts.

kind可选string
可选值: CONTACT
默认: "CONTACT"
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
可选值: CONTACT
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
可选值: CONTENT
默认: "CONTENT"
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
默认: "UNKNOWN"
market可选string | null
textTracks可选SocialTextTrack[]
默认: []
comments可选Comment[]
默认: []
status可选ContentStatus
默认: "AVAILABLE"
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).

可选值: OWNVARIANT
ContentSponsorship可选值 · 4

What the platform itself declares about payment for one Content item.

可选值: ORGANICPAID_ADPAID_PARTNERSHIPUNKNOWN
ContentStatus可选值 · 4

Describe whether one Content item remains available.

可选值: AVAILABLEDELETED_BY_AUTHORREMOVED_BY_MODERATORUNKNOWN
ContentType可选值 · 4

Describe the provider-neutral presentation form of one Content item.

可选值: VIDEOIMAGETEXTTHREAD
Continue3

Accept the reviewed step's current result (as edited) and let the run go on.

type可选string
可选值: CONTINUE
默认: "CONTINUE"
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
可选值: cmminch
marketplace必填AmazonMarketplace
weight必填number
weightUnit必填string
可选值: poundouncekgg
expectedAdsCostRatio必填number
expectedCustomerReturnedRatio可选number
默认: 0.025
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
可选值: create_result
默认: "create_result"
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
可选值: CREATE_VARIANTS
默认: "CREATE_VARIANTS"
sourceId必填string
variants必填VariantSpec[]
Creator13

Represent one publishing account without inferring a real-world person.

kind可选string
可选值: CREATOR
默认: "CREATOR"
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.
可选值: CREATOR_HANDLE
默认: "CREATOR_HANDLE"
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.
默认: false
secret可选boolean
Whether this value must be hidden when displayed.
默认: true
updatable可选boolean
Whether the owner may replace this entered value alone on the held connection.
默认: false
required可选boolean
Whether the binding form requires this entered value.
默认: true
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
CropField2

Override value: an image layer's crop (None = uncropped).

field可选string
可选值: CROP
默认: "CROP"
crop必填Box | null
Currency可选值 · 159

Currencies full list: https://en.wikipedia.org/wiki/ISO_4217#Active_codes

可选值: AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBYRBZDCADCDFCHFCLPCNYCOPCRCCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKIDKMFKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUYUUZSVEFVESVNDVUVWSTXAFXCDXOFXPFXXXYERZARZMW
CurrencyBasis可选值 · 2

State how a MONEY value's currency is known.

可选值: STATEDASSUMED
CustomerArtifectCreateResponse以下之一 · 3

Expose an Artifect reference or sanitized Artifect failure.

以下之一: ArtifectRef | ArtifectAccountRequired | ArtifectFailure · 区分字段 object
CustomerArtifectDecisionResponse以下之一 · 4

Expose an Artifect decision status, rejection or sanitized failure.

CustomerArtifectDetailResponse以下之一 · 2

Expose one kind-typed Artifect detail answer or sanitized failure.

以下之一: ArtifectDetail | ArtifectFailure · 区分字段 object
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
可选值: artifect_plugin_list
默认: "artifect_plugin_list"
plugins必填RoomPublicDeclaration[]
CustomerArtifectSnapshotResponse以下之一 · 2

Expose an Artifect snapshot or sanitized failure.

以下之一: ArtifectSnapshot | ArtifectFailure · 区分字段 object
CustomerArtifectStatusResponse以下之一 · 2

Expose an Artifect lifecycle status or sanitized failure.

以下之一: ArtifectStatus | ArtifectFailure · 区分字段 object
CustomerDpCatalogResponse以下之一 · 2

Expose the DP catalog or its typed refusal as one customer root schema.

以下之一: CapabilityCatalog | SearchRefused · 区分字段 object
CustomerDpContinueResponse以下之一 · 4

Expose one discriminated DP continuation answer.

以下之一: SearchPage | EntityPage | SearchPending | SearchRefused · 区分字段 object
CustomerDpFreshnessResponse以下之一 · 2

Expose the DP freshness projection or its typed refusal.

以下之一: Freshness | SearchRefused · 区分字段 object
CustomerDpMotifsResponse以下之一 · 3

Expose one DP motif page, its pending variant or a typed refusal.

以下之一: EntityPage | SearchPending | SearchRefused · 区分字段 object
CustomerDpRecordResponse以下之一 · 2

Expose one DP record detail or its typed refusal.

以下之一: RecordDetail | SearchRefused · 区分字段 object
CustomerDpSearchResponse以下之一 · 6

Expose the full discriminated DP search answer without copying DP fields.

以下之一: SearchPage | EntityPage | SearchPending | SearchClarify | SearchAnswer | SearchRefused · 区分字段 object
CustomerInboxItemResponse以下之一 · 4

Expose the inbox owner's todo/approval union without copying either item model.

以下之一: TodoItem | AlertItem | ApprovalItem | NotificationItem · 区分字段 kind
CutOutProduct3

Paid: cut the product out of a PRODUCT layer's photo.

action可选string
可选值: CUT_OUT_PRODUCT
默认: "CUT_OUT_PRODUCT"
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.
默认: false
DateClause4

Bound one launch instant from below or above.

kind可选string
可选值: DATE
默认: "DATE"
field必填string
可选值: released_atpublished_atfirst_tracked_at
op必填string
可选值: GTELTE
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
可选值: DECIDE
默认: "DECIDE"
actionKey必填string
Decider可选值 · 2

Who decides a step's result before the run moves on.

可选值: MODELCALLER
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).

可选值: NO_EVIDENCERUN_IN_FLIGHTTABLE_NOT_READY
DecisionStatus可选值 · 3

A decision run is one explicit intent; only one runs at a time (existing ruling).

可选值: RUNNINGSUCCEEDEDFAILED
DeleteCriterion3

Delete one criterion and its results; views naming it show no criterion.

type可选string
可选值: DELETE_CRITERION
默认: "DELETE_CRITERION"
actionKey必填string
key必填string
DeleteDimension3

Delete one dimension and its placements; views naming it fall back to their other axes.

type可选string
可选值: DELETE_DIMENSION
默认: "DELETE_DIMENSION"
actionKey必填string
dimensionKey必填string
DeleteView5

Delete one saved view from the viewer's viewport (the first definition cannot be deleted).

type可选string
可选值: DELETE_VIEW
默认: "DELETE_VIEW"
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
可选值: DETACH_VARIANT
默认: "DETACH_VARIANT"
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.
默认: false
textHunks可选TextHunk[]
Raw line operations for a text-file diff.
默认: []
DiffLineKind可选值 · 4

Meaning and display treatment of one requested change or provider estimate.

可选值: ADDEDCHANGEDREMOVEDESTIMATE
DimensionOrigin可选值 · 2

Where a dimension's placements come from: cut from a fact, or judged (model or caller).

可选值: COMPUTEDCLASSIFIED
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
可选值: DISCARD_ROW
默认: "DISCARD_ROW"
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.
默认: false
DriftPolicy可选值 · 2

Whether a write may proceed after its target changed since preview.

可选值: APPLY_ANYWAYREFUSE
DropPost2

Leave one post out of create-all.

edit可选string
可选值: DROP_POST
默认: "DROP_POST"
postKey必填string
DropShadow4

A rendered shadow under any leaf layer (procedural, deterministic, free).

color必填Color | BrandColorRef
blur必填number
offsetX可选number
默认: 0
offsetY可选number
默认: 0
EditActionKind可选值 · 32

Every edit the agent or the editor can make (discriminator of EditAction).

可选值: ADD_DESIGNREMOVE_DESIGNORDER_DESIGNSRESIZE_DESIGNSET_BACKGROUNDAPPLY_TEMPLATEADD_LAYERREMOVE_LAYERSORDER_LAYERSET_BOXSET_LAYER_FLAGSSET_TEXTSET_TEXT_STYLESET_SHAPE_STYLESET_SHADOWGROUP_LAYERSUNGROUP_LAYERCUT_OUT_PRODUCTGENERATE_SCENERESTORE_REVISIONSET_OBJECT_FRAMESET_OBJECT_LOCKCREATE_VARIANTSSET_VARIANT_RECIPEDETACH_VARIANTADD_PLANSET_PLANGENERATE_FROM_PLANPLACE_BRAND_KITSET_IMAGE_TRANSFORMGENERATE_DECORSET_BOARD_TITLE
EditRefusal8

A refused batch or step, pointing at the first offending action so the agent can fix and resubmit.

outcome可选string
可选值: REFUSED
默认: "REFUSED"
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.

可选值: STALE_REVISIONUNKNOWN_DESIGNUNKNOWN_LAYERUNKNOWN_REVISIONUNKNOWN_ASSETDUPLICATE_IDWRONG_LAYER_KINDWRONG_ROLELAYER_LOCKEDTEMPLATE_PRESET_MISMATCHMISSING_FILLMISSING_MASKAI_PAUSEDPAYMENT_REFUSEDINVALID_ACTION_BATCHOBJECT_LOCKEDOBJECT_BUSYPARENT_IS_VARIANTDETACH_REQUIREDHAS_VARIANTSUNKNOWN_PLAN_ROWUNKNOWN_BRAND_KITBOARD_FULLBATCH_TOO_LARGEINVALID_SIZE
EditRow4

Replace one row's account-free action without changing key, type or target.

op可选string
可选值: EDIT_ROW
默认: "EDIT_ROW"
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
可选值: ELLIPSE
默认: "ELLIPSE"
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.
默认: false
object必填string
Public object discriminator.
可选值: entity_page
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.

可选值: AMAZON_OBSERVEDUSER_SUPPLIEDCOHORT_INFERREDPUBLIC_WEB_RESEARCHUNRESOLVED
EstimationStatus可选值 · 3

State whether a reported metric is actual, estimated, or unknown.

可选值: UNKNOWNACTUALESTIMATED
EvidenceBasis可选值 · 3

HOW STRONGLY a fact supports a hit.

可选值: RECORDEDMENTIONEDSIMILAR
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
可选值: EXCLUDE_ASINS
默认: "EXCLUDE_ASINS"
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
默认: 1
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.

可选值: GTINEANUPCSKUMODEL_NUMBER
FactChange以下之一 · 2
以下之一: AttributeChange | MeasureChange · 区分字段 kind
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.
可选值: fact_history_response
默认: "fact_history_response"
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.
可选值: fact_page
默认: "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.
默认: {"limit":200}
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.

可选值: PUBLIC_REQUEST
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.

可选值: ACTIVEVOIDEDCLOSED
FbaInboundStage可选值 · 7

Where one FBA inbound plan is; the kind's pure stage(...) derives it on every read.

可选值: DRAFTCREATE_PENDINGCREATE_UNKNOWNPACKING_DRAFTPACKING_PENDINGPACKEDCANCELLED
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
默认: "FILL"
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
可选值: FLIP
默认: "FLIP"
flipX必填boolean
flipY必填boolean
FontField2

Override value: a text layer's font.

field可选string
可选值: FONT
默认: "FONT"
font必填string | BrandFontRef
FontSizeField2

Override value: a text layer's font size in canvas pixels.

field可选string
可选值: FONT_SIZE
默认: "FONT_SIZE"
size必填number
FontWeight可选值 · 3

The static weights available in the hosted, licence-cleared font manifest.

可选值: REGULARMEDIUMBOLD
FontWeightField2

Override value: a text layer's font weight.

field可选string
可选值: FONT_WEIGHT
默认: "FONT_WEIGHT"
weight必填FontWeight
FrameEvidence3

The frame ONE element cites as its evidence.

kind可选string
Evidence discriminator; always FRAME.
可选值: FRAME
默认: "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.
可选值: freshness
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.

可选值: SOURCE_CHANGEDLAST_CHECKEDLAST_NEW_VALUE
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.

可选值: UNLINKED_CLAIMSUNHYDRATED_ENDPOINTSMISSING_OBSERVATIONSCELL_EMPTYNO_MATCHNO_INPUTUPSTREAM_EMPTY
GatewayError8

The one customer error body: a stable code, a localized message and the offending fields.

object可选string
可选值: error
默认: "error"
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.

可选值: INVALID_API_KEYSIGNED_IN_ONLYACCOUNT_DISABLEDLAST_ORG_OWNERORG_DELETE_BLOCKEDIDENTITY_VERIFICATION_REQUIREDINVALID_REQUESTNOT_FOUNDSTATE_CONFLICTACCESS_REFUSEDINVALID_QUERYRATE_LIMITEDINSUFFICIENT_BALANCEFEATURE_UNAVAILABLESTORE_PLAN_REQUIREDSTORE_SLOT_LIMITSTORE_TOP_UP_REQUIREDSTORE_CHANGE_IN_PROGRESSAPPROVAL_EXPIREDUPGRADE_REQUIREDLEGACY_PLANTRYOUT_LIMIT_REACHEDFREE_ALLOWANCE_UNAVAILABLEUPSTREAM_UNAVAILABLEUPSTREAM_FAILEDTIMED_OUT
GenerateDecor6

Paid: paint one decoration on transparency (§6).

action可选string
可选值: GENERATE_DECOR
默认: "GENERATE_DECOR"
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
可选值: GENERATE_FROM_PLAN
默认: "GENERATE_FROM_PLAN"
planId必填string
rowIds可选string[] | null
GenerateScene7

Paid: generate a BACKGROUND under the product layer, or across the whole canvas, from a prompt.

action可选string
可选值: GENERATE_SCENE
默认: "GENERATE_SCENE"
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
默认: "GEOMETRY"
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.

可选值: OWNERAPP
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
默认: 1
blendMode可选BlendMode
默认: "NORMAL"
visible可选boolean
默认: true
locked可选boolean
默认: false
kind可选string
可选值: GROUP
默认: "GROUP"
children必填ImageLayer[] | TextLayer[] | ShapeLayer[] | GroupLayer[]
GroupLayers5

Wrap sibling layers into a new group (caller-minted id); its box is derived from them.

action可选string
可选值: GROUP_LAYERS
默认: "GROUP_LAYERS"
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.

可选值: NOT_HTTPSBLOCKED_ADDRESSTOO_MANY_REDIRECTSBAD_STATUSCONTENT_TYPE_NOT_ALLOWEDTOO_LARGETIMEOUT
HeadingBlock3

One section heading (h2/h3); the post title is the h1 and is not a block.

kind可选string
可选值: HEADING
默认: "HEADING"
level必填integer
可选值: 23
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
默认: "IMAGE"
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
可选值: bodycallout_1callout_2callout_3headlineproduct_photo
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
默认: 1
blendMode可选BlendMode
默认: "NORMAL"
visible可选boolean
默认: true
locked可选boolean
默认: false
box必填Box
shadow可选DropShadow | null
kind可选string
可选值: IMAGE
默认: "IMAGE"
role必填ImageRole
asset必填AssetRef
mask可选AssetRef | null
flipX可选boolean
默认: false
flipY可选boolean
默认: false
crop可选Box | null
ImageMediaType可选值 · 3

Accepted and produced image encodings.

可选值: image/pngimage/jpegimage/webp
ImageOperation可选值 · 3

The paid image-model operations; each is one OperationSpec in library.OPERATIONS.

可选值: CUT_OUTSCENEDECOR
ImageRole可选值 · 4

What an image layer shows; the fidelity law and the slot checks read it.

可选值: PRODUCTBACKGROUNDDECORATIONLOGO
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
默认: 20
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.

可选值: TOO_SMALL
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.

可选值: NOT_AN_IMAGETOO_LARGE
IssueKind可选值 · 7

Why a provider refused or failed one call, in the terms the service acts on.

可选值: AUTH_INVALIDPERMISSION_MISSINGACCOUNT_UNAVAILABLERATE_LIMITEDPROVIDER_UNAVAILABLEREQUEST_REJECTEDNOT_FOUND
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
默认: "NORMAL"
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
可选值: items_detail_value
默认: "items_detail_value"
kind可选string
可选值: ITEMS
默认: "ITEMS"
key必填string
items可选object[]
默认: []
ItemsRow2

A detail row listing the cell's sample items with the named facts.

kind可选string
可选值: ITEMS
默认: "ITEMS"
facts必填string[]
JsonValue0

没有字段。

JudgmentAdjustment4

Rewrite the conclusion text of the head revision; numbers untouched, 0 model calls.

adjustmentType可选string
可选值: JUDGMENT
默认: "JUDGMENT"
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
可选值: JUDGMENT
默认: "JUDGMENT"
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.

可选值: QUESTIONFEATURE
KebleSectionKind可选值 · 5

The v1 Keble section library; every member has exactly one SectionSpec (totality test).

可选值: HERO_BANNERRICH_TEXTIMAGE_WITH_TEXTFAQFEATURE_LIST
Keyword11

Represent a market-scoped source term without embedding product relations.

kind可选string
可选值: KEYWORD
默认: "KEYWORD"
channel必填Channel
externalId必填string
text必填string
keywordType可选KeywordType
默认: "SEARCH_TERM"
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.

可选值: SEARCH_TERMHASHTAGTAG
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
KitColor4

One named kit colour.

entryId必填string
name必填string
color必填Color
replacedBy可选string | null
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
可选值: intermontserratnoto_sans_scnoto_serif_scplayfair_display
Language可选值 · 22
可选值: ENGLISHSIMPLIFIED_CHINESEGERMANFRENCHITALIANSPANISHDUTCHPORTUGUESEJAPANESETURKISHPOLISHSWEDISHARABICHINDITHAIKOREANVIETNAMESEINDONESIANHEBREWNORWEGIANDANISHFINNISH
LastCombine1

Range value = the value of the last day that has one.

kind可选string
Range combination: last day with a value.
可选值: last
默认: "last"
LayerClippedRule1

No visible layer extends past the canvas edge (advisory).

kind可选string
可选值: LAYER_CLIPPED
默认: "LAYER_CLIPPED"
LayerField可选值 · 19

One editable field of a layer or of the canvas.

可选值: BOXTEXTCOLORFONTFONT_SIZEFONT_WEIGHTALIGNLINE_HEIGHTLETTER_SPACINGFILLSTROKEGEOMETRYSHADOWOPACITYBLENDVISIBLEFLIPCROPBACKGROUND
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.

可选值: NOT_EDITABLEEDITABLEPRIVATE_WRITE_ONLY
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
可选值: LETTER_SPACING
默认: "LETTER_SPACING"
letterSpacing必填number
LineGeometry2

A line across the box diagonal or midline (callout leader lines).

kind可选string
可选值: LINE
默认: "LINE"
diagonal可选boolean
默认: false
LineHeightField2

Override value: a text layer's line height.

field可选string
可选值: LINE_HEIGHT
默认: "LINE_HEIGHT"
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
可选值: LINEAR
默认: "LINEAR"
angle可选number
默认: 90
ListBlock3

One bulleted or numbered list; items use the paragraph's inline subset.

kind可选string
可选值: LIST
默认: "LIST"
ordered必填boolean
items必填string[]
ListingCapture1

A dataset read as the full current list on every run.

kind可选string
Capture style: full current list.
可选值: listing
默认: "listing"
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.

可选值: NOT_FILEDAWAITING_APPROVALREJECTEDUNKNOWNNOT_YET_LISTEDLISTEDREVERT_PENDINGREMOVED
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.

可选值: ACTIVEUNPUBLISHEDREMOVEDUNKNOWN
ListingTarget3

The ELTA store, its selected marketplace account and the product type of one draft.

storeId必填string
marketplaceId必填string
productType必填string
LlmProductDiversity可选值 · 4
可选值: STANDARDIZED_WITH_STRICT_PROTOCOLSFUNCTION_PRIORITIZED_OVER_DESIGN_AND_DESIGN_DOES_NOT_AFFECT_PURCHASE_DECISIONFUNCTION_PRIORITIZED_OVER_DESIGN_BUT_DESIGN_AFFECT_PURCHASE_DECISIONDESIGN_IMPORTANCE_TO_CONSUMERS
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.
可选值: lookup_page
默认: "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.
默认: {"limit":200}
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
可选值: ESTIMATE
默认: "ESTIMATE"
questionKey必填string
Question settled by system estimation.
MaterialFactResolution3

One seller-fact choice for one committed material question.

choiceType可选string
可选值: RESOLUTION
默认: "RESOLUTION"
questionKey必填string
Answered question identity.
resolution必填ReportMaterialResolution
Typed seller facts.
MaterialFactsAnswer2

Settle offered material keys in one non-empty, typed request.

decisionType可选string
可选值: MATERIAL_FACTS
默认: "MATERIAL_FACTS"
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.

可选值: PROVISIONALFINAL
MaxLongestSideRule2

The longest side is at most pixels (Shopify 5000, Amazon 10000).

kind可选string
可选值: MAX_LONGEST_SIDE
默认: "MAX_LONGEST_SIDE"
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.
可选值: measure
默认: "measure"
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
可选值: measure_detail_value
默认: "measure_detail_value"
kind可选string
可选值: MEASURE
默认: "MEASURE"
key必填string
measure可选MeasureValue | null
MeasureFormat可选值 · 4

How the frontend prints a measure value.

可选值: INTEGERDECIMALMONEYPERCENT
MeasureRow2

A detail row showing one measure's value.

kind可选string
可选值: MEASURE
默认: "MEASURE"
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
可选值: MEASURED
默认: "MEASURED"
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.

可选值: IMAGEVIDEO
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
默认: "METRIC"
metric必填MetricKind
op必填string
可选值: GTELTE
value必填integer | number | MinorUnitMoney
MetricCoverage可选值 · 5

Describe whether a metric is a point, interval, cumulative, or board fact.

可选值: POINTINTERVALCUMULATIVEBOARDUNKNOWN
MetricGap可选值 · 7

Why a range value is missing or qualified.

可选值: NOT_CAPTUREDSOURCE_BLOCKEDINCOMPLETENOT_MEASURABLEMIXED_CURRENCYMIXED_TIMEZONERECALCULATING
MetricKind可选值 · 46

Name entity and product-keyword measurements with stable units and periods.

可选值: sales_quantitygmvorder_countratingreview_countrankvideo_countfollower_countcreator_countview_countlike_countcomment_countshare_countsave_countscoreupvote_ratiofollowing_countpost_countreply_countproduct_countestimated_visitspricelist_priceoffer_countorganic_traffic_scoreadvertising_traffic_scoretotal_traffic_scoreorganic_search_term_countadvertising_search_term_countsearch_volumecompetitive_difficultyorganic_rotation_rateclick_conversion_ratecost_per_clicksearch_frequency_rankorganic_trafficadvertising_traffictotal_trafficorganic_traffic_acquisition_rateadvertising_traffic_acquisition_ratetotal_traffic_acquisition_ratetraffic_ratioclick_shareconversion_sharekeyword_intersectionsavg_search_position
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
默认: "UNKNOWN"
estimationStatus可选EstimationStatus
默认: "UNKNOWN"
confidence可选number | null
origin可选ObservationOrigin
默认: "CAPTURED"
change可选boolean
默认: false
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.
可选值: metric_page
默认: "metric_page"
MetricPeriod可选值 · 6

Name the temporal coverage of a metric observation.

可选值: CURRENTD7D30LIFETIMEWEEKMONTH
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.

可选值: COUNTMONEYRATIORATINGSCOREDURATION_MS
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.
默认: {"limit":200}
MinLongestSideRule2

The longest side is at least pixels (Amazon: 1000 enables zoom).

kind可选string
可选值: MIN_LONGEST_SIDE
默认: "MIN_LONGEST_SIDE"
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
默认: "ENGLISH"
status必填MonitorStatus
pauseReason可选MonitorPauseReason | null
specRevision必填integer
watches可选MonitorWatch[]
默认: []
cadence可选MonitorCadence | null
delivery可选MonitorDelivery
默认: {"chat":true,"email":false}
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
可选值: CONFIRM
默认: "CONFIRM"
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
默认: true
email可选boolean
默认: false
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
可选值: SETUP
默认: "SETUP"
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.

可选值: SETTING_UPAWAITING_CONFIRMACTIVEPAUSEDSTOPPED
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
可选值: ftm
perCubicStorageFee必填number
storageFee必填number
Motif11

ONE MOTIF NODE — a group of elements several creators independently did.

kind可选string
Node discriminator; always MOTIF.
可选值: MOTIF
默认: "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.

可选值: SPREADINGEARLY
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
可选值: MOVE_BLOCK
默认: "MOVE_BLOCK"
sectionKey必填string
blockKey必填string
after可选string | null
MoveSection3

Move one section within its page to after another entry (None: to the end).

action可选string
可选值: MOVE_SECTION
默认: "MOVE_SECTION"
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
可选值: NO_BADGE_CLAIMS
默认: "NO_BADGE_CLAIMS"
NoEdgeCropRule2

At most max_hidden_ratio of the product's content box is hidden by the canvas edge or a crop.

kind可选string
可选值: NO_EDGE_CROP
默认: "NO_EDGE_CROP"
maxHiddenRatio必填number
NoGraphicsRule1

Only product image layers over the background: no shapes, logos or decorations (Amazon main).

kind可选string
可选值: NO_GRAPHICS
默认: "NO_GRAPHICS"
NoTextRule1

The design has no visible text layer (Amazon main image: no text or pricing).

kind可选string
可选值: NO_TEXT
默认: "NO_TEXT"
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.
默认: false
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.

可选值: PRODUCTSTORECREATORCONTENTKEYWORDCONTACTPLATFORM_DEFINED_CATEGORYBRANDPRODUCT_FAMILYMOTIFCONCEPT
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
可选值: NOTIFICATION
默认: "NOTIFICATION"
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
可选值: NOTIFICATION
默认: "NOTIFICATION"
object可选string
可选值: notification_item
默认: "notification_item"
creation必填NotificationCreate
ObjectKind可选值 · 7

Name the seven source entity kinds returned by Data Infra.

可选值: PRODUCTSTORECREATORCONTENTKEYWORDCONTACTPLATFORM_DEFINED_CATEGORY
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.

可选值: GENERATINGQUEUEDBROKENFAILEDSTALELOCKEDREADY
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.

可选值: SOURCE_REPORTEDCAPTURED
OpacityField2

Override value: a layer's opacity.

field可选string
可选值: OPACITY
默认: "OPACITY"
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
默认: false
OrderDesigns3

Move one object in the board order (z-order and LAYERS tree): directly above above, or to the bottom.

action可选string
可选值: ORDER_DESIGNS
默认: "ORDER_DESIGNS"
objectId必填string
above必填string | null
OrderLayer4

Move one layer in the stack: directly above above, or to the bottom when None.

action可选string
可选值: ORDER_LAYER
默认: "ORDER_LAYER"
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.

可选值: USERORG
OwnerRef2

One user or organization list selected by the authenticated host.

kind必填OwnerKind
id必填string
OwnerType可选值 · 3
可选值: USERORGROOT
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.
默认: 200
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.

可选值: RESERVEDQUEUEDRUNNINGSUCCEEDEDAPPLIEDSKIPPEDFAILEDUNKNOWNCANCELLED
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
默认: false
ParagraphBlock2

One paragraph of plain text with inline **strong**, *em* and [label](https://...).

kind可选string
可选值: PARAGRAPH
默认: "PARAGRAPH"
text必填string
PathGeometry2

A library outline filling the box, stretched/rotated by it; no free-form path data.

kind可选string
可选值: PATH
默认: "PATH"
path必填PathKey
PathKey可选值 · 20

One immutable curated outline from the keble-core 1000-unit square path library.

可选值: SEAL_SCALLOPRIBBON_BANNERSPEECH_BUBBLEPRICE_TAGTORN_BANDBRUSH_BANDBRUSH_SWIRLBRUSH_STROKEBRUSH_UNDERLINESPLASHBLOB_SOFTBLOB_WAVEWAVE_EDGEFLAMELEAFDROPHEARTCHECKARROWSPARKLE
PeerIntent可选值 · 2

What a same-kind search means when it asks for peers.

可选值: COMPETITORSLOOKALIKES
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.

可选值: SCOPEITEMSDIMENSIONSANALYSIS
PhaseStatus可选值 · 4

WAITING_FOR_USER is distinct from WORKING: busy is not idle (existing ruling).

可选值: WORKINGWAITING_FOR_USERCOMPLETEFAILED
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).

可选值: UNREACHABLE
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
可选值: UPLOADREFERENCE
默认: "UPLOAD"
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
可选值: PLACE_BRAND_KIT
默认: "PLACE_BRAND_KIT"
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
默认: "PLACEHOLDER"
placeholder必填string
可选值: bodycallout_1callout_2callout_3headlineproduct_photo
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
可选值: PLATFORM_DEFINED_CATEGORY
默认: "PLATFORM_DEFINED_CATEGORY"
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
可选值: POLYGON
默认: "POLYGON"
corners必填integer
innerRatio可选number
默认: 1
PositioningCellQuery3

Ask for one cell's detail dialog, the reading client's cell read.

object可选string
可选值: positioning_cell
默认: "positioning_cell"
cellKey必填string
viewId可选string | null
PositioningDetail3

One answered detail query: the reading client's answer plus the labels it uses.

object可选string
可选值: positioning_detail
默认: "positioning_detail"
answer必填CellDetail | PositioningItemPage
labels必填PositioningDetailLabels
PositioningDetailLabels7

The labels one detail answer needs to be read by a person, and nothing more.

object可选string
可选值: positioning_detail_labels
默认: "positioning_detail_labels"
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
可选值: positioning_items
默认: "positioning_items"
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.
默认: "ENGLISH"
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
可选值: POST_DRAFTS
默认: "POST_DRAFTS"
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
可选值: POST_PLAN
默认: "POST_PLAN"
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
可选值: SELF_REVIEW
默认: "SELF_REVIEW"
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
默认: 0
PostSetStatus可选值 · 2

Where the post set stands.

可选值: WAITING_FOR_AGENTREADY
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
可选值: PRICE
默认: "PRICE"
op必填string
可选值: GTELTE
value必填MinorUnitMoney
metric可选string
可选值: pricelist_price
默认: "price"
averageDays可选integer | null
Priority可选值 · 2

The initial human-attention levels.

可选值: NORMALCRITICAL
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
可选值: PRODUCT
默认: "PRODUCT"
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
默认: "ACTIVE"
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.
可选值: PRODUCT_FAMILY
默认: "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
可选值: PRODUCT_FILL
默认: "PRODUCT_FILL"
minRatio必填number
ProductImagesDetailView可选值 · 1

What may be read in detail about one image set.

可选值: EXPORTS
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
可选值: UNIDENTIFIABLEOLD_RELEASEDNEW_RELEASEDNEW_RELEASED_ON_OLD_ASIN
ProductSimilarType可选值 · 4
可选值: SAME_MODELSAME_PRODUCT_SUBCATEGORYSAME_PRODUCT_CATEGORY_BUT_DIFFERENT_SUBCATEGORYDIFFERENT_PRODUCT_CATEGORY
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
可选值: PROFILE_INPUTS
默认: "PROFILE_INPUTS"
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
可选值: PROFIT_INPUTS
默认: "PROFIT_INPUTS"
overrides必填ProfitInputOverride[]
One override group per target ASIN set.
ProfitLineKind可选值 · 8

One deductible economic line between selling price and unit profit.

可选值: PURCHASING_COSTFIRST_LEG_SHIPPINGFBA_FULFILLMENTSTORAGEREFERRALVATADSRETURNS
ProgressTaskStage可选值 · 3
可选值: PENDINGSUCCESSFAILURE
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.
可选值: 3.0.0
默认: "3.0.0"
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.
默认: false
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.

可选值: PROPOSEDAPPLYINGAPPLIEDEXPIREDDECLINED
ProposalTarget可选值 · 2

What a model proposal is asked for.

可选值: SCOPEDIMENSIONS
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
可选值: PROPOSE
默认: "PROPOSE"
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
默认: false
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).

可选值: INVALID_INPUTINVALID_OUTPUTCONTENT_REFUSEDRATE_LIMITEDUNAVAILABLEOUTCOME_UNKNOWNNOT_CONFIGURED
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.
可选值: provider_issue
默认: "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.

可选值: NAEUFE
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.
可选值: query_page
默认: "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.
默认: {"limit":200}
QueryRow0

没有字段。

QueryStage0

没有字段。

QueryTarget以下之一 · 2
以下之一: string | string
QuoteBlock2

One pull quote or customer quote the merchant supplied.

kind可选string
可选值: QUOTE
默认: "QUOTE"
text必填string
RadialGradient2

A fill from the box centre to its farthest corner for a vignette or spotlight.

stops必填GradientStop[]
gradient可选string
可选值: RADIAL
默认: "RADIAL"
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.

可选值: DAYWEEKMONTH
RatioCombine3

Range value = sum(numerator) / sum(denominator) over the same days and entity.

kind可选string
Range combination: ratio of summed operands.
可选值: ratio
默认: "ratio"
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.
可选值: record_detail
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
可选值: RECT
默认: "RECT"
cornerRadius可选number
默认: 0
RedeemCodeRefusalReason可选值 · 10

Finite refusal facts for code updates, redemption and trial application.

可选值: INVALID_CODELEGACY_TOKENDISABLEDUPDATE_LOCKEDMAX_CONSUMEACTOR_LIMITIDENTITY_CONFLICTRELEASEDGRANT_CHANGEDTRIAL_NOT_ELIGIBLE
ReferencesDetailValue4

A REFERENCES detail row: the cell's deduplicated source references.

object可选string
可选值: references_detail_value
默认: "references_detail_value"
kind可选string
可选值: REFERENCES
默认: "REFERENCES"
key必填string
references可选SourceReference[]
默认: []
ReferencesRow1

Every source reference of the cell's assessments and items, deduplicated.

kind可选string
可选值: REFERENCES
默认: "REFERENCES"
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.

可选值: EDGE_MISSINGEDGE_DISABLEDGROW_KIND_MISMATCHANALYZED_BELOW_LIVEDERIVED_KIND_NEEDS_ANALYZEDWINDOW_CATEGORY_REQUIREDMOTIF_PRESET_INVALIDEXCLUDE_KIND_MISMATCHTEXT_FROM_UNSUPPORTEDPUBLISHED_TARGET_IDS_SETBOUND_OUT_OF_RANGEPLAN_TOO_LARGEUNBUILDABLE_QUERYPUBLISHED_PRESET_SETWINDOW_BEFORE_POLICYCHANNEL_REQUIREDLEG_UNAVAILABLEINVALID_REFERENCESOURCE_REJECTED_REQUESTUNSUPPORTED_QUESTIONVALIDATION_EXHAUSTEDDATA_CHANGEDINVALID_CURSORNOT_AVAILABLE
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
relation必填AnalyzedRelationKind
direction必填string
可选值: OUTIN
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.
可选值: OUTIN
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
可选值: target_bid_adjustment
默认: "target_bid_adjustment"
percentChange必填number | string
RemoveBlock3

Remove one block from a section.

action可选string
可选值: REMOVE_BLOCK
默认: "REMOVE_BLOCK"
sectionKey必填string
blockKey必填string
RemoveDesign2

Remove any board object; HAS_VARIANTS while a variant or plan still names it.

action可选string
可选值: REMOVE_DESIGN
默认: "REMOVE_DESIGN"
designId必填string
RemoveItems3

Delete items; their placements go with them (a placement of a missing item reads as nothing).

type可选string
可选值: REMOVE_ITEMS
默认: "REMOVE_ITEMS"
actionKey必填string
keys必填string[]
RemoveLayers3

Remove layers (and a group's children with it).

action可选string
可选值: REMOVE_LAYERS
默认: "REMOVE_LAYERS"
designId必填string
layerIds必填string[]
RemoveScope可选值 · 2

The targets a REMOVE action is declared to be allowed to delete.

可选值: ELTA_CREATEDANY_WITH_SNAPSHOT
RemoveSection2

Remove one section from the document; publish then removes its placement.

action可选string
可选值: REMOVE_SECTION
默认: "REMOVE_SECTION"
sectionKey必填string
RenderFormat可选值 · 3

Export encodings the stores accept and we produce (WEBP: agent previews and owner downloads).

可选值: JPEGPNGWEBP
ReorderViews5

Put the viewer's saved views in a new order (every existing view id, once).

type可选string
可选值: REORDER_VIEWS
默认: "REORDER_VIEWS"
actionKey必填string
viewer必填ViewerRef
expectedRevision必填integer
viewIds必填string[]
ReplacePost3

Replace one post's composed content.

edit可选string
可选值: REPLACE_POST
默认: "REPLACE_POST"
postKey必填string
post必填ComposedPost
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.
默认: false
ReportAdjudicationCandidate可选值 · 4

The closed set of outcomes an adjudicator may choose.

可选值: CONTINUECONCLUDE_SUITABLECONCLUDE_NOT_SUITABLECONCLUDE_NOT_DETERMINABLE
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.

可选值: RISKOPPORTUNITYADJUDICATOR
ReportClosureKind可选值 · 2

Whether the report closed before or after every required phase ran.

可选值: EARLYFINAL
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.

可选值: NEWOLDUNKNOWN
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.

可选值: ALLNEW_BRANDSOLD_BRANDS
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.

可选值: BELOW_MINUS_10MINUS_10_TO_0ZERO_TO_10TEN_TO_20TWENTY_TO_30THIRTY_TO_40FORTY_PLUSOTHER
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.
默认: false
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.
默认: false
ReportCohortRankTableKey可选值 · 4

Which profit ranking one rank table is.

可选值: PROFITABLE_ALLNOT_PROFITABLE_ALLPROFITABLE_NEWNOT_PROFITABLE_NEW
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.

可选值: NOT_BUILT_YETWAITING_FOR_INPUTFAILEDNOT_SUPPORTED_BY_FORMAT
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.
默认: false
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.
默认: false
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.

可选值: CONCLUSIONLISTINGSLIFECYCLEESTIMATIONECONOMICSGAPS
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.

可选值: PROCESSINGWAITING_FOR_INPUTPARTIAL_CONCLUDEDFULLCANCELLEDFAILED_PARTIAL
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.

可选值: REPEATED_USER_PAININNOVATION_ADDRESSES_PAIN
ReportDecisionType可选值 · 5

One question the report may park on for a typed agent answer.

可选值: REPORT_SCOPESAMPLE_RELEVANCEMATERIAL_FACTSSTANDOUT_SELECTIONJUDGMENT
ReportEstimateConfidence可选值 · 4

Confidence attached to one member's effective material range.

可选值: HIGHMEDIUMLOWUNRESOLVED
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
可选值: report_evidence
默认: "report_evidence"
topic必填string
可选值: CONCLUSIONLIFECYCLEESTIMATION
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.

可选值: WEAKMODERATESTRONG
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.

可选值: MEMBER_RELEASEPARENT_RELATIONABSENT
ReportFinalOverviewSectionView6

The closing headline and summary of a fully built report.

created可选string
updated可选string
kind可选string
可选值: FINAL_OVERVIEW
默认: "FINAL_OVERVIEW"
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.
默认: false
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.

可选值: PENDINGWAITING_FOR_INPUTSKIPPEDFAILEDCONTINUABLE
ReportJudgmentAnswer4

The create-time conclusion for one revision (07a §2.1).

decisionType可选string
可选值: JUDGMENT
默认: "JUDGMENT"
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
可选值: report_judgment
默认: "report_judgment"
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.

可选值: CENTIMETREINCH
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.

可选值: WITHIN_WINDOWBEYOND_WINDOW_CORROBORATEDBEYOND_WINDOW_UNCORROBORATEDENTRY_UNKNOWN
ReportListingCohortSectionView18

The competitor cohort of ONE revision, ready for the old-report layout.

created可选string
updated可选string
kind可选string
可选值: LISTING_BUILD
默认: "LISTING_BUILD"
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.

可选值: LOADEDPLACEHOLDER
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.

可选值: SUCCESSNEW_RELEASE_FAILEDNOT_DETERMINABLE
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
可选值: report_listing
默认: "report_listing"
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.
默认: false
ReportListingsQuery2

Ask for one cursor page of the report's comparable listings.

object可选string
可选值: report_listings
默认: "report_listings"
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
可选值: MARKET_SUCCESS_INVESTMENT
默认: "MARKET_SUCCESS_INVESTMENT"
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.

可选值: GRAMKILOGRAM
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.

可选值: LENGTHWIDTHHEIGHTWEIGHTUNIT_COST
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.
默认: "CENTIMETRE"
massUnit可选ReportMassUnit
Unit a weight answer must be given in.
默认: "GRAM"
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.

可选值: SERVER_SUGGESTIONOWNER_ENTERED
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.
默认: false
ReportNarrativeSectionKind可选值 · 5

The FIVE old-page interpretation slots the report's prose fills (07a §2.3).

可选值: INVESTMENT_BUDGETINVESTMENT_BRANDSPROFIT_RATIOSMARKET_NEW_PRODUCTSMARKET_ENTRY_TIMING
ReportNarrativeSectionView4

The rendered prose sections in display order.

created可选string
updated可选string
kind可选string
可选值: NARRATIVE
默认: "NARRATIVE"
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.
默认: false
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
可选值: report_overview
默认: "report_overview"
ReportPhase可选值 · 14

The ordered phases a V3 report walks; each produces exactly one artifact.

可选值: INPUT_FREEZESOURCE_LOADSAMPLE_RELEVANCELISTING_BUILDSIMILARITY_COVERAGEMATERIAL_TRIAGEENTRY_LIFECYCLEREVIEW_COMPETITIONLISTING_ECONOMICSMARKET_SUCCESS_INVESTMENTSTANDOUTDECISION_CHECKPOINTNARRATIVEFINAL_OVERVIEW
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.

可选值: USER_SUPPLIEDCOHORT_INFERRED
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.

可选值: SCENARIO_BOUNDCOHORT_BENCHMARK
ReportRateAbsenceReason可选值 · 2

Why a cohort rate is a typed absence rather than a percentage.

可选值: NO_ELIGIBLE_LISTINGNO_DETERMINATE_LISTING
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.

可选值: INSUFFICIENT_SIMILAR_LISTINGSMATERIAL_INPUT_UNRESOLVEDNO_QUALIFYING_LAUNCH_EVIDENCEEVIDENCE_CONFLICTSUSTAINED_UNPROFITABLE_MARKETNEW_RELEASE_FAILEDCOMPETITION_OR_INVESTMENT_UNSUITABLE
ReportRepresentativeQuality可选值 · 2

Whether the representative was chosen from a real sales signal.

可选值: KNOWNUNKNOWN
ReportRetryEligibility可选值 · 3

Whether a terminated run may be retried, and by whom.

可选值: RETRYABLERETRYABLE_AFTER_INPUT_CHANGENOT_RETRYABLE
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.
默认: false
ReportScopeAnswer3

Store a category and the exact keyword text supplied for a report scope.

decisionType可选string
可选值: REPORT_SCOPE
默认: "REPORT_SCOPE"
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.

可选值: LISTING_BUILDMARKET_SUCCESS_INVESTMENTNARRATIVEFINAL_OVERVIEW
ReportSectionQuery2

Ask for one written section (market numbers, narrative, final overview).

object可选string
可选值: report_section
默认: "report_section"
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.

可选值: CANCELLEDFAILED_PARTIAL
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
可选值: report_v3_conclusion
默认: "report_v3_conclusion"
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
可选值: report_v3_estimation
默认: "report_v3_estimation"
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
可选值: report_v3_judgment
默认: "report_v3_judgment"
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
可选值: report_v3_lifecycle
默认: "report_v3_lifecycle"
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
可选值: report_v3_listing_detail
默认: "report_v3_listing_detail"
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
可选值: report_v3_listings
默认: "report_v3_listings"
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
可选值: report_v3_overview
默认: "report_v3_overview"
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
可选值: report_v3_section
默认: "report_v3_section"
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.

可选值: SUITABLENOT_SUITABLENOT_DETERMINABLE
ReportVersion可选值 · 2

Persisted report FORMAT identity, read from storage and never inferred.

可选值: 2.0.03.0.0
ResizeDesign5

Move an OWN image to another preset (e.g. secondary 2000x2000 -> A+ header 970x600).

action可选string
可选值: RESIZE_DESIGN
默认: "RESIZE_DESIGN"
designId必填string
preset必填string
可选值: amazon.aplus.banneramazon.aplus.comparisonamazon.aplus.four_imageamazon.aplus.headeramazon.aplus.logoamazon.aplus.quadrantamazon.aplus.singleamazon.aplus_premium.full_widthamazon.brand_story.backgroundamazon.brand_story.cardamazon.mainamazon.secondarycustomshopify.blog_featuredshopify.collectionshopify.product
size可选PixelSize | null
mode必填ResizeMode
ResizeMode可选值 · 2

How layers follow a canvas resize (the Magic-Resize choice; also a variant recipe's fit).

可选值: SCALE_TO_FITREFLOW
Resolution可选值 · 5

Who resolves an issue, derived from its kind and permission.

可选值: RECONNECTFIX_AT_PROVIDERWAITSUPPORTCHECK_REQUEST
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
可选值: RESTORE_ROW
默认: "RESTORE_ROW"
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.

可选值: EXACTBEST_EFFORTNONE
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.

可选值: PROVIDERLOCAL
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
可选值: room_assessment
默认: "room_assessment"
key必填string
label必填LocalizedText
kind必填AssessmentKind
ranges可选AssessmentRange[]
默认: []
RoomPublicDecisionOffer4

Whether a decision run can start, without the internal decision-input size.

object可选string
可选值: room_decision_offer
默认: "room_decision_offer"
eligible必填boolean
refusal可选DecisionRefusal | null
offeredCells可选integer
默认: 0
RoomPublicDecisionRead5

The decision read a customer sees, with request_chars dropped.

object可选string
可选值: room_decision
默认: "room_decision"
scorecard可选RoomPublicScorecard | null
decision可选DecisionRecord | null
offer必填RoomPublicDecisionOffer
scoredCells可选RoomCell[]
默认: []
RoomPublicDeclaration13

One plugin declaration as a customer room renders it.

object可选string
可选值: room_declaration
默认: "room_declaration"
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
可选值: room_dimensions
默认: "room_dimensions"
computed可选BandedDimension[]
默认: []
RoomPublicMeasure4

One declared measure as a customer sees it, without its computation rule.

object可选string
可选值: room_measure
默认: "room_measure"
key必填string
label必填LocalizedText
format必填MeasureFormat
RoomPublicPositioning10

The customer-visible half of one positioning record.

object可选string
可选值: room_positioning
默认: "room_positioning"
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
可选值: room
默认: "room"
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
可选值: room_scorecard
默认: "room_scorecard"
profile必填string
cells必填CellScore[]
excluded可选string[]
默认: []
threshold可选integer
默认: 60
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.

可选值: IN_FLIGHT_CALLWAIT_EXPIREDSETUP_INVALIDSTEP_ATTEMPTS_EXHAUSTED
RunOutcome可选值 · 3

The execution outcome of a run. The host owns settlement.

可选值: SUCCEEDEDFAILEDABANDONED
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.

可选值: SCOPESOURCEDIMENSIONSPLACEASSESSSCORE
SampleConfirmation5

SAMPLE_CONFIRMATION (1.6): the sample shown, the seller's verdict, and what to change.

step可选string
可选值: SAMPLE_CONFIRMATION
默认: "SAMPLE_CONFIRMATION"
shownPostKeys必填string[]
verdict必填SampleVerdict
feedback可选string | null
revisePostKeys可选string[]
默认: []
SampleRelevanceAnswer2

A fragment of the delegated sample-relevance decision.

decisionType可选string
可选值: SAMPLE_RELEVANCE
默认: "SAMPLE_RELEVANCE"
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).

可选值: APPROVEDREVISE
SaveCriterion3

Create or replace one criterion; its results are judged only when asked (ASSESS).

type可选string
可选值: SAVE_CRITERION
默认: "SAVE_CRITERION"
actionKey必填string
criterion必填CriterionRecord
SaveDimension3

Create or replace one dimension with its ordered options (rename, reorder, drop in one save).

type可选string
可选值: SAVE_DIMENSION
默认: "SAVE_DIMENSION"
actionKey必填string
dimension必填DimensionRecord
SaveView5

Create or replace one saved view in the viewer's own viewport.

type可选string
可选值: SAVE_VIEW
默认: "SAVE_VIEW"
actionKey必填string
viewer必填ViewerRef
expectedRevision必填integer
view必填ViewDefinition
ScenarioRole可选值 · 4

Role of one coherent economic scenario inside a profit envelope.

可选值: ROBUSTEXPECTEDPOSSIBLETIER_PROBE
SceneCueBinding1

A plan column whose non-empty cell queues one paid GenerateScene(replaces=…) on that row's image.

binding可选string
可选值: SCENE_CUE
默认: "SCENE_CUE"
Score2

Recompute the scorecard from the cells as they are now (after edits, if the caller wants).

type可选string
可选值: SCORE
默认: "SCORE"
actionKey必填string
ScreeningEnforcement可选值 · 2

Whether a cited screening finding blocks proposing or is shown as guidance.

可选值: BLOCKHINT
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.

可选值: SENSITIVE_CATEGORYFORBIDDEN_TERMKNOWN_NON_OWNER_BRANDDISALLOWED_CHARACTER
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
SearchAnswer2

A public decoded single-subject answer.

object必填string
Public object discriminator.
可选值: answer
answer必填string
Decoded answer text for the caller.
SearchClarify4

A public clarification request.

object必填string
Public object discriminator.
可选值: clarify
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.
可选值: record
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.
默认: false
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.
默认: 20
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.
默认: false
object必填string
Public object discriminator.
可选值: search_page
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.
可选值: search_pending
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.

可选值: ORGANICSPONSORED_PRODUCTSAMAZON_CHOICESPONSORED_BRANDSSPONSORED_BRANDS_VIDEOOTHER_ORGANICOTHER_SPONSORED
SearchRefused6

A typed public refusal with honest, topic-free next steps.

object必填string
Public object discriminator.
可选值: refused
reason必填string
Stable public refusal reason.
可选值: UNSUPPORTED_QUESTIONDATA_CHANGEDINVALID_CURSORNOT_AVAILABLE
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.
默认: "EN"
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
可选值: idshandle_selectorsdomain_selectorsproduct_refscreator_refsstore_refskeyword_refscompetitor_refsparent_refsstore_domainstextcategorysort
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
可选值: SET_BACKGROUND
默认: "SET_BACKGROUND"
designId必填string
color必填Color | BrandColorRef
SetBoardTitle2

Rename the board through the same revisioned edit batch as every other change.

action可选string
可选值: SET_BOARD_TITLE
默认: "SET_BOARD_TITLE"
title必填string
SetBox4

Move, resize or rotate one layer; on a group, its children move and scale so their bounds become box.

action可选string
可选值: SET_BOX
默认: "SET_BOX"
designId必填string
layerId必填string
box必填Box
SetDailyBudgetValue2

The suggested daily budget of one Sponsored Products campaign.

kind可选string
可选值: daily_budget
默认: "daily_budget"
dailyBudget必填number | string
SetImageTransform6

Set an image layer's flips and crop together (all stated, like SetLayerFlags); free.

action可选string
可选值: SET_IMAGE_TRANSFORM
默认: "SET_IMAGE_TRANSFORM"
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
可选值: SET_LAYER_FLAGS
默认: "SET_LAYER_FLAGS"
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
可选值: SET_OBJECT_FRAME
默认: "SET_OBJECT_FRAME"
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
可选值: SET_OBJECT_LOCK
默认: "SET_OBJECT_LOCK"
objectId必填string
locked必填boolean
SetPlacements4

Put groups into options of one dimension by hand (None takes a group out).

type可选string
可选值: SET_PLACEMENTS
默认: "SET_PLACEMENTS"
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
可选值: SET_PLAN
默认: "SET_PLAN"
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
可选值: SET_RESULTS
默认: "SET_RESULTS"
actionKey必填string
assessment必填string
results必填object
SetReview3

Change who decides the named steps; takes effect at the next step that ends.

type可选string
可选值: SET_REVIEW
默认: "SET_REVIEW"
actionKey必填string
review必填object
SetSettings4

Set values on one section, or on one of its blocks when block_key is given.

action可选string
可选值: SET_SETTINGS
默认: "SET_SETTINGS"
sectionKey必填string
blockKey可选string | null
settings必填object
SetSetup3

Replace the named setup values (the SCOPE review's answer, or a later correction).

type可选string
可选值: SET_SETUP
默认: "SET_SETUP"
actionKey必填string
values必填object
SetShadow4

Set or clear the drop shadow of any leaf layer (image, text or shape).

action可选string
可选值: SET_SHADOW
默认: "SET_SHADOW"
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
可选值: SET_SHAPE_STYLE
默认: "SET_SHAPE_STYLE"
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
可选值: SET_TEXT
默认: "SET_TEXT"
designId必填string
layerId必填string
text必填string
SetTextStyle4

Replace a text layer's whole style (font, weight, size, colour, alignment).

action可选string
可选值: SET_TEXT_STYLE
默认: "SET_TEXT_STYLE"
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
可选值: SET_VARIANT_RECIPE
默认: "SET_VARIANT_RECIPE"
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
默认: true
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.

可选值: TEXTTEXT_LISTCHOICEMULTI_CHOICENUMBER
SetupOption2

One allowed value of a CHOICE field.

value必填string
label必填LocalizedText
ShadowField2

Override value: a leaf layer's drop shadow (None = no shadow).

field可选string
可选值: SHADOW
默认: "SHADOW"
shadow必填DropShadow | null
ShapeLayer12

Free vector composition: panels, bands, badges, outlines and icons.

layerId必填string
name必填string
opacity可选number
默认: 1
blendMode可选BlendMode
默认: "NORMAL"
visible可选boolean
默认: true
locked可选boolean
默认: false
box必填Box
shadow可选DropShadow | null
kind可选string
可选值: SHAPE
默认: "SHAPE"
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.

可选值: FREIGHTAIRRAIL
ShippingProfile5

Canonical shipping-rate inputs for legacy float weight formulas.

exchangeRates必填ExchangeRateInUsd[]
freightPerKg必填MinorUnitMoney
airPerKg必填MinorUnitMoney
railPerKg可选MinorUnitMoney | null
cubicCmBreakpoint可选integer
默认: 6000
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
可选值: inchcm
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
默认: false
omitted可选boolean
默认: false
originalLength可选integer | null
SocialTextTrackKind可选值 · 2

Distinguish transcript and caption text without provider-specific kinds.

可选值: TRANSCRIPTCAPTION
Sort5

Request ordering by one typed metric, or by one launch instant.

metric可选MetricKind | null
field可选string | null
direction可选string
可选值: DESCASC
默认: "DESC"
window可选RankingWindow | null
change可选boolean
默认: false
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.
默认: true
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.
默认: "LOCAL"
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.

可选值: SEARCH_TERMTAGHASHTAGTITLEBRANDNAMEHANDLECATEGORYCONCEPTMOTIF
SourceMode可选值 · 3

WHICH READ SOURCE one search step executes against.

可选值: LIVEANALYZEDANALYZED_THEN_LIVE
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
默认: false
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.
可选值: TRANSCRIPTCAPTION
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).

可选值: SOURCE_CHANGED
StandingAdjust2

MIRROR wire ArtifectStandingAdjust: pause, resume or run a standing artifect now.

adjustmentType可选string
可选值: STANDING
默认: "STANDING"
command必填StandingControl
StandingControl可选值 · 3

The core-owned standing commands (MIRROR wire ArtifectStandingAdjust.command).

可选值: PAUSERESUMERUN_NOW
StandingPauseBy可选值 · 3

Who paused a standing run (StandingFacts.paused_by); core sets it on every move to PAUSED.

可选值: CALLERGATEKIND
StandingState可选值 · 4

Where one standing artifect is (MIRROR wire ArtifectStandingState); core owns the moves.

可选值: SETTING_UPACTIVEPAUSEDSTOPPED
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
可选值: STANDOUT_SELECTION
默认: "STANDOUT_SELECTION"
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
可选值: ftm
perMonth必填MonthlyStorageFee[]
Store11

Represent a selling entity with a stable channel ID and alias fields.

kind可选string
可选值: STORE
默认: "STORE"
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.
可选值: store_capabilities
默认: "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).

可选值: DATA_INFRAPLATFORM
StoreRecord12

One owner's store spanning installed sources, with lifecycle state and stored rows.

object可选string
Document type: store record.
可选值: store_record
默认: "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.
默认: 0
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.
默认: false
StoreStatus可选值 · 2

Whether capture may run for the store; paused reads remain available.

可选值: ACTIVEPAUSED
StoresResponse2

The stores belonging to the asserted owner, including unfinished stores.

object可选string
Document type: stores response.
可选值: stores_response
默认: "stores_response"
stores必填StoreRecord[]
Stores belonging to the asserted owner.
Stroke2

An outline colour and width.

color必填Color | BrandColorRef
width必填number
StrokeField2

Override value: a shape layer's stroke (None = no stroke).

field可选string
可选值: STROKE
默认: "STROKE"
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
可选值: STYLE_EXAMPLES
默认: "STYLE_EXAMPLES"
examples必填StyleExample[]
SuggestedKeywordEvidence1

A term no server-read report row matched: a suggestion, explicitly not a measurement.

kind可选string
可选值: SUGGESTED
默认: "SUGGESTED"
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.
可选值: sum
默认: "sum"
TaskExceptionType可选值 · 7

Closed persisted task-failure classifications shared by maintained lines.

可选值: UNKNOWNPAID_ATTEMPT_UNKNOWNFAILED_TO_STARTNO_SUFFICIENT_DATATIMEOUTINPUT_EXPIREDCANCELLED
TaskStage可选值 · 5
可选值: PENDINGPROCESSINGWAITING_FOR_INPUTSUCCESSFAILURE
TextAlign可选值 · 3

Horizontal alignment inside the text box.

可选值: LEFTCENTERRIGHT
TextClause4

Search one named text field or request broad text discovery.

kind可选string
可选值: TEXT
默认: "TEXT"
field可选string | null
value必填string
op可选string
可选值: SEARCHPHRASE
默认: "SEARCH"
TextField2

Override value: a text layer's text.

field可选string
可选值: TEXT
默认: "TEXT"
text必填string
TextFill2

Fill a HEADLINE/BODY_TEXT placeholder.

placeholder必填string
可选值: bodycallout_1callout_2callout_3headlineproduct_photo
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
默认: 1
blendMode可选BlendMode
默认: "NORMAL"
visible可选boolean
默认: true
locked可选boolean
默认: false
box必填Box
shadow可选DropShadow | null
kind可选string
可选值: TEXT
默认: "TEXT"
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
可选值: TEXT_LAYER
默认: "TEXT_LAYER"
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.

可选值: CONTEXTINSERTDELETE
TextStyle7

How a text layer is set; font is a reference (stored as its key).

font必填string | BrandFontRef
weight可选FontWeight
默认: "REGULAR"
size必填number
color必填Color | BrandColorRef
align可选TextAlign
默认: "LEFT"
lineHeight可选number
默认: 1.2
letterSpacing可选number
默认: 0
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).

可选值: EDITUPDATE_PREVIEWPUBLISHDISCARD_PREVIEW
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
可选值: DOCUMENT
默认: "DOCUMENT"
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).

可选值: AGENTUSER
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).

可选值: PREVIEW_COPYTARGET
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
ThemeProposalPurpose可选值 · 5

Why one ELTA proposal was opened for a change set or a document revision.

可选值: PREVIEW_COPYPREVIEW_FILESACCEPTREVERTDISCARD
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
可选值: DOCUMENT
默认: "DOCUMENT"
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.

可选值: ARCHIVEDDEMODEVELOPMENTLOCKEDMAINUNPUBLISHED
ThemeRunHead15

The small owner-scoped head row of one document run; revisions live beside it.

runKind可选string
可选值: DOCUMENT
默认: "DOCUMENT"
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.

可选值: NEWEDITEDREMOVED
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.

可选值: DRAFTPREVIEWINGPREVIEW_READYPUBLISHINGPUBLISHED
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
默认: false
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
默认: false
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).

可选值: INDEXPRODUCTCOLLECTIONPAGEBLOGARTICLE
TimeAxis可选值 · 3

WHICH INSTANT a time window is measured on.

可选值: PUBLISHEDOBSERVEDLAUNCHED
TodoCreate3

Immutable original intent for an ordinary todo.

kind可选string
可选值: TODO
默认: "TODO"
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
可选值: TODO
默认: "TODO"
object可选string
可选值: todo_item
默认: "todo_item"
creation必填TodoCreate
status必填TodoStatus
resolved_by可选ActorRef | null
TodoStatus可选值 · 3

An ordinary item remains stored and readable after completion.

可选值: OPENDONEWITHDRAWN
Tone可选值 · 2

The tint of a cell's conclusion.

可选值: OPPORTUNITYCAUTION
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.
可选值: TOP_BY_METRIC
默认: "TOP_BY_METRIC"
nodeKind必填NodeKind
Node family to rank.
channel必填Channel
Channel of the ranked nodes.
metric必填string
Declared numeric field code of the selected cell.
可选值: review_countfollower_countview_count
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
可选值: UNGROUP_LAYER
默认: "UNGROUP_LAYER"
designId必填string
groupId必填string
Unit可选值 · 3

The physical unit of a measure or metric, so money, counts and ratios stay apart.

可选值: COUNTMONEYRATIO
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
可选值: UPDATE_ITEMS
默认: "UPDATE_ITEMS"
actionKey必填string
updates必填ItemUpdate[]
ValueBasis可选值 · 2

Where one stored field value came from (PLAN §2.1, owner 1700 #).

可选值: OBSERVEDINFERRED
ValueStatus可选值 · 3

Whether a value exists; missing is never zero (existing ruling).

可选值: AVAILABLEUNAVAILABLEMIXED_CURRENCY
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
默认: "REFLOW"
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).

可选值: USERAGENT
ViewerRef2

Who is looking: every viewer keeps their own views; the agent never overwrites the person's.

viewer必填string
handledBy可选ViewHandledBy
默认: "USER"
Viewport3

One viewer's ordered saved views of one positioning, guarded by a revision.

viewer必填ViewerRef
definitions必填ViewDefinition[]
revision可选integer
默认: 0
VisibleField2

Override value: a layer's visibility.

field可选string
可选值: VISIBLE
默认: "VISIBLE"
visible必填boolean
WhiteBackgroundRule1

Every pixel outside the product is pure white RGB 255,255,255 (Amazon main image).

kind可选string
可选值: WHITE_BACKGROUND
默认: "WHITE_BACKGROUND"
WindowCapture3

A dataset re-requested over its recent reporting days on every run.

kind可选string
Capture style: recent reporting-day window.
可选值: window
默认: "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.
默认: "ELTA_CREATED"
revertOnly可选boolean
Whether this action is valid only while reverting another action.
默认: false
quoted可选boolean
Whether provider estimates are retained on action outcomes.
默认: false
PluginDeclarationCatalog4

Every installed plugin's declaration plus the shared vocabulary.

object可选string
Document type: catalog.
可选值: catalog
默认: "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.

可选值: DAILY_TOTALEVENTSNAPSHOT
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.

可选值: HUMANAGENTSYSTEM
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.

可选值: HUMANAGENTSYSTEMAPI_KEY
ActorRef2

The verified person, agent, trusted system, or API-key actor.

kind必填ActorKind
id必填string
CapabilityCatalog5

The public catalog object.

object必填string
Public object discriminator.
可选值: catalog
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.

可选值: SET_SETUPADD_ITEMSUPDATE_ITEMSREMOVE_ITEMSSAVE_DIMENSIONDELETE_DIMENSIONSET_PLACEMENTSSAVE_CRITERIONDELETE_CRITERIONSET_RESULTSSAVE_VIEWDELETE_VIEWREORDER_VIEWSCONTINUESET_REVIEWCANCELPROPOSECLASSIFYASSESSSCOREDECIDE
FactValueKind可选值 · 8

What kind of value one item fact holds, which fixes what core may compute from it.

可选值: TEXTCATEGORYNUMBERCOUNTMONEYDATEIMAGEURL
ItemPage4

One ranked pending page and the owner's full matching open count.

object可选string
可选值: item_page
默认: "item_page"
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.

可选值: PENDINGAPPLYINGAPPROVEDREJECTEDWITHDRAWN
ArtifectHostApprovalStatus可选值 · 4

Inbox status mapped exhaustively by the backend adapter from its todo enum.

可选值: PENDINGAPPROVEDREJECTEDEXPIRED
ExportedImage8

One immutable exported image, in board order, with its name, format, findings and AI fact.

position必填integer
designId必填string
name必填string
preset必填string
可选值: amazon.aplus.banneramazon.aplus.comparisonamazon.aplus.four_imageamazon.aplus.headeramazon.aplus.logoamazon.aplus.quadrantamazon.aplus.singleamazon.aplus_premium.full_widthamazon.brand_story.backgroundamazon.brand_story.cardamazon.mainamazon.secondarycustomshopify.blog_featuredshopify.collectionshopify.product
format必填RenderFormat
asset必填AssetRef
findings必填SlotFinding[]
aiGenerated可选boolean
默认: false
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).

可选值: AGENTUSER
ShopifyThemeRestoreRevision2

Make an earlier revision's document the new head (Keep/Undo on a change card).

action可选string
可选值: RESTORE_REVISION
默认: "RESTORE_REVISION"
revision必填integer
RestoreRevision3

Restore an earlier revision: the whole board (version history) or only object_ids (my-own undo).

action可选string
可选值: RESTORE_REVISION
默认: "RESTORE_REVISION"
revision必填integer
objectIds可选string[] | null
PauseReason可选值 · 4

Why sync stopped, including when a top-up is required.

可选值: OWNER_PAUSEDPLAN_REQUIREDSLOT_LIMITTOP_UP_REQUIRED
MonitorPauseReason可选值 · 3

Why a monitor is paused; every value except OWNER is an auto-pause with a notice.

可选值: OWNERFAILURESACCESS
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.

可选值: KEBLE_AGENTOWNER_AGENT
MonitorCadenceUnit可选值 · 5

Units a cadence counts in; MINUTE stays in the contract while v1's floor is 60 minutes.

可选值: MINUTEHOURDAYWEEKMONTH
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.

可选值: NEW_ITEMVALUE_CHANGERANK_MOVE
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").

可选值: MORE_MAY_EXISTREFS_PENDINGFETCH_DELAYEDSOURCE_STALEACCESSCREDITDAILY_CAPSUBJECT_UNAVAILABLEREAD_FAILEDMONITOR_INACTIVE
MonitorCycleState可选值 · 7

Where one scheduled check is; QUEUED, FETCHING and PROCESSING are open, the rest terminal.

可选值: QUEUEDFETCHINGPROCESSINGREPORTEDNO_CHANGEFAILEDSKIPPED
MonitorDeliveryChannel可选值 · 3

Where one reported cycle (or an auto-pause notice) is delivered; one delivery row per channel.

可选值: INBOXCHATEMAIL
MonitorDeliveryStatus可选值 · 5

Where one delivery row (one channel of one cycle) is; shown on the cycle row.

可选值: PENDINGDISPATCHINGDELIVEREDUNCERTAINGAVE_UP
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.

可选值: NEW_ITEMSVALUE_CHANGESRANKING
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
可选值: NEW_ITEM
默认: "NEW_ITEM"
MonitorRankMove3

An entry entered (was None) or rose in a ranked list.

kind可选string
可选值: RANK_MOVE
默认: "RANK_MOVE"
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
可选值: SET_CADENCE
默认: "SET_CADENCE"
cadence必填MonitorCadence
MonitorSetDelivery2

Change the channel toggles.

command可选string
可选值: SET_DELIVERY
默认: "SET_DELIVERY"
delivery必填MonitorDelivery
MonitorSetWatches2

Replace the watch list at once: compiles under the spec-revision fence, never re-enters setup.

command可选string
可选值: SET_WATCHES
默认: "SET_WATCHES"
watches必填MonitorWatchRequest[]
MonitorValueChange5

A tracked value moved by at least its minimum change since it was last reported (was -> now).

kind可选string
可选值: VALUE_CHANGE
默认: "VALUE_CHANGE"
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".

可选值: COMPLETEPARTIALNOT_CHECKEDNO_DATA
MonitorWatchCycle12

One watch's progress and result inside one cycle.

watch必填MonitorWatch
fetch可选MonitorFetchHandle | null
fetchDeadlineAt可选string | null
fetchDelayed可选boolean
默认: false
fetchReady可选boolean
默认: false
found可选MonitorRecordRef[]
默认: []
coverage可选MonitorWatchCoverage | null
reason可选MonitorCoverageReason | null
findings可选integer
默认: 0
readCalls可选integer
默认: 0
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_UNAVAILABLEKeble 依赖的服务暂时不可用。稍后重试。
UPSTREAM_FAILED所需服务暂时故障。请稍后重试。
TIMED_OUT调用超时。重试;如果反复出现,请缩小问题范围。