Keble API & MCPAPI v3Get a key and connect your AI Agent
DEVELOPER DOCS

Keble API & MCP

Connect your own AI Agent or code to Keble over MCP or HTTPS. Search market data, read your connected stores, run reports and keep your to-dos, with one API key.

1
Create a keySign in to create a key
Sign in and create an API key. It is shown once, so keep it somewhere safe.
2
Connect your AI Agent
Paste the snippet below into your AI tool, or call the REST routes from your code.
3
Call an operation
For example: "Use Keble to show which data I can search." Your AI Agent calls dp_catalog.

39 operations · 38 MCP tools · OpenAPI (JSON)

Some operations spend balance; each operation shows its price, and every call is in your usage log. Pricing · Usage log

Authentication & MCP

Write to ~/.codex/config.toml
Replace the placeholder with your key from the keys page. Sign in to create a key
Every call carries your API key in the Authorization header. The same key works over MCP and HTTPS.
Request header
Authorization: Bearer PASTE_YOUR_KEY_HERE
MCP address
/api/v3/mcp
REST base
/api/v3
How calls work 
HTTPS: operations are POST <REST base>/gateway/<tool> with a JSON body; a download is a GET with query parameters. Over MCP, call tools/call with the tool name and put the same body inside "request".
API key
Lets your AI Agent or code act for your account. Revoke it on the keys page at any time.
MCP
The open protocol AI tools use to call services such as Keble.
Operation
One callable action; its name is both the REST path segment and the MCP tool name.
API reference
39
Every operation an API key can call. Each one is a REST route (POST, except the workbook download) and, where marked, the MCP tool of the same name; the arguments are the same JSON in both.
Data
Next page of a searchMCP tool · dp_continue
POST/api/v3/gateway/dp_continue
Fetch the next page of a search with the cursor the previous page returned.
Auth
API key: Authorization: Bearer <key>
Price
Content data $0.0001/row · counts as 1 request
Request body · ContinueRequest
Parameters
A signed continuation request with an optional per-call row ceiling.
cursorrequiredstring
Opaque signed continuation token.
maxRowsoptionalinteger | null
Optional row ceiling for this call; the next cursor follows the last returned row. Omission preserves the normal page size.
Response · CustomerDpContinueResponse
Expose one discriminated DP continuation answer.
One of: SearchPage | EntityPage | SearchPending | SearchRefused · Variant field 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"}'
Available dataMCP tool · dp_catalog
POST/api/v3/gateway/dp_catalog
List which platforms and data types can be searched now.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · NoArguments
Parameters
No parameters; send {}.
Response · CustomerDpCatalogResponse
Expose the DP catalog or its typed refusal as one customer root schema.
One of: CapabilityCatalog | SearchRefused · Variant field object
curl -X POST \
  "/api/v3/gateway/dp_catalog" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{}'
Data freshnessMCP tool · dp_freshness
POST/api/v3/gateway/dp_freshness
How fresh each searchable data set is.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · NoArguments
Parameters
No parameters; send {}.
Response · CustomerDpFreshnessResponse
Expose the DP freshness projection or its typed refusal.
One of: Freshness | SearchRefused · Variant field object
curl -X POST \
  "/api/v3/gateway/dp_freshness" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{}'
Record detailMCP tool · dp_record
POST/api/v3/gateway/dp_record
Every field of one search result, plus what it relates to.
Auth
API key: Authorization: Bearer <key>
Price
Content data $0.0001/row · counts as 1 requestCreator data $0.0001/row · counts as 1 request
Request body · RecordAddress
Parameters
The ONE public record address: one analyzed record's kind and key.
kindrequiredAnalyzedRecordKind
recordKeyrequiredstring
seriesWindowoptionalDateWindow | null
Inclusive date window for an opt-in record-level metric series; null requests no series.
Response · CustomerDpRecordResponse
Expose one DP record detail or its typed refusal.
One of: RecordDetail | SearchRefused · Variant field 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"}'
Trending elementsMCP tool · dp_motifs
POST/api/v3/gateway/dp_motifs
Elements that are spreading or just starting to trend, for one section.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · MotifQuery
Parameters
One named motif section and window with an optional row ceiling.
daysoptionalinteger | null
Length in days of the current window; null when start/end state the span.
startoptionalstring | null
Inclusive first day of an explicit span.
endoptionalstring | null
Inclusive last day of the current window; null uses the newest member publication day in scope.
sectionrequiredMotifSection
termsoptionalstring[]
Word-match terms tested against each member's label or instance, or the member content's searchable fields; at most eight.
default: []
maxRowsoptionalinteger | 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.
Response · CustomerDpMotifsResponse
Expose one DP motif page, its pending variant or a typed refusal.
One of: EntityPage | SearchPending | SearchRefused · Variant field object
curl -X POST \
  "/api/v3/gateway/dp_motifs" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"section":"SPREADING"}'
Store connections
Connectable sourcesMCP tool · elta_catalog
POST/api/v3/gateway/elta_catalog
The stores and data sources you can connect.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · NoArguments
Parameters
No parameters; send {}.
Response · PluginDeclarationCatalog
Every installed plugin's declaration plus the shared vocabulary: GET /v2/catalog.
objectoptionalstring
Document type: catalog.
values: catalog
default: "catalog"
declarationsrequiredPluginDeclaration[]
Declarations of every installed plugin.
levelsoptionalEntityLevel[]
Every level a value may carry, with its title and parent.
default: []
refusalsoptionalWriteRefusal[]
Every refusal an action row may carry, with its title and meaning.
default: []
curl -X POST \
  "/api/v3/gateway/elta_catalog" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{}'
Your storesMCP tool · elta_stores
POST/api/v3/gateway/elta_stores
Connected stores with their connectors and sync state.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · NoArguments
Parameters
No parameters; send {}.
Response · StoresResponse
The stores belonging to the asserted owner, including unfinished stores.
objectoptionalstring
Document type: stores response.
values: stores_response
default: "stores_response"
storesrequiredStoreRecord[]
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 '{}'
Store capabilitiesMCP tool · elta_store_capabilities
POST/api/v3/gateway/elta_store_capabilities
What one store can do now: which live lookups, changes and data are available, and what blocks the rest.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ResumeStoreRequest
Parameters
Resume capture after the caller has reconciled the store's slot policy.
storeIdrequiredstring
Store whose sync will resume.
Response · StoreCapabilities
What the installed sources can do right now for one store: live reads, writes and captures.
objectoptionalstring
Document type: store capabilities.
values: store_capabilities
default: "store_capabilities"
storeIdrequiredstring
Store whose current abilities this document describes.
lookupsrequiredCapabilityRow[]
Installed live reads: one row per (key, account).
actionsrequiredCapabilityRow[]
Installed provider writes: one row per (key, account).
datasetsrequiredCapabilityRow[]
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"}'
Store metricsMCP tool · elta_metrics
POST/api/v3/gateway/elta_metrics
Stored metrics of a connected store.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · MetricsRequest
Parameters
A serving read of one or more metrics over a date range, current values only.
metricKeysrequiredstring[]
Metrics to read; at least one.
levelrequiredstring
The entity level key the caller wants values at.
daysrequiredDayRange
Inclusive reporting days in the account's timezone.
storeIdsoptionalstring[]
Stores to include; empty selects the asserted owner's stores.
default: []
accountIdsoptionalstring[]
Accounts to read; empty means every account of the owner.
default: []
entitiesoptionalstring[]
Stored entity keys to read; empty means every entity.
default: []
pageoptionalPageRequest
Row limit and cursor for this read.
default: {"limit":200}
Response · MetricPage
One bounded page of combined range values: the /v2/metrics/query response.
rowsrequiredMetricRangeValue[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | null
Why this page is empty and what selection or source to check.
objectoptionalstring
Fixed tag marking this object as a metric page.
values: metric_page
default: "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"}}'
Store factsMCP tool · elta_facts
POST/api/v3/gateway/elta_facts
Stored facts of a connected store, such as campaigns and bids.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · FactsRequest
Parameters
A serving read of stored facts for one owner: family, days, selection and pin.
familyKeyrequiredstring
The fact family to read.
daysrequiredDayRange
Inclusive reporting days in the account's timezone.
storeIdsoptionalstring[]
Stores to include; empty selects the asserted owner's stores.
default: []
accountIdsoptionalstring[]
Accounts to read; empty means every account of the owner.
default: []
entitiesoptionalstring[]
Stored entity keys to read; empty means every entity.
default: []
attributesoptionalAttributeMatch[]
View selections that restrict which rows are returned.
default: []
asOfoptionalstring | null
Instant to read as of; set this or capture_id, never both.
captureIdoptionalstring | null
Committed capture to read as of; set this or as_of, never both.
pageoptionalPageRequest
Row limit and cursor for this read.
default: {"limit":200}
Response · FactPage
One bounded page of fact rows plus the coverage of every requested day.
rowsrequiredFactRow[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | null
Why this page is empty and what selection or source to check.
objectoptionalstring
Fixed tag marking this object as a fact page.
values: fact_page
default: "fact_page"
coveragerequiredDayCoverage[]
Coverage of every requested account, family and day.
readAsOfrequiredstring
The single instant all rows were read at.
blockedoptionalBlockedLane[]
Blocked lanes with their reason and fix.
default: []
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"}}'
Fact historyMCP tool · elta_fact_history
POST/api/v3/gateway/elta_fact_history
How one stored fact changed over time.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · FactsRequest
Parameters
A serving read of stored facts for one owner: family, days, selection and pin.
familyKeyrequiredstring
The fact family to read.
daysrequiredDayRange
Inclusive reporting days in the account's timezone.
storeIdsoptionalstring[]
Stores to include; empty selects the asserted owner's stores.
default: []
accountIdsoptionalstring[]
Accounts to read; empty means every account of the owner.
default: []
entitiesoptionalstring[]
Stored entity keys to read; empty means every entity.
default: []
attributesoptionalAttributeMatch[]
View selections that restrict which rows are returned.
default: []
asOfoptionalstring | null
Instant to read as of; set this or capture_id, never both.
captureIdoptionalstring | null
Committed capture to read as of; set this or as_of, never both.
pageoptionalPageRequest
Row limit and cursor for this read.
default: {"limit":200}
Response · FactHistoryResponse
One bounded page of every stored version, superseded ones included.
rowsrequiredFactVersion[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | null
Why this page is empty and what selection or source to check.
objectoptionalstring
Fixed tag marking this object as a fact history page.
values: fact_history_response
default: "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"}}'
Store changesMCP tool · elta_changes
POST/api/v3/gateway/elta_changes
Recent changes to a store's stored facts.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ChangesRequest
Parameters
A serving read of derived fact changes for one owner: the fact read's own selection.
familyKeyrequiredstring
The fact family to read.
daysrequiredDayRange
Inclusive reporting days in the account's timezone.
storeIdsoptionalstring[]
Stores to include; empty selects the asserted owner's stores.
default: []
accountIdsoptionalstring[]
Accounts to read; empty means every account of the owner.
default: []
entitiesoptionalstring[]
Stored entity keys to read; empty means every entity.
default: []
attributesoptionalAttributeMatch[]
View selections that restrict which rows are returned.
default: []
asOfoptionalstring | null
Instant to read as of; set this or capture_id, never both.
captureIdoptionalstring | null
Committed capture to read as of; set this or as_of, never both.
pageoptionalPageRequest
Row limit and cursor for this read.
default: {"limit":200}
Response · FactChangePage
One bounded page of derived fact changes; total_rows counts every change matched.
rowsrequiredFactChange[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | 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"}}'
Live store lookupMCP tool · elta_lookup
POST/api/v3/gateway/elta_lookup
Read current data straight from the store.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · LookupRequest
Parameters
One live read pinned to an owner-visible store and optional stored account.
storeIdrequiredstring
Owner-visible store to read.
lookupKeyrequiredstring
The declared lookup to run.
accountIdoptionalstring | null
Stored account to read; required when the source has several.
queryrequiredJsonValue
The lookup's own query payload.
pageoptionalPageRequest
Row limit and cursor for this read.
default: {"limit":200}
Response · LookupPage
One bounded page of live results; next_cursor is the provider's page token.
objectoptionalstring
Fixed tag marking this object as a lookup page.
values: lookup_page
default: "lookup_page"
rowsrequiredJsonValue[]
The result rows in the lookup's own shape.
nextCursoroptionalstring | 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"}}'
Query store dataMCP tool · elta_query
POST/api/v3/gateway/elta_query
Filter and aggregate stored store data.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · QueryRequest
Parameters
Select a logical target and optionally narrow the authenticated owner's stores/accounts.
targetrequiredQueryTarget
Catalog fact family to read, or METRIC_DAYS for calculated daily values.
storeIdsoptionalstring[]
Stores to include; empty selects the asserted owner's stores.
default: []
accountIdsoptionalstring[]
Accounts to include within those stores; empty selects all their accounts.
default: []
pipelinerequiredQueryStage[]
Read-only aggregation stages over the selected logical rows.
pageoptionalPageRequest
Page size and continuation cursor for this exact read.
default: {"limit":200}
Response · QueryPage
One bounded aggregation result page, reusing the shared cursor/total contract.
rowsrequiredQueryRow[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | null
Why this page is empty and what selection or source to check.
objectoptionalstring
Document type: aggregation query page.
values: query_page
default: "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}]}'
Preview an undoMCP tool · elta_preview_revert
POST/api/v3/gateway/elta_preview_revert
Check whether recorded store changes can be undone, without proposing anything.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · RevertRequest
Parameters
Ask ELTA to construct the undo of one proposal; callers choose rows, never undo values.
proposalIdrequiredstring
Proposal to revert.
actionKeysoptionalstring[]
Optional rows to revert; empty means every revertible row.
default: []
replayKeyoptionalstring | null
Caller-owned idempotency key.
attributionoptionalProposalAttribution | null
Origin and reason of this undo; excluded from its hash.
Response · PreviewView
Stateless answer to a preview request, with outcomes and diffs aligned to its batch.
batchrequiredActionBatch
Requested action batch; nothing is persisted by preview.
previewsrequiredActionOutcome[]
One live outcome per action, in order.
diffsrequiredActionDiff[]
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"}'
Reports
Create a reportMCP tool · artifect_create
POST/api/v3/gateway/artifect_create
Start a positioning analysis or an Amazon product report; sending the same key twice returns the first run.
Auth
API key: Authorization: Bearer <key>
Price
Amazon product report $0.0001/call · counts as 5 requestsProduct positioning $0.0001/call · counts as 5 requestsAds optimization advice $0.0001/call · counts as 5 requestsProduct images $0.0001/call · counts as 1 request
Request body · ArtifectReportCreate | ArtifectPositioningCreate | ArtifectAdsAdviceCreate | ArtifectShopifyThemeCreate | ArtifectChangeListCreate | ArtifectShopifyBlogPostsCreate | ArtifectShopifyProductCreate | ArtifectAmzListingCreate
Parameters
Carry the complete V3 report premise accepted by the runtime.
kindoptionalstring
values: AMZ_PRODUCT_REPORT
default: "AMZ_PRODUCT_REPORT"
replayKeyrequiredstring
asinrequiredstring
amazonMarketplacerequiredAmazonMarketplace
keywordsoptionalstring[]
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.
default: []
categoryIdoptionalinteger | null
Confirmed Amazon category; with at least one nonblank keyword it skips REPORT_SCOPE.
titleoptionalstring | null
imageoptionalstring | null
languageoptionalLanguage | null
similarProductsLimitoptionalinteger | null
How many comparable products to analyse; None keeps the runtime's website-aligned default.
economicSetupoptionalReportProfileEconomicFields | 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.
purchaseCostrequiredArtifectReportUserPurchaseCost | 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.
kindoptionalstring
values: POSITIONING
default: "POSITIONING"
replayKeyrequiredstring
positioningContextrequiredstring
pluginIdoptionalstring | null
Installed plugin ID; omit for the host default. Setup must match this plugin's declaration.
setupoptionalobject | null
Values for the selected plugin's declared setup fields; omitted fields are proposed at SCOPE.
languageoptionalLanguage | null
Start one on-demand Ads optimization-suggestions run for one store.
kindoptionalstring
values: AMZ_ADS_ADVICE
default: "AMZ_ADS_ADVICE"
replayKeyrequiredstring
storeIdrequiredstring
anchorDayoptionalstring | null
Requested data day; null means yesterday in UTC; a later day is refused before any source is read.
languageoptionalLanguage | null
Create one Shopify theme document workspace from the theme contract's document request.
kindoptionalstring
values: SHOPIFY_THEME_UPDATE
default: "SHOPIFY_THEME_UPDATE"
requestrequiredThemeDocumentCreateRequest
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 published with one approval in To do; 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). 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 to discard.); PREVIEW_NOT_READY (Update the preview and wait until the copy shows this revision.); PROPOSAL_PENDING (A request for this step waits in To do; decide it there first.); 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 (ELTA refused a write 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.
kindrequiredstring
values: AMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGES
requestrequiredChangeListCreatePremise
Create one guided Shopify blog post set from the kind's own BlogCreate.
kindoptionalstring
values: SHOPIFY_BLOG_POSTS
default: "SHOPIFY_BLOG_POSTS"
requestrequiredBlogCreate
Create one unpublished Shopify product draft from the kind's ProductCreateRequest.
kindoptionalstring
values: SHOPIFY_PRODUCT
default: "SHOPIFY_PRODUCT"
requestrequiredProductCreateRequest
Create one owner-fenced new Amazon listing draft from the kind's own ListingCreate.
kindoptionalstring
values: AMZ_LISTING
default: "AMZ_LISTING"
requestrequiredListingCreate
Response · CustomerArtifectCreateResponse
Expose an Artifect reference or sanitized Artifect failure.
One of: ArtifectRef | ArtifectAccountRequired | ArtifectFailure · Variant field 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}}'
Answer a reportMCP tool · artifect_answer
POST/api/v3/gateway/artifect_answer
Answer a report's pending question so it continues.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ArtifectAnswerRequest
Parameters
Which run, and the typed decision fragment (own input key, revision and replay_key).
refrequiredArtifectRef
answerrequiredArtifectAnswer
Response · CustomerArtifectDecisionResponse
Expose an Artifect decision status, rejection or sanitized failure.
One of: ArtifectStatus | ArtifectDecisionRejection | ArtifectFailure | ArtifectProductImagesQuote · Variant field object
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"]}}}'
Adjust a reportMCP tool · artifect_adjust
POST/api/v3/gateway/artifect_adjust
Change one finished decision of a report.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ArtifectAdjustRequest
Parameters
Which run and typed adjustment; removed arms retain ordinary INVALID_REQUEST validation.
refrequiredArtifectRef
adjustrequiredArtifectAdjust
Response · CustomerArtifectDecisionResponse
Expose an Artifect decision status, rejection or sanitized failure.
One of: ArtifectStatus | ArtifectDecisionRejection | ArtifectFailure | ArtifectProductImagesQuote · Variant field object
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"]}}}'
Cancel a reportMCP tool · artifect_cancel
POST/api/v3/gateway/artifect_cancel
Cancel a running report.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ArtifectRef
Parameters
Identify one durable Artifect instance by its opaque public id.
objectoptionalstring
values: artifect_ref
default: "artifect_ref"
idrequiredstring
Response · CustomerArtifectStatusResponse
Expose an Artifect lifecycle status or sanitized failure.
One of: ArtifectStatus | ArtifectFailure · Variant field 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"}'
Report statusMCP tool · artifect_status
POST/api/v3/gateway/artifect_status
Where a report stands and what it is waiting for.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ArtifectRef
Parameters
Identify one durable Artifect instance by its opaque public id.
objectoptionalstring
values: artifect_ref
default: "artifect_ref"
idrequiredstring
Response · CustomerArtifectStatusResponse
Expose an Artifect lifecycle status or sanitized failure.
One of: ArtifectStatus | ArtifectFailure · Variant field 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"}'
Report questionsMCP tool · artifect_read_input
POST/api/v3/gateway/artifect_read_input
The inputs a report is waiting for, with their options.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ArtifectInputRequest
Parameters
One page of the input a parked run offers.
refrequiredArtifectRef
inputKeyrequiredstring
cursoroptionalstring | null
maxItemsoptionalinteger | null
Response · CustomerArtifectInputResponse
Expose an Artifect input page, a terminal-run rejection or a sanitized failure.
One of: CustomerArtifectInputPage | ArtifectDecisionRejection | ArtifectFailure · Variant field object
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"}'
Read a reportMCP tool · artifect_snapshot
POST/api/v3/gateway/artifect_snapshot
A report's current result.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ArtifectSnapshotRequest
Parameters
Which run, which immutable revision (None is the head) and which board objects to focus.
refrequiredArtifectRef
revisionoptionalinteger | null
focusoptionalstring[]
default: []
Response · CustomerArtifectSnapshotResponse
Expose an Artifect snapshot or sanitized failure.
One of: ArtifectSnapshot | ArtifectFailure · Variant field 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"}}'
Read one report detailMCP tool · artifect_detail
POST/api/v3/gateway/artifect_detail
One part of a report, such as one listing, cell or ads row, asked in the report's own kind.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ArtifectDetailRequest
Parameters
Response · CustomerArtifectDetailResponse
Expose one kind-typed Artifect detail answer or sanitized failure (AWPD D-4).
One of: ArtifectDetail | ArtifectFailure · Variant field 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"}}}'
Positioning pluginsMCP tool · artifect_plugins
POST/api/v3/gateway/artifect_plugins
The plugins a positioning analysis can use.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · NoArguments
Parameters
No parameters; send {}.
Response · CustomerArtifectPluginListResponse
Expose the installed positioning plugins in a JSON-object envelope.
objectoptionalstring
values: artifect_plugin_list
default: "artifect_plugin_list"
pluginsrequiredRoomPublicDeclaration[]
curl -X POST \
  "/api/v3/gateway/artifect_plugins" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{}'
Your reportsMCP tool · artifect_runs
POST/api/v3/gateway/artifect_runs
Your own report runs, newest first, a page at a time; leave out the kind to list every kind.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ArtifectRunsRequest
Parameters
Which of the caller's own Artifect runs to list, newest first.
kindoptionalArtifectKind | null
storeIdoptionalstring | null
limitoptionalinteger
default: 5
beforeoptionalstring | null
Response · ArtifectRunList
One newest-first page; next_before is set only when an older run exists.
objectoptionalstring
values: artifect_run_list
default: "artifect_run_list"
runsrequiredArtifectRunItem[]
nextBeforeoptionalstring | 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"}'
Describe a report kindMCP tool · artifect_describe
POST/api/v3/gateway/artifect_describe
One report kind's name, purpose and the exact fields its create, adjust, answer and detail calls accept.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ArtifectDescribeRequest
Parameters
Which kind's request bodies to describe (A-03).
kindrequiredstring
Identify the workflow family handled by an Artifect runtime.
values: AMZ_PRODUCT_REPORTPOSITIONINGAMZ_ADS_ADVICESHOPIFY_THEME_UPDATEAMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGESSHOPIFY_BLOG_POSTSSHOPIFY_PRODUCTAMZ_LISTING
Response · ArtifectKindDescription
One hosted kind's label, purpose and exact request bodies as one JSON Schema document.
kindrequiredArtifectKind
labelrequiredstring
purposerequiredstring
requestSchemarequiredobject
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"}'
Download suggestions workbook
GET/api/v3/gateway/artifect_workbook
An Ads optimization suggestions run as an Excel file.
Auth
API key: Authorization: Bearer <key>
Price
Free
Parameters
refrequiredstring
The run to download.
languagerequiredLanguage
Language of the workbook labels.
Response
curl -G \
  "/api/v3/gateway/artifect_workbook" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  --data-urlencode "ref=<ref>" \
  --data-urlencode "language=<language>"
Changes & to-dos
Propose a store changeMCP tool · elta_propose
POST/api/v3/gateway/elta_propose
Propose a change such as a bid or budget; nothing runs until a person approves it on the web or with approval_decide.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ActionBatch
Parameters
One non-empty proposal batch with a unique caller-owned key for each action.
actionsrequiredProviderAction[]
Requested actions in order, each with a unique action_key.
Response · ProposalFiled
The result of filing an ELTA proposal and its SYSTEM-created approval.
proposalrequiredProposalView
itemrequiredApprovalItem
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"}}]}'
Propose an undoMCP tool · elta_propose_revert
POST/api/v3/gateway/elta_propose_revert
Propose undoing a recorded store change; like any change, it runs only after approval.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · RevertRequest
Parameters
Ask ELTA to construct the undo of one proposal; callers choose rows, never undo values.
proposalIdrequiredstring
Proposal to revert.
actionKeysoptionalstring[]
Optional rows to revert; empty means every revertible row.
default: []
replayKeyoptionalstring | null
Caller-owned idempotency key.
attributionoptionalProposalAttribution | null
Origin and reason of this undo; excluded from its hash.
Response · ProposalFiled
The result of filing an ELTA proposal and its SYSTEM-created approval.
proposalrequiredProposalView
itemrequiredApprovalItem
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"}'
View an approvalMCP tool · approval_view
POST/api/v3/gateway/approval_view
Read the state of one proposed change.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ApprovalViewRequest
Parameters
Select an approval by its existing item id or ELTA proposal id.
itemIdoptionalstring | null
Existing owner-scoped inbox item id.
proposalIdoptionalstring | null
ELTA proposal id resolved through its owner-scoped inbox key.
Response · ApprovalView
The inbox item and ELTA's current proposal state shown to a person.
itemrequiredApprovalItem
proposalrequiredProposalView
curl -X POST \
  "/api/v3/gateway/approval_view" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"item_1"}'
Approve or reject a changeMCP tool · approval_decide
POST/api/v3/gateway/approval_decide
Approve or reject one proposed store change; only you or your API key can decide.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · ApprovalDecideRequest
Parameters
The gateway request carrying one item id and one human decision.
itemIdrequiredstring
decisionrequiredApprovalDecision
Response · ApprovalView
The inbox item and ELTA's current proposal state shown to a person.
itemrequiredApprovalItem
proposalrequiredProposalView
curl -X POST \
  "/api/v3/gateway/approval_decide" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"item_1","decision":"APPROVE"}'
Add a to-doMCP tool · todo_create
POST/api/v3/gateway/todo_create
Add a to-do; sending the same key twice returns the first item.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · TodoCreate
Parameters
Immutable original intent for an ordinary todo.
kindoptionalstring
values: TODO
default: "TODO"
contentrequiredItemContent
keyoptionalstring | null
Response · CreateResult
Stored item and whether the call admitted a new row.
objectoptionalstring
values: create_result
default: "create_result"
itemrequiredTodoItem | AlertItem | ApprovalItem | NotificationItem
createdrequiredboolean
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"}}'
Complete a to-doMCP tool · todo_complete
POST/api/v3/gateway/todo_complete
Mark one to-do done.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · InboxItemRef
Parameters
Which inbox item a read or completion names (one tool/route input).
itemIdrequiredstring
Response · TodoItem
Ordinary todo with immutable creation and mutable current content.
idrequiredstring
ownerrequiredOwnerRef
currentrequiredItemContent
created_atrequiredstring
revisionrequiredinteger
created_byoptionalActorRef | null
kindoptionalstring
values: TODO
default: "TODO"
objectoptionalstring
values: todo_item
default: "todo_item"
creationrequiredTodoCreate
statusrequiredTodoStatus
resolved_byoptionalActorRef | 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"}'
Withdraw a to-doMCP tool · todo_withdraw
POST/api/v3/gateway/todo_withdraw
Withdraw an open to-do or approval request your AI Agent created; items a person created stay.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · InboxItemRef
Parameters
Which inbox item a read or completion names (one tool/route input).
itemIdrequiredstring
Response · CustomerInboxItemResponse
Expose the inbox owner's todo/approval union without copying either item model.
One of: TodoItem | AlertItem | ApprovalItem | NotificationItem · Variant field 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"}'
Open itemsMCP tool · inbox_pending
POST/api/v3/gateway/inbox_pending
Your open to-dos and pending approvals.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · InboxPendingRequest
Parameters
One pending page: an opaque cursor and a bounded size (one tool/route input).
cursoroptionalstring | null
limitoptionalinteger
default: 20
Response · ItemPage
One ranked pending page and the owner's full matching open count (R7).
objectoptionalstring
values: item_page
default: "item_page"
itemsrequiredTodoItem[] | AlertItem[] | ApprovalItem[] | NotificationItem[]
next_cursoroptionalstring | null
totalrequiredinteger
curl -X POST \
  "/api/v3/gateway/inbox_pending" \
  -H "Authorization: Bearer PASTE_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{}'
One inbox itemMCP tool · inbox_get
POST/api/v3/gateway/inbox_get
One to-do or approval in any state.
Auth
API key: Authorization: Bearer <key>
Price
Free
Request body · InboxItemRef
Parameters
Which inbox item a read or completion names (one tool/route input).
itemIdrequiredstring
Response · CustomerInboxItemResponse
Expose the inbox owner's todo/approval union without copying either item model.
One of: TodoItem | AlertItem | ApprovalItem | NotificationItem · Variant field 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"}'
Tools
Profit calculatorMCP tool · amz_profit_calculate
POST/api/v3/gateway/amz_profit_calculate
Calculate one product's profit breakdown from its cost and shipping profile.
Auth
API key: Authorization: Bearer <key>
Price
Profit calculator counts as 1 request
Request body · AmzProfitCalculateRequest
Parameters
One product's cost and shipping observations for the profit calculator.
costProfilerequiredCostProfile
shippingProfilerequiredShippingProfile
shippingModeoptionalShippingMode
default: "FREIGHT"
isPeakPeriodoptionalboolean
default: false
Response · ProfitBreakdown
One coherent scenario's exact selling-price-to-profit waterfall.
scenarioKeyrequiredstring
rolerequiredScenarioRole
shippingModerequiredShippingMode
isPeakPeriodrequiredboolean
sellingPricerequiredMinorUnitMoney
linesrequiredProfitBreakdownLine[]
profitrequiredMinorUnitMoney
marginrequirednumber
sizingrequiredSizingDetail
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"}}}'
Objects
1017
The request and response objects the operations use. Open one to see its fields.
AbsencePolicyvalues · 2
What an entity missing from a confirmed day means for its family.
values: ZERO_WHEN_COVEREDUNKNOWN
AbsoluteTargetBidValue2
An absolute bid for a keyword, a product target or an exact-harvest keyword.
kindoptionalstring
values: target_bid
default: "target_bid"
bidrequirednumber | string
AccountChoice2
One owner-visible account option offered when the caller must select an account.
accountIdrequiredstring
Stored account identifier.
labelrequiredstring
Readable account or marketplace name.
AccountRef4
One provider account reached through one bound connection.
connectionIdrequiredstring
Connector reaching this account.
accountIdrequiredstring
Account identifier within the source.
timezonerequiredstring
Reporting timezone of this account.
currencyoptionalstring | null
Account currency; null when no money is reported.
ActionBatch1
One non-empty proposal batch with a unique caller-owned key for each action.
actionsrequiredProviderAction[]
Requested actions in order, each with a unique action_key.
ActionDiff10
One derived action diff with its declared undo fidelity and whether the row is revertible.
actionKeyrequiredstring
Proposal action row key.
kindrequiredActionKind
ADD, SET or REMOVE action presentation kind.
statusrequiredActionStatus
Proposal preview or apply status for this row.
targetrequiredEntityRef
labeloptionalstring | null
Provider display label, when available.
linesoptionalDiffLine[]
Derived field-level change lines.
default: []
fidelityrequiredRevertFidelity
Declared completeness of the action's undo.
revertibleoptionalboolean
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.
default: false
revertNoteoptionalStoreLocalizedText | null
Provider-specific undo limitation (3.5.0: bilingual).
alsoPendingoptionalstring[]
Other open proposals touching the same change key.
default: []
ActionFamily2
One owner-facing group of actions that a store can enable or disable together.
keyrequiredstring
Write-family identifier.
titlerequiredStoreLocalizedText
Owner-facing name of this write family.
ActionIntentvalues · 5
ELTA-owned neutral write meanings, without provider wire names.
values: SET_BIDSET_STATESET_DAILY_BUDGETADD_KEYWORDADD_NEGATIVE_KEYWORD
ActionKindvalues · 3
What one action does to its target; it selects the shared gate and diff colour.
values: SETADDREMOVE
ActionOutcome12
Live preview or final result for one action, with one typed refusal reason if rejected.
actionKeyrequiredstring
The action row this outcome belongs to.
statusrequiredActionStatus
Preview or apply result for this action.
currentoptionalJsonValue | null
Current provider value when available.
labeloptionalstring | null
Provider label for the target, when available.
createdoptionalEntityRef | null
issueoptionalProviderIssue | null
Provider-owned refusal reason.
refusaloptionalstring | null
ELTA-owned write-gate refusal reason.
blockedByoptionalstring | null
Earlier row or apply record holding a conflicting change key.
problemsoptionalFieldProblem[]
Field-level provider validation details.
default: []
quoteoptionalJsonValue | null
Provider estimate included in this outcome.
versionoptionalstring | null
Opaque live token read at preview.
createdVersionoptionalstring | null
Provider version of the entity an applied ADD created.
ActionProposal15
Stored proposal plus preview and eventual outcomes for one store and account.
objectoptionalstring
Fixed tag marking an action proposal.
values: action_proposal
default: "action_proposal"
proposalIdrequiredstring
Identifier of this proposal.
storeIdrequiredstring
Store whose write policy applies.
accountrequiredAccountRef
Account every action of this proposal targets.
batchrequiredActionBatch
Requested provider changes.
replayKeyoptionalstring | null
Caller-owned idempotency key.
attributionoptionalProposalAttribution | null
Origin and reason frozen at creation; null for 3.2 proposals; not hashed.
declineoptionalProposalDecline | null
Decline actor and reason; set exactly on a DECLINED proposal; not hashed.
previewsrequiredActionOutcome[]
One live outcome per action, in order.
revertsoptionalRevertLink[]
Apply records this proposal is attempting to revert.
default: []
proposalHashrequiredstring
Hash of the exact proposal contents.
proposedAtrequiredstring
Instant the proposal was created.
expiresAtrequiredstring
Instant after which the proposal cannot be applied.
stateoptionalProposalState
Proposal lifecycle state.
default: "PROPOSED"
outcomesoptionalActionOutcome[]
One final outcome per action, set after proposal application.
default: []
ActionStatusvalues · 5
Preview or apply result for one action; equality-to-preview is not a status.
values: ACCEPTEDAPPLIEDNO_CHANGEREJECTEDUNKNOWN
AddBlock4
Add one block (caller-chosen stable key) to a section after another block (None: at the end).
actionoptionalstring
values: ADD_BLOCK
default: "ADD_BLOCK"
sectionKeyrequiredstring
blockrequiredThemeBlockInstance
afteroptionalstring | null
AddDesign6
Add an empty OWN image; layouts come only from ApplyTemplate (one template path, G5).
actionoptionalstring
values: ADD_DESIGN
default: "ADD_DESIGN"
designIdrequiredstring
namerequiredstring
presetrequiredstring
values: 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
sizeoptionalPixelSize | null
positionoptionalBoardPoint | null
AddItems3
Add items by hand, as relevant; facts are checked against the declaration, nothing else.
typeoptionalstring
values: ADD_ITEMS
default: "ADD_ITEMS"
actionKeyrequiredstring
itemsrequiredSourcedItem[]
AddLayer5
Insert a layer (caller-minted id) above above, or at the top when None.
actionoptionalstring
values: ADD_LAYER
default: "ADD_LAYER"
designIdrequiredstring
layerrequiredImageLayer | TextLayer | ShapeLayer | GroupLayer
aboveoptionalstring | null
parentoptionalstring | null
AddNegativeKeywordValue2
The negative-keyword match type only; the text is the row's exact search term.
kindoptionalstring
values: negative_keyword
default: "negative_keyword"
matchTyperequiredAdsNegativeMatch
AddPage4
Add an empty page for one template (UNKNOWN target refusals are the runtime's).
actionoptionalstring
values: ADD_PAGE
default: "ADD_PAGE"
templaterequiredThemeTemplateRef
previewPathrequiredstring
newPageoptionalNewKeblePage | null
AddPlan7
Add a content plan whose rows will become variants of the OWN image source_id.
actionoptionalstring
values: ADD_PLAN
default: "ADD_PLAN"
objectIdrequiredstring
namerequiredstring
sourceIdrequiredstring
columnsrequiredPlanColumn[]
rowsoptionalPlanRow[]
default: []
positionoptionalBoardPoint | null
AddRows2
Append rows (create also uses this shape).
opoptionalstring
values: ADD_ROWS
default: "ADD_ROWS"
rowsrequiredNewChangeRow[]
AddSection4
Place a new section (caller-chosen stable key) on a page after an anchor (None: at the end).
actionoptionalstring
values: ADD_SECTION
default: "ADD_SECTION"
pagerequiredThemeTemplateRef
sectionrequiredThemeSectionInstance
afteroptionalstring | null
AdsAdTypevalues · 3
Amazon Ads product family one row belongs to (ELTA1 TodoAdType).
values: SPSBSD
AdsAdviceActionvalues · 7
The one action the AI picks for one reviewed row (ELTA1 TodayAdviceAction).
values: LOWER_BIDNEGATEPAUSERAISE_BIDRAISE_BUDGETHARVEST_EXACTHOLD
AdsAdviceRow23
One flagged entity row of one marketplace, with its five windows.
rowKeyrequiredstring
levelrequiredAdsLevel
adTyperequiredAdsAdType
entityIdrequiredstring
campaignIdoptionalstring | null
adGroupIdoptionalstring | null
keywordIdoptionalstring | null
targetIdoptionalstring | null
advertisedAsinoptionalstring | null
nameoptionalstring | null
campaignNameoptionalstring | null
adGroupNameoptionalstring | null
stateoptionalstring | null
budgetoptionalnumber | string | null
matchTypeoptionalAdsMatchType | null
bidoptionalnumber | string | null
drequiredAdsWindowMetrics
dMinus1requiredAdsWindowMetrics
dMinus7requiredAdsWindowMetrics
l7requiredAdsWindowMetrics
p7requiredAdsWindowMetrics
triggerCodesrequiredAdsTriggerCode[]
foldedIntooptionalstring | null
AdsChangeListAbsenceReasonvalues · 4
Why a marketplace that shows advice has no one-click AMZ_ADS_CHANGES list.
values: NO_ONE_CLICK_ROWSNO_ADS_ACCOUNTNOT_HOSTEDCREATE_FAILED
AdsDecisionTypevalues · 1
The Ads kind's one agent decision on the shared decision_type discriminator.
values: ADS_ROW_AUDIT
AdsEvidenceFieldvalues · 8
The non-metric source facts of one AdsAdviceRow a citation may name.
values: namecampaign_namead_group_namestatebudgetbidtrigger_codesadvertised_asin
AdsEvidenceRolevalues · 2
Whether one cited fact supports or cautions against the advice.
values: SUPPORTSCAUTION
AdsLevelvalues · 6
Advice grain, mapped explicitly onto ELTA's EntityLevel.
values: CAMPAIGNAD_GROUPKEYWORDTARGETSEARCH_TERMADVERTISED_PRODUCT
AdsLevelNoChange3
Rows of one level that raised no signal: the proof of what was not shown.
levelrequiredAdsLevel
countrequiredinteger
l7Spendoptionalnumber | string | null
AdsMarketplaceAdvice12
The screen and review result of ONE marketplace of the store.
marketplacerequiredAmazonMarketplace
currencyrequiredCurrency
anchorDayrequiredstring
completenessrequiredAdsWindowCompleteness
screenedCountrequiredinteger
candidateCountrequiredinteger
candidateOverflowoptionalboolean
default: false
noChangeoptionalAdsLevelNoChange[]
default: []
rowsoptionalAdsAdviceRow[]
default: []
reviewsoptionalAdsRowReview[]
default: []
targetAcosPctoptionalnumber | string | null
oneClickoptionalAdsRowOneClick[]
default: []
AdsMarketplaceQuery3
Ask for one marketplace's advice, optionally only the rows of one action.
objectoptionalstring
values: ads_marketplace
default: "ads_marketplace"
marketplacerequiredAmazonMarketplace
actionoptionalAdsAdviceAction | null
AdsMatchTypevalues · 3
Keyword-only match identity from the existing ELTA datasets.
values: EXACTPHRASEBROAD
AdsMetricEvidenceRef5
Cite one measured cell of the reviewed row by window and metric.
kindoptionalstring
values: metric
default: "metric"
rowKeyrequiredstring
windowrequiredAdsMetricWindow
metricrequiredAdsMetricName
rolerequiredAdsEvidenceRole
AdsMetricNamevalues · 6
The AdsWindowMetrics fields a metric citation may name.
values: impressionsclicksspendorderssalesacos_pct
AdsMetricWindowvalues · 5
The five metric-window fields of one AdsAdviceRow a citation may name.
values: dd_minus_1d_minus_7l7p7
AdsNegativeMatchvalues · 2
The agent's negative-keyword match choice; mapped once to ELTA's type.
values: EXACTPHRASE
AdsReadOnlyReasonvalues · 5
Why one shown advice row has no one-click change.
values: NO_ELTA_ACTIONNOT_SPONSORED_PRODUCTSNO_VALUEASIN_TERMOVER_ROW_CAP
AdsReasoning3
Observation, inference and uncertainty as separate qualitative statements.
observedSignalrequiredstring
interpretationrequiredstring
caveatoptionalstring | null
AdsRowAuditAnswer3
One audit fragment: reviews for some offered rows plus the rows deliberately skipped.
decisionTypeoptionalstring
values: ADS_ROW_AUDIT
default: "ADS_ROW_AUDIT"
reviewsoptionalAdsRowReview[]
default: []
skippedRowKeysoptionalstring[]
default: []
AdsRowAuditItem4
One frozen flagged row offered to the agent, read in its marketplace's money.
marketplacerequiredAmazonMarketplace
currencyrequiredCurrency
anchorDayrequiredstring
rowrequiredAdsAdviceRow
AdsRowDetail5
One flagged row with its AI review and the money context it is read in.
marketplacerequiredAmazonMarketplace
currencyrequiredCurrency
anchorDayrequiredstring
rowrequiredAdsAdviceRow
reviewoptionalAdsRowReview | null
AdsRowFieldEvidenceRef4
Cite one typed non-metric source fact of the reviewed row.
kindoptionalstring
values: row_field
default: "row_field"
rowKeyrequiredstring
fieldrequiredAdsEvidenceField
rolerequiredAdsEvidenceRole
AdsRowOneClick3
Join one shown advice row to its change row, or state why it is read-only.
rowKeyrequiredstring
changeRowKeyrequiredstring | null
readOnlyrequiredAdsReadOnlyReason | null
AdsRowQuery3
Ask for one flagged row of one marketplace and its AI review.
objectoptionalstring
values: ads_row
default: "ads_row"
marketplacerequiredAmazonMarketplace
rowKeyrequiredstring
AdsRowReview6
One AI decision for one flagged row; the audit answer carries exactly these fields.
rowKeyrequiredstring
actionrequiredAdsAdviceAction
reasonrequiredstring
reasoningoptionalAdsReasoning | null
evidenceRefsoptionalAdsMetricEvidenceRef[] | AdsRowFieldEvidenceRef[]
default: []
suggestedChangeoptionalRelativeTargetBidChange | AbsoluteTargetBidValue | SetDailyBudgetValue | AddNegativeKeywordValue | null
AdsTriggerCodevalues · 6
Deterministic screen signals (ELTA1 TodoTriggerCode).
values: SPEND_SPIKEZERO_ORDER_SPENDACOS_ABOVE_TARGETHARVEST_SEARCH_TERMSCALE_WINNERBUDGET_CAPPED
AdsWindowCompleteness5
Whether each comparison window of one marketplace is fully synced.
latestDayrequiredboolean
previousDayrequiredboolean
sameWeekdayLastWeekrequiredboolean
last7Daysrequiredboolean
prior7Daysrequiredboolean
AdsWindowMetrics6
Public metric bases and ACoS of one comparison window (ELTA1 DailyTodoWindowMetrics).
impressionsoptionalnumber | string | null
clicksoptionalnumber | string | null
spendoptionalnumber | string | null
ordersoptionalnumber | string | null
salesoptionalnumber | string | null
acosPctoptionalnumber | string | null
AlertCreate4
Immutable SYSTEM-only alert intent with an optional host-defined remedy.
kindoptionalstring
values: ALERT
default: "ALERT"
contentrequiredItemContent
keyoptionalstring | null
actionoptionalItemAction | null
AlertItem11
Source alert with immutable creation and source-confirmed clear state.
idrequiredstring
ownerrequiredOwnerRef
currentrequiredItemContent
created_atrequiredstring
revisionrequiredinteger
created_byoptionalActorRef | null
kindoptionalstring
values: ALERT
default: "ALERT"
objectoptionalstring
values: alert_item
default: "alert_item"
creationrequiredAlertCreate
statusrequiredAlertStatus
resolved_byoptionalActorRef | null
AlertStatusvalues · 2
An alert is cleared only after its source confirms recovery.
values: OPENCLEARED
AlignField2
Override value: a text layer's alignment.
fieldoptionalstring
values: ALIGN
default: "ALIGN"
alignrequiredTextAlign
AmazonMarketplacevalues · 13
values: USCAMXJPUKDEESFRITNLSEPLBE
AmzProfitCalculateRequest4
One product's cost and shipping observations for the profit calculator.
costProfilerequiredCostProfile
shippingProfilerequiredShippingProfile
shippingModeoptionalShippingMode
default: "FREIGHT"
isPeakPeriodoptionalboolean
default: false
Analysis7
Optional bounded analyzed facts (relations, unlinked mentions, concepts, trend features) attached to one typed node hit.
recordKeyrequiredstring
Analyzed record key these facts belong to.
versionrequiredinteger
Version of the analyzed record these facts were read from.
observedAtrequiredstring | null
When these facts were observed; null when unknown.
relationsoptionalRelationRef[]
Typed relations attached to the record.
default: []
unlinkedMentionsoptionalUnlinkedMention[]
Claims of the record that name an entity no held record matched; at most 16.
default: []
conceptsoptionalConceptRef[]
Concepts extracted for the record.
default: []
featuresoptionalFeatureValue[]
Windowed feature values for the record.
default: []
AnalyzedRecordKindvalues · 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 (D16): 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.
values: NODEIDEACONCEPTRELATIONTREND
AnalyzedRelationKindvalues · 13
Every relation row the platform may write: subject --kind--> object.
values: VARIANT_OFBRANDED_BYSOLD_BYPUBLISHED_BYBELONGS_TO_CATEGORYSAME_PRODUCT_ASFEATURES_PRODUCTFEATURES_BRANDRANKED_FORMEMBER_OF_MOTIFPROMOTESSAME_CREATOR_ASCOMPETES_WITH
AnswerLanguagevalues · 2
Language of seller-facing clarification and refusal wording (RS-12).
values: ZHEN
ApplyTemplate4
Replace a design's layers with a template's, filling its placeholders (the one template path).
actionoptionalstring
values: APPLY_TEMPLATE
default: "APPLY_TEMPLATE"
designIdrequiredstring
templaterequiredstring
values: amazon.aplus.header.headlineamazon.main.packshotamazon.secondary.lifestyleamazon.secondary.three_calloutsshopify.blog_featured.headlineshopify.product.bold_dropshopify.product.packshot
fillsoptionalTextFill[] | ImageFill[]
default: []
ApprovalCreate7
Immutable SYSTEM-written proposal intent, verified proposer and expiry.
kindoptionalstring
values: APPROVAL
default: "APPROVAL"
contentrequiredItemContent
keyrequiredstring
proposalrequiredProposalRef
requested_byoptionalActorRef | null
expires_atoptionalstring | null
refoptionalstring | null
ApprovalDecideRequest2
The gateway request carrying one item id and one human decision.
itemIdrequiredstring
decisionrequiredApprovalDecision
ApprovalDecisionvalues · 2
The two decisions a verified human or API-key actor may make.
values: APPROVEREJECT
ApprovalItem11
Proposal-bound decision whose source reference cannot be edited.
idrequiredstring
ownerrequiredOwnerRef
currentrequiredItemContent
created_atrequiredstring
revisionrequiredinteger
created_byoptionalActorRef | null
kindoptionalstring
values: APPROVAL
default: "APPROVAL"
objectoptionalstring
values: approval_item
default: "approval_item"
creationrequiredApprovalCreate
statusrequiredTodoApprovalStatus
decided_byoptionalActorRef | null
ApprovalState4
The live read of one filed item: inbox status and ELTA's current view.
inboxItemIdrequiredstring
statusrequiredArtifectHostApprovalStatus
withdrawnoptionalboolean
default: false
proposalrequiredProposalView
ApprovalView2
The inbox item and ELTA's current proposal state shown to a person.
itemrequiredApprovalItem
proposalrequiredProposalView
ApprovalViewRequest2
Select an approval by its existing item id or ELTA proposal id.
itemIdoptionalstring | null
Existing owner-scoped inbox item id.
proposalIdoptionalstring | null
ELTA proposal id resolved through its owner-scoped inbox key.
ArtifectAccountRequired2
The create answer when the store has several accounts and none was chosen.
objectoptionalstring
values: artifect_account_required
default: "artifect_account_required"
accountChoicesrequiredAccountChoice[]
ArtifectAdjust3
Carry one post-completion adjustment against a committed revision.
baseRevisionrequiredinteger
replayKeyrequiredstring
adjustmentrequiredProfitInputsAdjustment | 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.
refrequiredArtifectRef
adjustrequiredArtifectAdjust
ArtifectAdjustmentStatus8
Project one admitted adjustment or queued model work on the same run.
adjustmentRefrequiredstring
Opaque child-task or same-run queued-work locator.
stagerequiredTaskStage
Adjustment or queued-work execution stage.
targetRevisionrequiredinteger
Revision the edit publishes or queued work updates.
failureCodeoptionalstring | null
Stable child failure refinement code while failed, when available.
failureReasonoptionalstring | null
Sanitized child failure sentence while failed.
failureTypeoptionalTaskExceptionType | null
Child's keble-task failure class, set only while stage is FAILURE.
updatedAtrequiredstring
Projection instant of this row.
recheckHintoptionalArtifectRecheckHint | 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.
kindoptionalstring
values: AMZ_ADS_ADVICE
default: "AMZ_ADS_ADVICE"
replayKeyrequiredstring
storeIdrequiredstring
anchorDayoptionalstring | null
Requested data day; null means yesterday in UTC; a later day is refused before any source is read.
languageoptionalLanguage | null
ArtifectAdsAdviceDetail2
Carry one marketplace's advice or one row's detail from the stored run.
kindoptionalstring
values: AMZ_ADS_ADVICE
default: "AMZ_ADS_ADVICE"
answerrequiredAdsMarketplaceAdvice | AdsRowDetail
ArtifectAdsAdviceDetailQuery2
Wrap the ads-advice detail query (owned by ads_advice).
kindoptionalstring
values: AMZ_ADS_ADVICE
default: "AMZ_ADS_ADVICE"
queryrequiredAdsMarketplaceQuery | AdsRowQuery
ArtifectAdsAdviceRemove3
Remove advice rows in one marketplace, including manual-only advice.
adjustmentTypeoptionalstring
values: ADS_ADVICE_REMOVE
default: "ADS_ADVICE_REMOVE"
marketplacerequiredAmazonMarketplace
rowKeysrequiredstring[]
ArtifectAdsAdviceSnapshot8
Expose one completed Ads optimization-suggestions run, per marketplace.
kindoptionalstring
values: AMZ_ADS_ADVICE
default: "AMZ_ADS_ADVICE"
storeIdrequiredstring
createdAtrequiredstring
requestedAnchorDayoptionalstring | null
marketplacesoptionalAdsMarketplaceAdvice[]
default: []
changeListsoptionalArtifectAdsChangeListLink[]
default: []
changeListAbsencesoptionalArtifectAdsChangeListAbsence[]
default: []
unsupportedMarketplacesoptionalstring[]
default: []
ArtifectAdsChangeListAbsence2
Say why one marketplace that shows advice has no AMZ_ADS_CHANGES list.
marketplacerequiredAmazonMarketplace
reasonrequiredAdsChangeListAbsenceReason
ArtifectAdsRowAuditInputPage10
Input page for ADS_ROW_AUDIT: one page of flagged Ads rows to audit.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
inputKeyrequiredstring
ownerRevisionrequiredinteger
instructionsrequiredstring
itemsoptionalAdsRowAuditItem[]
default: []
coveredItemCountrequiredinteger
itemCountrequiredinteger
nextCursoroptionalstring | null
deadlinerequiredstring
decisionTypeoptionalstring
values: ADS_ROW_AUDIT
default: "ADS_ROW_AUDIT"
ArtifectAmzListingCreate2
Create one owner-fenced new Amazon listing draft from the kind's own ListingCreate.
kindoptionalstring
values: AMZ_LISTING
default: "AMZ_LISTING"
requestrequiredListingCreate
ArtifectAmzListingEdit2
Replace an AMZ_LISTING draft's whole content (editor or agent edit).
adjustmentTypeoptionalstring
values: AMZ_LISTING_EDIT
default: "AMZ_LISTING_EDIT"
contentrequiredListingContent
ArtifectAmzListingPropose1
File the draft's one ADD for approval at the envelope's base_revision.
adjustmentTypeoptionalstring
values: AMZ_LISTING_PROPOSE
default: "AMZ_LISTING_PROPOSE"
ArtifectAmzListingProposeRevert1
File the undo (seller-SKU removal) of a LISTED draft at the envelope's base_revision.
adjustmentTypeoptionalstring
values: AMZ_LISTING_PROPOSE_REVERT
default: "AMZ_LISTING_PROPOSE_REVERT"
ArtifectAmzListingSnapshot2
Carry the listing core's current ListingSnapshot under its kind tag.
kindoptionalstring
values: AMZ_LISTING
default: "AMZ_LISTING"
snapshotrequiredListingSnapshot
ArtifectAnswer4
Carry one validated decision fragment for a parked Artifect.
inputKeyrequiredstring
expectedRevisionrequiredinteger
replayKeyrequiredstring
decisionrequiredReportScopeAnswer | SampleRelevanceAnswer | MaterialFactsAnswer | StandoutSelectionAnswer | ReportJudgmentAnswer | ArtifectPositioningStepDecision | AdsRowAuditAnswer | ArtifectShopifyBlogPostsStepDecision | ArtifectMonitorSetupAnswer | ArtifectMonitorConfirmAnswer
ArtifectAnswerRequest2
Which run, and the typed decision fragment (own input key, revision and replay_key).
refrequiredArtifectRef
answerrequiredArtifectAnswer
ArtifectChangeListCreate2
Carry one account-free change-list create premise to its configured host.
kindrequiredstring
values: AMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGES
requestrequiredChangeListCreatePremise
ArtifectChangeListEdit2
Submit the shared engine's typed edit operations through artifect_adjust.
adjustmentTypeoptionalstring
values: CHANGE_LIST_EDIT
default: "CHANGE_LIST_EDIT"
opsrequiredAddRows[] | EditRow[] | DiscardRow[] | RestoreRow[]
ArtifectChangeListPropose2
Ask the shared engine to file selected rows; empty selects every eligible row.
adjustmentTypeoptionalstring
values: CHANGE_LIST_PROPOSE
default: "CHANGE_LIST_PROPOSE"
rowKeysoptionalstring[]
default: []
ArtifectChangeListProposeRevert2
Ask the engine to revert selected applied rows; empty selects all eligible rows.
adjustmentTypeoptionalstring
values: CHANGE_LIST_PROPOSE_REVERT
default: "CHANGE_LIST_PROPOSE_REVERT"
rowKeysoptionalstring[]
default: []
ArtifectChangeListSnapshot2
Carry the engine's canonical current change-list snapshot under its kind tag.
kindoptionalstring
values: AMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGESAMZ_MCF_ORDER
default: "AMZ_LISTING_CHANGES"
snapshotrequiredChangeListSnapshot
ArtifectDecisionRejection8
Report one typed refusal without failing the Artifect run.
objectoptionalstring
values: artifect_rejection
default: "artifect_rejection"
inputKeyoptionalstring | null
reasonrequiredArtifectRejectionReason
pendingInputKeyoptionalstring | null
currentRevisionoptionalinteger | null
itemKeysoptionalstring[] | null
messageoptionalstring | null
kindCodeoptionalstring | null
ArtifectDescribeRequest1
Which kind's request bodies to describe (A-03).
kindrequiredstring
Identify the workflow family handled by an Artifect runtime.
values: AMZ_PRODUCT_REPORTPOSITIONINGAMZ_ADS_ADVICESHOPIFY_THEME_UPDATEAMZ_LISTING_CHANGESSHOPIFY_ARTICLE_CHANGESSHOPIFY_SEO_CHANGESSHOPIFY_GEO_CHANGESAMZ_ADS_CHANGESSHOPIFY_BLOG_POSTSSHOPIFY_PRODUCTAMZ_LISTING
ArtifectDetail4
One typed detail answer about one artifect.
objectoptionalstring
values: artifect_detail
default: "artifect_detail"
refrequiredArtifectRef
payloadrequiredArtifectReportDetail | ArtifectPositioningDetail | ArtifectAdsAdviceDetail | ArtifectProductImagesDetail | ArtifectShopifyThemeRunDetail | ArtifectMonitorDetail | ArtifectOccurrences
capturedAtrequiredstring
ArtifectDetailRequest2
Address one artifect and ask it one kind-typed detail question.
refrequiredArtifectRef
queryrequiredArtifectReportDetailQuery | ArtifectPositioningDetailQuery | ArtifectAdsAdviceDetailQuery | ArtifectProductImagesDetailQuery | ArtifectShopifyThemeQuery | ArtifectMonitorDetailQuery | ArtifectOccurrencesQuery
ArtifectFailure4
The provider-free failure one customer answer may carry.
objectoptionalstring
values: artifect_failure
default: "artifect_failure"
coderequiredArtifectFailureCode
retryablerequiredboolean
messagerequiredstring
ArtifectFailureCodevalues · 7
Classify one sanitized failure a customer may see for an Artifect run.
values: NOT_FOUNDINVALID_REQUESTCONFLICTRATE_LIMITEDQUOTA_EXHAUSTEDUNAVAILABLEINTERNAL
ArtifectFbaInboundPlanSnapshot9
Expose one FBA inbound plan: its stage, the agent's next step and the live approvals.
kindoptionalstring
values: AMZ_FBA_INBOUND_PLAN
default: "AMZ_FBA_INBOUND_PLAN"
storeIdrequiredstring
stagerequiredFbaInboundStage
guiderequiredstring
planoptionalEntityRef | null
planStatusoptionalFbaInboundPlanStatus | null
createoptionalApprovalState | null
packingoptionalApprovalState | null
revertoptionalApprovalState | null
ArtifectFbaInboundProposePacking2
File the boxes on the created plan with ELTA's SetFbaInboundPacking change.
adjustmentTypeoptionalstring
values: AMZ_FBA_INBOUND_PLAN_PROPOSE_PACKING
default: "AMZ_FBA_INBOUND_PLAN_PROPOSE_PACKING"
changerequiredobject
ArtifectFbaInboundProposePlan2
Re-file the plan with an edited ELTA CreateFbaInboundPlan change.
adjustmentTypeoptionalstring
values: AMZ_FBA_INBOUND_PLAN_PROPOSE_PLAN
default: "AMZ_FBA_INBOUND_PLAN_PROPOSE_PLAN"
changerequiredobject
ArtifectFbaInboundProposeRevert1
File ELTA's undo of the newest applied proposal; undo cancels the whole plan.
adjustmentTypeoptionalstring
values: AMZ_FBA_INBOUND_PLAN_PROPOSE_REVERT
default: "AMZ_FBA_INBOUND_PLAN_PROPOSE_REVERT"
ArtifectInputRequest4
One page of the input a parked run offers.
refrequiredArtifectRef
inputKeyrequiredstring
cursoroptionalstring | null
maxItemsoptionalinteger | null
ArtifectJudgmentInputPage16
Input page for JUDGMENT: the conclusion question and its citable evidence.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
inputKeyrequiredstring
ownerRevisionrequiredinteger
instructionsrequiredstring
itemsoptionalReportJudgmentEvidenceItem[]
Citable accepted artifacts.
default: []
coveredItemCountrequiredinteger
itemCountrequiredinteger
nextCursoroptionalstring | null
deadlinerequiredstring
decisionTypeoptionalstring
values: JUDGMENT
default: "JUDGMENT"
languagerequiredLanguage
Reader language of every text.
verdictOpenrequiredboolean
False: a policy pre-check already fixed the verdict.
fixedReasonCodeoptionalReportReasonCode | null
Set iff the verdict is not open.
materialInputUnresolvedAdmissiblerequiredboolean
Whether MATERIAL_INPUT_UNRESOLVED may be the reason.
ruleLinesoptionalstring[]
Policy rules the verdict must follow.
default: []
sectionKindsrequiredReportNarrativeSectionKind[]
The section slots to write, once each.
ArtifectKindvalues · 16
Identify the workflow family handled by an Artifect runtime.
values: 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.
kindrequiredArtifectKind
labelrequiredstring
purposerequiredstring
requestSchemarequiredobject
ArtifectMaterialFactsInputPage10
Input page for MATERIAL_FACTS: every open material question.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
inputKeyrequiredstring
ownerRevisionrequiredinteger
instructionsrequiredstring
itemsoptionalReportMaterialQuestion[]
default: []
coveredItemCountrequiredinteger
itemCountrequiredinteger
nextCursoroptionalstring | null
deadlinerequiredstring
decisionTypeoptionalstring
values: MATERIAL_FACTS
default: "MATERIAL_FACTS"
ArtifectMonitorAdjust2
Edit a monitor's watches, schedule or delivery at the status's revision (0.25.0).
adjustmentTypeoptionalstring
values: MONITOR_ADJUST
default: "MONITOR_ADJUST"
commandrequiredMonitorSetWatches | MonitorSetCadence | MonitorSetDelivery
ArtifectMonitorConfirmAnswer1
Confirm a MONITOR draft's spec at the answer's expected_revision (its spec revision, 0.25.0).
decisionTypeoptionalstring
values: MONITOR_CONFIRM
default: "MONITOR_CONFIRM"
ArtifectMonitorConfirmInputPage7
The MONITOR confirm page (0.25.0): "What we'll monitor" for the person to confirm.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
decisionTypeoptionalstring
values: MONITOR_CONFIRM
default: "MONITOR_CONFIRM"
inputKeyrequiredstring
ownerRevisionrequiredinteger
deadlinerequiredstring
nextCursoroptionalnull
pagerequiredMonitorConfirmPage
ArtifectMonitorDecisionTypevalues · 2
The two inputs a MONITOR draft parks on (0.25.0): setup, then the person's confirm.
values: MONITOR_SETUPMONITOR_CONFIRM
ArtifectMonitorDetail4
One monitor check in full (0.25.0), the answer to ArtifectMonitorDetailQuery.
kindoptionalstring
values: MONITOR
default: "MONITOR"
cyclerequiredMonitorCycle
findingsoptionalMonitorFinding[]
default: []
nextAfteroptionalMonitorFindingKey | null
ArtifectMonitorDetailQuery4
Open one monitor check in full (0.25.0): its coverage, deliveries and one findings page.
kindoptionalstring
values: MONITOR
default: "MONITOR"
cycleSeqrequiredinteger
afteroptionalMonitorFindingKey | null
limitrequiredinteger
ArtifectMonitorSetupAnswer4
Answer a MONITOR draft's setup: the watches, the schedule and the delivery channels (0.25.0).
decisionTypeoptionalstring
values: MONITOR_SETUP
default: "MONITOR_SETUP"
watchesrequiredMonitorWatchRequest[]
cadencerequiredMonitorCadence
deliveryoptionalMonitorDelivery
default: {"chat":true,"email":false}
ArtifectMonitorSetupInputPage7
The MONITOR setup page (0.25.0): the core-rendered capability offers and the cadence floor.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
decisionTypeoptionalstring
values: MONITOR_SETUP
default: "MONITOR_SETUP"
inputKeyrequiredstring
ownerRevisionrequiredinteger
deadlinerequiredstring
nextCursoroptionalnull
pagerequiredMonitorSetupPage
ArtifectMonitorSnapshot2
A MONITOR's snapshot (0.25.0): the monitor, its open cycle and its newest finished one.
kindoptionalstring
values: MONITOR
default: "MONITOR"
snapshotrequiredMonitorSnapshot
ArtifectOccurrence5
One scheduled occurrence (a monitor's check), as every standing kind shows it.
seqrequiredinteger
staterequiredArtifectOccurrenceState
dueAtrequiredstring
finishedAtrequiredstring | null
newCountrequiredinteger
ArtifectOccurrenceStatevalues · 5
Where one scheduled occurrence is; RUNNING is open, the other four are finished.
values: RUNNINGREPORTEDQUIETSKIPPEDFAILED
ArtifectOccurrences2
The answer to ArtifectOccurrencesQuery: one page of occurrences, newest first.
itemsrequiredArtifectOccurrence[]
morerequiredboolean
ArtifectOccurrencesQuery4
List a standing artifect's occurrences (a monitor's checks), newest first.
queryrequiredstring
values: OCCURRENCES
beforeSeqoptionalinteger | null
limitrequiredinteger
kindoptionalstring | null
ArtifectPendingInput5
Summarize the one request a WAITING_FOR_INPUT Artifect is parked on.
inputKeyrequiredstring
decisionTyperequiredReportDecisionType | ArtifectPositioningDecisionType | AdsDecisionType | ArtifectShopifyBlogPostsDecisionType | ArtifectMonitorDecisionType
itemCountrequiredinteger
coveredItemCountrequiredinteger
deadlinerequiredstring
ArtifectPositioningAdjustment2
Post-completion positioning edits applied literally, without a rerun.
adjustmentTypeoptionalstring
values: POSITIONING_EDITS
default: "POSITIONING_EDITS"
editsrequiredSetSetup[] | 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.
kindoptionalstring
values: POSITIONING
default: "POSITIONING"
replayKeyrequiredstring
positioningContextrequiredstring
pluginIdoptionalstring | null
Installed plugin ID; omit for the host default. Setup must match this plugin's declaration.
setupoptionalobject | null
Values for the selected plugin's declared setup fields; omitted fields are proposed at SCOPE.
languageoptionalLanguage | null
ArtifectPositioningDecisionTypevalues · 1
The one positioning answer family: a waiting run step's reviewed result.
values: POSITIONING_STEP
ArtifectPositioningDetail2
Carry positioning's own answered detail and the labels its answer uses.
kindoptionalstring
values: POSITIONING
default: "POSITIONING"
answerrequiredPositioningDetail
ArtifectPositioningDetailQuery2
Wrap the POSITIONING package's own detail query for one positioning.
kindoptionalstring
values: POSITIONING
default: "POSITIONING"
queryrequiredPositioningCellQuery | PositioningItemsQuery
ArtifectPositioningSnapshot3
Expose one committed POSITIONING revision through customer projections.
kindoptionalstring
values: POSITIONING
default: "POSITIONING"
roomrequiredRoomPublicRead
decisionrequiredRoomPublicDecisionRead
ArtifectPositioningStepCell2
One assessed cell the waiting step produced (the ASSESS review).
resultTypeoptionalstring
values: CELL
default: "CELL"
cellrequiredRoomCell
ArtifectPositioningStepDecision3
Answer a waiting positioning step: apply these edits, then continue.
decisionTypeoptionalstring
values: POSITIONING_STEP
default: "POSITIONING_STEP"
steprequiredRunStep
editsoptionalSetSetup[] | AddItems[] | UpdateItems[] | RemoveItems[] | SaveDimension[] | DeleteDimension[] | SetPlacements[] | SaveCriterion[] | DeleteCriterion[] | SetResults[] | SaveView[] | DeleteView[] | ReorderViews[] | Continue[] | SetReview[] | Cancel[] | Propose[] | Classify[] | Assess[] | Score[] | Decide[]
default: []
ArtifectPositioningStepInputPage8
One waiting positioning step and the result its agent reviews.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
decisionTypeoptionalstring
values: POSITIONING_STEP
default: "POSITIONING_STEP"
inputKeyrequiredstring
steprequiredRunStep
runrequiredRunRead
resultsoptionalArtifectPositioningStepItem[] | ArtifectPositioningStepCell[]
default: []
nextCursoroptionalstring | null
deadlinerequiredstring
ArtifectPositioningStepItem2
One sourced or placed item the waiting step produced (the SOURCE/PLACE review).
resultTypeoptionalstring
values: ITEM
default: "ITEM"
itemrequiredItemRead
ArtifectProductImagesDetail3
Carry the board's EXPORTS view and ephemeral links for its newest export.
kindoptionalstring
values: PRODUCT_IMAGES
default: "PRODUCT_IMAGES"
exportsoptionalExportSet[]
default: []
newestUrlsoptionalHostedImage[]
default: []
ArtifectProductImagesDetailQuery2
Ask one image set one detail view.
kindoptionalstring
values: PRODUCT_IMAGES
default: "PRODUCT_IMAGES"
viewrequiredProductImagesDetailView
ArtifectProductImagesEdit3
Edit or quote one board using the image contract's own action batch.
adjustmentTypeoptionalstring
values: PRODUCT_IMAGES_EDIT
default: "PRODUCT_IMAGES_EDIT"
actionsrequiredAddDesign[] | 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[]
dryRunoptionalboolean
default: false
ArtifectProductImagesExport3
Export one revision of an image set (head when revision is None).
adjustmentTypeoptionalstring
values: PRODUCT_IMAGES_EXPORT
default: "PRODUCT_IMAGES_EXPORT"
revisionoptionalinteger | null
optionsoptionalExportOptions
ArtifectProductImagesQuote2
The no-write quote returned only by a product-images dry-run adjustment.
objectoptionalstring
values: artifect_quote
default: "artifect_quote"
quoterequiredBatchQuote
ArtifectProductImagesSnapshot2
Expose the image contract's canonical multi-object board outline.
kindoptionalstring
values: PRODUCT_IMAGES
default: "PRODUCT_IMAGES"
outlinerequiredDocumentOutline
ArtifectRecheckHint2
Tell the agent which snapshot parts moved and how to recheck them.
partKeysrequiredstring[]
Affected snapshot parts using the owning kind's existing stable keys, converted by its adapter. Never displayed.
messagerequiredstring
Owner-authored, number-free recheck sentence shown to the reader.
ArtifectRef2
Identify one durable Artifect instance by its opaque public id.
objectoptionalstring
values: artifect_ref
default: "artifect_ref"
idrequiredstring
ArtifectRejectionReasonvalues · 11
Why an answer or adjustment was refused with state left unchanged.
values: 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.
kindoptionalstring
values: AMZ_PRODUCT_REPORT
default: "AMZ_PRODUCT_REPORT"
replayKeyrequiredstring
asinrequiredstring
amazonMarketplacerequiredAmazonMarketplace
keywordsoptionalstring[]
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.
default: []
categoryIdoptionalinteger | null
Confirmed Amazon category; with at least one nonblank keyword it skips REPORT_SCOPE.
titleoptionalstring | null
imageoptionalstring | null
languageoptionalLanguage | null
similarProductsLimitoptionalinteger | null
How many comparable products to analyse; None keeps the runtime's website-aligned default.
economicSetupoptionalReportProfileEconomicFields | 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.
purchaseCostrequiredArtifectReportUserPurchaseCost | 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.
kindoptionalstring
values: AMZ_PRODUCT_REPORT
default: "AMZ_PRODUCT_REPORT"
answerrequiredReportV3OverviewToolResult | ReportV3ListingsToolResult | ReportV3ListingDetailToolResult | ReportV3SectionToolResult | ReportV3ConclusionToolResult | ReportV3LifecycleToolResult | ReportV3EstimationToolResult | ReportV3JudgmentToolResult
ArtifectReportDetailQuery2
Wrap the REPORT package's own detail query for one report artifect.
kindoptionalstring
values: AMZ_PRODUCT_REPORT
default: "AMZ_PRODUCT_REPORT"
queryrequiredReportOverviewQuery | ReportListingsQuery | ReportListingQuery | ReportSectionQuery | ReportEvidenceQuery | ReportJudgmentQuery
ArtifectReportScopeInputPage10
Input page for REPORT_SCOPE: the offered category candidates.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
inputKeyrequiredstring
ownerRevisionrequiredinteger
instructionsrequiredstring
itemsoptionalReportScopeCandidate[]
default: []
coveredItemCountrequiredinteger
itemCountrequiredinteger
nextCursoroptionalstring | null
deadlinerequiredstring
decisionTypeoptionalstring
values: REPORT_SCOPE
default: "REPORT_SCOPE"
ArtifectReportSnapshot2
Expose one immutable progressive REPORT snapshot from report CRUD.
kindoptionalstring
values: AMZ_PRODUCT_REPORT
default: "AMZ_PRODUCT_REPORT"
payloadrequiredProgressiveReportSnapshot
ArtifectReportSystemEstimatedPurchaseCost2
Carry the seller's explicit agreement to let Keble estimate the cost.
sourceoptionalstring
values: SYSTEM_ESTIMATED
default: "SYSTEM_ESTIMATED"
sellerAgreedrequiredboolean
The seller agreed to use Keble's estimate; must be true. A create never assumes this agreement.
values: true
ArtifectReportUserPurchaseCost3
Carry the seller's own purchasing cost, as one value or a low/high range.
sourceoptionalstring
values: USER_SUPPLIED
default: "USER_SUPPLIED"
valuerequiredMinorUnitMoney
The seller's own per-unit purchasing cost.
upperBoundoptionalMinorUnitMoney | null
Range upper bound; omit it for a single value. When present it must use the same currency as value and be >= value.
ArtifectRunItem10
One run the caller's owner started, from any starter (web, agent, MCP).
refrequiredArtifectRef
kindrequiredArtifectKind
stagerequiredTaskStage
failureTypeoptionalTaskExceptionType | null
Task failure class, set only while the run has failed.
failureCodeoptionalstring | null
Stable failure refinement code for classification only; user interfaces map it to copy.
titlerequiredstring | null
storeIdrequiredstring | null
anchorDayrequiredstring | null
createdAtrequiredstring
completedAtoptionalstring | null
When the run's task reached SUCCESS or FAILURE (its success_ts/failure_ts); null otherwise.
ArtifectRunList3
One newest-first page; next_before is set only when an older run exists.
objectoptionalstring
values: artifect_run_list
default: "artifect_run_list"
runsrequiredArtifectRunItem[]
nextBeforeoptionalstring | null
ArtifectRunsRequest4
Which of the caller's own Artifect runs to list, newest first.
kindoptionalArtifectKind | null
storeIdoptionalstring | null
limitoptionalinteger
default: 5
beforeoptionalstring | null
ArtifectSampleRelevanceInputPage10
Input page for SAMPLE_RELEVANCE: one page of frozen candidates.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
inputKeyrequiredstring
ownerRevisionrequiredinteger
instructionsrequiredstring
itemsoptionalSampleRelevanceItem[]
default: []
coveredItemCountrequiredinteger
itemCountrequiredinteger
nextCursoroptionalstring | null
deadlinerequiredstring
decisionTypeoptionalstring
values: SAMPLE_RELEVANCE
default: "SAMPLE_RELEVANCE"
ArtifectShopifyBlogPostsCreate2
Create one guided Shopify blog post set from the kind's own BlogCreate.
kindoptionalstring
values: SHOPIFY_BLOG_POSTS
default: "SHOPIFY_BLOG_POSTS"
requestrequiredBlogCreate
ArtifectShopifyBlogPostsDecisionTypevalues · 1
The one blog-posts answer family: the parked guided step's answer.
values: SHOPIFY_BLOG_POSTS_STEP
ArtifectShopifyBlogPostsEdits2
Edit a READY blog post set before create-all: replace or drop posts.
adjustmentTypeoptionalstring
values: SHOPIFY_BLOG_POSTS_EDITS
default: "SHOPIFY_BLOG_POSTS_EDITS"
editsrequiredReplacePost[] | DropPost[]
ArtifectShopifyBlogPostsPropose1
File create-all for the READY post set at the envelope's base_revision.
adjustmentTypeoptionalstring
values: SHOPIFY_BLOG_POSTS_PROPOSE
default: "SHOPIFY_BLOG_POSTS_PROPOSE"
ArtifectShopifyBlogPostsProposeRevert1
File revert-all of the applied create-all's still-live articles at base_revision.
adjustmentTypeoptionalstring
values: SHOPIFY_BLOG_POSTS_PROPOSE_REVERT
default: "SHOPIFY_BLOG_POSTS_PROPOSE_REVERT"
ArtifectShopifyBlogPostsSnapshot2
Carry the blog-posts kind's revisioned BlogSnapshot under its kind tag, minus its staged batch.
kindoptionalstring
values: SHOPIFY_BLOG_POSTS
default: "SHOPIFY_BLOG_POSTS"
snapshotrequiredBlogSnapshot
ArtifectShopifyBlogPostsStepDecision2
Answer the parked guided blog step with that step's own answer model.
decisionTypeoptionalstring
values: SHOPIFY_BLOG_POSTS_STEP
default: "SHOPIFY_BLOG_POSTS_STEP"
answerrequiredBlogDirection | PostPlan | StyleExamples | PostDraft | PostSelfReview | SampleConfirmation
ArtifectShopifyBlogPostsStepInputPage11
Input page of the parked guided blog step: its guidance and the posts still uncovered.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
inputKeyrequiredstring
ownerRevisionrequiredinteger
instructionsrequiredstring
itemsoptionalPlannedPost[]
default: []
coveredItemCountrequiredinteger
itemCountrequiredinteger
nextCursoroptionalstring | null
deadlinerequiredstring
decisionTypeoptionalstring
values: SHOPIFY_BLOG_POSTS_STEP
default: "SHOPIFY_BLOG_POSTS_STEP"
steprequiredBlogStep
ArtifectShopifyProductCreate2
Create one unpublished Shopify product draft from the kind's ProductCreateRequest.
kindoptionalstring
values: SHOPIFY_PRODUCT
default: "SHOPIFY_PRODUCT"
requestrequiredProductCreateRequest
ArtifectShopifyProductEdit2
Replace a Shopify product draft's whole content (pane or agent edit).
adjustmentTypeoptionalstring
values: SHOPIFY_PRODUCT_EDIT
default: "SHOPIFY_PRODUCT_EDIT"
contentrequiredProductContent
ArtifectShopifyProductPropose1
File the draft's one product.create at the envelope's base_revision.
adjustmentTypeoptionalstring
values: SHOPIFY_PRODUCT_PROPOSE
default: "SHOPIFY_PRODUCT_PROPOSE"
ArtifectShopifyProductProposeRevert1
File one product.delete for the run's single live product, at base_revision.
adjustmentTypeoptionalstring
values: SHOPIFY_PRODUCT_PROPOSE_REVERT
default: "SHOPIFY_PRODUCT_PROPOSE_REVERT"
ArtifectShopifyProductSnapshot2
Carry the product kind's revisioned ProductSnapshot under its kind tag, minus its staged batch.
kindoptionalstring
values: SHOPIFY_PRODUCT
default: "SHOPIFY_PRODUCT"
snapshotrequiredProductSnapshot
ArtifectShopifyThemeCreate2
Create one Shopify theme document workspace from the theme contract's document request.
kindoptionalstring
values: SHOPIFY_THEME_UPDATE
default: "SHOPIFY_THEME_UPDATE"
requestrequiredThemeDocumentCreateRequest
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 published with one approval in To do; 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). 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 to discard.); PREVIEW_NOT_READY (Update the preview and wait until the copy shows this revision.); PROPOSAL_PENDING (A request for this step waits in To do; decide it there first.); 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 (ELTA refused a write before filing, so nothing was filed; resolve its reason (FAMILY_OFF: turn on theme edits for the store), then repeat the step.)
ArtifectShopifyThemeDetail3
FROZEN (D-03): carry a legacy run's typed change-set detail unchanged.
kindoptionalstring
values: SHOPIFY_THEME_UPDATE
default: "SHOPIFY_THEME_UPDATE"
changeSetrequiredThemeChangeSet
proposalStatesoptionalThemeProposalStateRead[]
default: []
ArtifectShopifyThemeDetailQuery2
FROZEN (D-03): address one change set of a legacy Shopify theme run for a detail read.
kindoptionalstring
values: SHOPIFY_THEME_UPDATE
default: "SHOPIFY_THEME_UPDATE"
changeSetIdrequiredstring
ArtifectShopifyThemeDiscardPreview1
File the delete of the run's one preview copy (explicit only; abandonment never discards).
adjustmentTypeoptionalstring
values: SHOPIFY_THEME_UPDATE_DISCARD_PREVIEW
default: "SHOPIFY_THEME_UPDATE_DISCARD_PREVIEW"
ArtifectShopifyThemeDocumentDetail3
Carry one detail answer of a theme DOCUMENT run (the report/positioning nested-answer pattern).
kindoptionalstring
values: SHOPIFY_THEME_UPDATE
default: "SHOPIFY_THEME_UPDATE"
runKindoptionalstring
values: DOCUMENT
default: "DOCUMENT"
answerrequiredArtifectShopifyThemeRevisionAnswer | ArtifectShopifyThemeTemplatesAnswer | ArtifectShopifyThemeTemplateOutlineAnswer
ArtifectShopifyThemeDocumentQuery3
Address one detail view of a theme DOCUMENT run (the report/positioning nested-query pattern).
kindoptionalstring
values: SHOPIFY_THEME_UPDATE
default: "SHOPIFY_THEME_UPDATE"
runKindrequiredstring
values: DOCUMENT
queryrequiredArtifectShopifyThemeRevisionQuery | ArtifectShopifyThemeTemplatesQuery | ArtifectShopifyThemeTemplateOutlineQuery
ArtifectShopifyThemeDocumentSnapshot4
Expose a theme DOCUMENT run's snapshot: the theme contract's document snapshot plus live states.
kindoptionalstring
values: SHOPIFY_THEME_UPDATE
default: "SHOPIFY_THEME_UPDATE"
runKindoptionalstring
values: DOCUMENT
default: "DOCUMENT"
snapshotrequiredThemeDocumentSnapshot
proposalStatesoptionalThemeDocumentProposalStateRead[]
default: []
ArtifectShopifyThemeEdit2
Edit one theme document: the theme contract's own typed page actions, applied as one batch.
adjustmentTypeoptionalstring
values: SHOPIFY_THEME_UPDATE_EDIT
default: "SHOPIFY_THEME_UPDATE_EDIT"
actionsrequiredAddPage[] | 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, 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, 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) | 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, 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.
ArtifectShopifyThemeProposeDiscard2
FROZEN (D-03): propose deleting one rejected legacy change set's ELTA-created preview copy.
adjustmentTypeoptionalstring
values: SHOPIFY_THEME_UPDATE_PROPOSE_DISCARD
default: "SHOPIFY_THEME_UPDATE_PROPOSE_DISCARD"
changeSetIdrequiredstring
ArtifectShopifyThemeProposeRevert2
FROZEN (D-03): propose ELTA's undo of one accepted change set of a legacy run.
adjustmentTypeoptionalstring
values: SHOPIFY_THEME_UPDATE_PROPOSE_REVERT
default: "SHOPIFY_THEME_UPDATE_PROPOSE_REVERT"
changeSetIdrequiredstring
ArtifectShopifyThemePublish2
File one publish of a document revision onto the run's target theme.
adjustmentTypeoptionalstring
values: SHOPIFY_THEME_UPDATE_PUBLISH
default: "SHOPIFY_THEME_UPDATE_PUBLISH"
revisionoptionalinteger | null
The revision to publish to the target theme; null publishes the head revision, resolved before filing. A publish always waits for a person in To do. 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. While one publish waits, publishing another revision is refused PROPOSAL_PENDING (publishing the same revision again answers the waiting approval); NOTHING_TO_PROPOSE means the theme already shows that revision.
ArtifectShopifyThemeQueryOne of · 2
One of: ArtifectShopifyThemeDetailQuery | ArtifectShopifyThemeDocumentQuery
ArtifectShopifyThemeRevisionAnswer2
Answer the REVISION view: one committed revision of a theme DOCUMENT run, unchanged.
viewoptionalstring
values: REVISION
default: "REVISION"
revisionrequiredThemeRevision
ArtifectShopifyThemeRevisionQuery2
Ask a theme DOCUMENT run for one committed revision (the REVISION(n) view, ATJ-10).
viewoptionalstring
values: REVISION
default: "REVISION"
revisionrequiredinteger
ArtifectShopifyThemeRunDetailOne of · 2
One of: ArtifectShopifyThemeDetail | ArtifectShopifyThemeDocumentDetail
ArtifectShopifyThemeRunSnapshotOne of · 2
One of: ArtifectShopifyThemeSnapshot | ArtifectShopifyThemeDocumentSnapshot
ArtifectShopifyThemeSnapshot4
FROZEN (D-03): expose a legacy run's snapshot: its create ledger beside the target theme.
kindoptionalstring
values: SHOPIFY_THEME_UPDATE
default: "SHOPIFY_THEME_UPDATE"
ledgerrequiredThemeCreateLedger
targetThemeoptionalThemeRef | null
proposalStatesoptionalThemeProposalStateRead[]
default: []
ArtifectShopifyThemeTemplateOutlineAnswer3
Answer the TEMPLATE_OUTLINE view: one template's merchant entries in order (this run's excluded).
viewoptionalstring
values: TEMPLATE_OUTLINE
default: "TEMPLATE_OUTLINE"
sourcerequiredThemeFrameSource
outlinerequiredThemeTemplateOutline
ArtifectShopifyThemeTemplateOutlineQuery3
Ask a theme DOCUMENT run for one template's merchant entries in order (the locked tree, anchors).
viewoptionalstring
values: TEMPLATE_OUTLINE
default: "TEMPLATE_OUTLINE"
templaterequiredThemeTemplateRef
sourceoptionalThemeFrameSource
default: "TARGET"
ArtifectShopifyThemeTemplatesAnswer3
Answer the TEMPLATES view: the placeable JSON page templates the read theme has now.
viewoptionalstring
values: TEMPLATES
default: "TEMPLATES"
sourcerequiredThemeFrameSource
templatesoptionalThemeTemplateRef[]
default: []
ArtifectShopifyThemeTemplatesQuery2
Ask a theme DOCUMENT run which JSON page templates its target (or copy) has now (the page picker).
viewoptionalstring
values: TEMPLATES
default: "TEMPLATES"
sourceoptionalThemeFrameSource
default: "TARGET"
ArtifectShopifyThemeUpdatePreview1
File one step toward the run's preview copy holding the head revision (G-1: never applied here).
adjustmentTypeoptionalstring
values: SHOPIFY_THEME_UPDATE_UPDATE_PREVIEW
default: "SHOPIFY_THEME_UPDATE_UPDATE_PREVIEW"
ArtifectSnapshot4
Expose one immutable domain snapshot and optional ephemeral image parts.
objectoptionalstring
values: artifect_snapshot
default: "artifect_snapshot"
refrequiredArtifectRef
payloadrequiredArtifectReportSnapshot | ArtifectPositioningSnapshot | ArtifectAdsAdviceSnapshot | ArtifectProductImagesSnapshot | ArtifectShopifyThemeRunSnapshot | ArtifectChangeListSnapshot | ArtifectShopifyBlogPostsSnapshot | ArtifectShopifyProductSnapshot | ArtifectAmzListingSnapshot | ArtifectFbaInboundPlanSnapshot | ArtifectMonitorSnapshot
capturedAtrequiredstring
ArtifectSnapshotRequest3
Which run, which immutable revision (None is the head) and which board objects to focus.
refrequiredArtifectRef
revisionoptionalinteger | null
focusoptionalstring[]
default: []
ArtifectStanding6
The long-lived part of one status (ArtifectStatus.standing); set exactly for STANDING kinds.
staterequiredStandingState
pausedByrequiredStandingPauseBy | null
pauserequiredArtifectStandingPause | null
nextRunAtrequiredstring | null
openOccurrencerequiredArtifectStandingOccurrence | null
lastOccurrencerequiredArtifectStandingOccurrence | null
ArtifectStandingOccurrence2
One occurrence of a standing run as its status shows it: its sequence and where it is.
seqrequiredinteger
staterequiredArtifectOccurrenceState
ArtifectStandingPause2
The stored cause of a standing run's pause by core's gate or by its kind.
coderequiredstring | null
messagerequiredstring
ArtifectStandoutInputPage10
Input page for STANDOUT_SELECTION: the built cohort to choose from.
objectoptionalstring
values: artifect_input_page
default: "artifect_input_page"
inputKeyrequiredstring
ownerRevisionrequiredinteger
instructionsrequiredstring
itemsoptionalStandoutItem[]
default: []
coveredItemCountrequiredinteger
itemCountrequiredinteger
nextCursoroptionalstring | null
deadlinerequiredstring
decisionTypeoptionalstring
values: STANDOUT_SELECTION
default: "STANDOUT_SELECTION"
ArtifectStatus13
Report the lifecycle projection of one Artifect instance.
objectoptionalstring
values: artifect_status
default: "artifect_status"
refrequiredArtifectRef
kindrequiredArtifectKind
stagerequiredTaskStage
revisionrequiredinteger
pendingInputrequiredArtifectPendingInput | null
snapshotRefrequiredstring | null
updatedAtrequiredstring
failureCodeoptionalstring | null
Stable failure refinement code while failed, when available.
failureReasonoptionalstring | null
Host-authored failure sentence, set only while stage is FAILURE.
failureTypeoptionalTaskExceptionType | null
keble-task failure class, set only while stage is FAILURE.
latestAdjustmentoptionalArtifectAdjustmentStatus | null
Latest admitted adjustment's own execution state, or None when the Artifect has never been adjusted.
standingoptionalArtifectStanding | 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.
Assess5
Ask the model to judge cells against assessments or criteria (today's criterion and retry).
typeoptionalstring
values: ASSESS
default: "ASSESS"
actionKeyrequiredstring
assessmentsrequiredstring[]
cellKeysoptionalstring[] | null
missingOnlyoptionalboolean
default: false
AssessmentDetailValue4
An ASSESSMENT detail row: one stored judgement for the cell.
objectoptionalstring
values: assessment_detail_value
default: "assessment_detail_value"
kindoptionalstring
values: ASSESSMENT
default: "ASSESSMENT"
keyrequiredstring
assessmentoptionalAssessmentResult | null
AssessmentDisplayvalues · 2
How an assessment row is drawn; the frontend owns the visuals.
values: TEXTINTERVAL
AssessmentKindvalues · 2
What a model returns for one cell: numeric ranges, or yes/no with reasoning.
values: RANGEFLAG
AssessmentRange2
One numeric range an assessment returns.
labelrequiredstring
unitrequiredLocalizedText
AssessmentResult5
One judgement of one cell: ranges or a flag, with reasoning and references.
statusrequiredValueStatus
rangesoptionalRangeValue[]
default: []
flagoptionalboolean | null
reasoningoptionalstring
default: ""
referencesoptionalSourceReference[]
default: []
AssessmentRow3
A detail row showing one assessment: ranges or flag, its reasoning and references.
kindoptionalstring
values: ASSESSMENT
default: "ASSESSMENT"
assessmentrequiredstring
displayoptionalAssessmentDisplay
default: "TEXT"
AssetOriginvalues · 5
How an asset came to exist (provenance; the fidelity law and check read it).
values: UPLOADCUTOUT_MASKGENERATEDEXPORTREFERENCE
AssetRef6
An immutable, content-addressed image owned by one owner (bytes in object storage).
assetIdrequiredstring
mediaTyperequiredImageMediaType
sizerequiredPixelSize
byteCountrequiredinteger
originrequiredAssetOrigin
contentBoxoptionalBox | null
Attribute2
One declared text column: an identity part, a dimension, or an account attribute.
keyrequiredstring
Text-column identifier; fact queries use its declared row path.
titlerequiredStoreLocalizedText
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.
entityrequiredstring
Stored entity key of the row that changed.
observedAtrequiredstring
Instant the new value became readable.
captureIdrequiredstring
The capture that made the new value readable.
kindoptionalstring
Discriminator marking this as an attribute change.
values: attribute
default: "attribute"
attributeKeyrequiredstring
The declared attribute whose value changed.
oldValueoptionalstring | null
The value before the change; none when there was none.
newValueoptionalstring | null
The value after the change; none when it was removed.
AttributeMatch2
One declared attribute restricted to allowed values: a facts-request view selection.
attributeKeyrequiredstring
The declared family attribute this selection restricts.
valuesrequiredstring[]
Values to match; at least one non-empty value.
Availabilityvalues · 3
What ELTA holds for one account x family x day.
values: AVAILABLEINCOMPLETEUNAVAILABLE
BackgroundField2
Override value: the variant canvas background.
fieldoptionalstring
values: BACKGROUND
default: "BACKGROUND"
backgroundrequiredColor | BrandColorRef
BandedDimension2
A dimension core computes by cutting one numeric fact into bands.
factrequiredstring
labelrequiredLocalizedText
BatchQuote4
What a batch would add and cost: a dry run of the same check and apply code, with no writes.
newObjectsrequiredinteger
paidoptionalOperationQuote[]
default: []
estSecondsrequiredinteger
refusaloptionalEditRefusal | null
BlendField2
Override value: a layer's blend mode (how its pixels mix with what is under it).
fieldoptionalstring
values: BLEND
default: "BLEND"
blendModerequiredBlendMode
BlendModevalues · 6
How a layer mixes with pixels under it inside the same image (D-13, VV-3).
values: NORMALMULTIPLYSCREENOVERLAYSOFT_LIGHTCOLOR
BlockedLane4
One blocked account x dataset lane as served: what is blocked, why, since when.
accountrequiredAccountRef
The provider account whose lane is blocked.
datasetKeyrequiredstring
The dataset whose lane is blocked.
issuerequiredProviderIssue
The typed reason the lane is blocked.
sincerequiredstring
When the lane became blocked.
BlogCreate3
Create one guided post set pinned to one ELTA store; the blog is chosen at DIRECTION.
replayKeyrequiredstring
storeIdrequiredstring
briefrequiredstring
BlogDirection5
DIRECTION (1.1): what the posts are for and how the set is structured, agreed with the seller.
stepoptionalstring
values: DIRECTION
default: "DIRECTION"
blogIdrequiredstring
audiencerequiredstring
goalrequiredstring
structurerequiredstring
BlogSnapshot9
The owner-visible post set at one revision, with its latest screen result and every filing.
artifectRefrequiredArtifectRef
storeIdrequiredstring
accountrequiredAccountRef
revisionrequiredinteger
postSetrequiredPostSet
screeningoptionalScreeningResult | null
proposalsoptionalProposalFiling[]
default: []
filingIntentoptionalStagedProposal | null
approvalsoptionalApprovalState[]
default: []
BlogStepvalues · 6
The guided steps the agent is parked on, in order (owner 1.1-1.6).
values: DIRECTIONPOST_PLANSTYLE_EXAMPLESPOST_DRAFTSSELF_REVIEWSAMPLE_CONFIRMATION
BoardObjectKindvalues · 3
The board object kinds (discriminator of BoardObject).
values: IMAGEPLANBRAND_KIT
BoardPoint2
Top-left of an object on the board, in board pixels (1 board px = 1 design px at zoom 1).
xrequirednumber
yrequirednumber
Box5
A layer's placement in canvas pixels; rotation in degrees around the box centre.
xrequirednumber
yrequirednumber
widthrequirednumber
heightrequirednumber
rotationoptionalnumber
default: 0
BoxField2
Override value: the layer's box.
fieldoptionalstring
values: BOX
default: "BOX"
boxrequiredBox
Brand4
A DP-derived brand label and its existing product count.
kindoptionalstring
Node discriminator; always BRAND.
values: BRAND
default: "BRAND"
keyrequiredstring
The brand's own analyzed key, which is its identity.
namerequiredstring
Brand display name.
productCountrequiredinteger
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.
kindoptionalstring
values: BRAND
default: "BRAND"
valuesrequiredstring[]
BrandColorRef3
A colour that follows one kit entry. Swapping kits never re-points it (owner: any number of colours).
refoptionalstring
values: BRAND
default: "BRAND"
kitIdrequiredstring
entryIdrequiredstring
BrandCorpusRef3
The frozen brand list one result was decided against, with its disclosed coverage.
versionrequiredstring
sha256requiredstring
coverageDisclosurerequiredstring
BrandFontRef3
A font family that follows one kit font entry; the weight stays on the layer.
refoptionalstring
values: BRAND
default: "BRAND"
kitIdrequiredstring
entryIdrequiredstring
BrandKit9
One owner-level kit as the backend serves it (read-only to product-images).
kitIdrequiredstring
namerequiredstring
taglineoptionalstring | null
handleoptionalstring | null
versionrequiredinteger
colorsoptionalKitColor[]
default: []
fontsoptionalKitFont[]
default: []
archivedAtoptionalstring | null
updatedAtrequiredstring
Cancel2
Drop queued work; an unfinished run ends ABANDONED.
typeoptionalstring
values: CANCEL
default: "CANCEL"
actionKeyrequiredstring
CapabilityRow7
One installed lookup, action or dataset, with what this store can do right now.
keyrequiredstring
Key of the lookup, action or dataset this row describes.
sourceKeyrequiredstring
Installed source that declares this item.
accountIdrequiredstring | null
Stored account this row applies to; null exactly when state is NOT_CONNECTED.
staterequiredCapabilityState
What this item can do now.
issueoptionalProviderIssue | null
Known typed issue behind this state, if any.
familyKeyoptionalstring | null
Write family of an action row; null for a lookup or dataset.
blockedoptionalBlockedLane[]
Blocked lanes of a dataset row; empty for a lookup or action.
default: []
CapabilityStatevalues · 8
Whether one lookup, action or dataset of a store can be used now, and what blocks it.
values: READYGRANT_UNKNOWNPERMISSION_MISSINGFAMILY_OFFSTORE_PAUSEDNOT_CONNECTEDRECONSENT_REQUIREDBLOCKED
CaptureStyleOne of · 3
One of: WindowCapture | ChangeCapture | ListingCapture · Variant field kind
CatalogAvailabilityvalues · 3
Whether a source or published analyzed rows can answer a cell.
values: SUPPORTEDEXACT_ID_ONLYNONE
CatalogCellView9
One channel and kind's public capability cell.
objectrequiredstring
Public object discriminator.
values: catalog_cell
channelrequiredChannel
Channel represented by the cell.
recordKindrequiredAnalyzedRecordKind
Record family represented.
nodeKindrequiredNodeKind | null
Node family, or null when the cell names no node kind.
availabilityrequiredCatalogAvailability
Whether an active source or published rows serve this cell.
requiresMarketoptionalboolean
An active source requires a market for this kind.
default: false
acceptsWindowoptionalboolean
Published rows of this kind have a windowed metric or feature binding.
default: false
marketsoptionalstring[]
Markets declared by active sources for this channel and kind; empty means market-agnostic.
default: []
fieldsrequiredColumnSpec[]
Authorized public columns.
CatalogEdgeView7
One public catalog edge: an enabled topology hop a caller may use.
objectrequiredstring
Public object discriminator.
values: catalog_edge
edgeIdrequiredstring
Stable topology edge id.
fromKindrequiredNodeKind
Source node family of the hop.
toKindrequiredNodeKind
Target node family of the hop.
analyzedoptionalboolean | null
Whether this edge has a stored leg; null means unknown.
liveoptionalboolean | null
Whether this edge has a live leg; null means unknown.
relationoptionalAnalyzedRelationKind | null
Analyzed relationship followed by this edge; null for edges without a relation.
CategoryClause3
THE category carrier: filter by category values or provider category keys (X-2).
kindoptionalstring
values: CATEGORY
default: "CATEGORY"
valuesrequiredstring[]
opoptionalstring
values: INNOT_IN
default: "IN"
Cell6
One cell of one dimension combination, computed when read.
cellKeyrequiredstring
optionsrequiredobject
groupKeysrequiredstring[]
itemCountrequiredinteger
measuresrequiredobject
resultsrequiredobject
CellDetail3
The dialog for one clicked cell: the view's criterion first (if any), then declared sections.
cellrequiredRoomCell
criterionoptionalAssessmentResult | null
sectionsrequiredDetailSectionRead[]
CellScore4
One scored cell: 0-100 score, tier 0-9, and each factor's percentile.
cellKeyrequiredstring
scorerequiredinteger
tierrequiredinteger
percentilesrequiredobject
ChangeCapture1
A dataset read as one continuous lane over the source's own update time.
kindoptionalstring
Capture style: changes since the previous sync.
values: changes
default: "changes"
ChangeFieldTitle2
Human title of one top-level field of an action's change, declared by the plugin.
fieldrequiredstring
Top-level change field this title names.
titlerequiredStoreLocalizedText
Bilingual display name of that change field.
ChangeList13
The persisted, revisioned list of one artifect with a frozen ELTA target.
kindrequiredArtifectKind
storeIdrequiredstring
Keble identity that fences the owner and drives display.
accountrequiredAccountRef
ELTA AccountRef resolved once at create; edits cannot retarget it.
revisionrequiredinteger
revisedAtrequiredstring
rowsrequiredChangeRow[]
privateValuesoptionalPrivateValue[]
default: []
previewedAtoptionalstring | null
commandReceiptsoptionalCommandReceipt[]
default: []
filedoptionalFiledBatch[]
default: []
revertsoptionalFiledBatch[]
default: []
filingIntentoptionalFilingIntent | null
withdrawnoptionalFiledBatch[]
default: []
ChangeListCreatePremise4
The replayable create body shared by change-list kinds, with an optional account selector.
replayKeyrequiredstring
storeIdrequiredstring
Keble identity that fences the owner and drives display.
accountIdoptionalstring | null
rowsrequiredNewChangeRow[]
ChangeListSnapshot10
What read returns: the public list, screening result, stage and guide.
refrequiredArtifectRef
changeListrequiredChangeList
screeningrequiredScreeningResult | null
kindProblemsoptionalKindRuleProblem[]
default: []
stagerequiredChangeListStage
guiderequiredStageGuide
rowStagesrequiredChangeRowStageView[]
approvalsoptionalApprovalState[]
default: []
revertsoptionalApprovalState[]
default: []
leafRulesoptionalLeafRule[]
default: []
ChangeListStagevalues · 4
The derived stage of a row, and the aggregate used by the kind's guide.
values: DRAFTREADYPROPOSEDDECIDED
ChangeRow6
One proposed write: a bound ELTA action, its rationale and local inclusion state.
rowKeyrequiredstring
actionrequiredProviderAction
rationalerequiredstring
statusoptionalChangeRowStatus
default: "KEPT"
originrequiredChangeRowOrigin
previewoptionalRowPreview | null
ChangeRowOriginvalues · 2
Who wrote a row first; set once by the engine and kept through every edit.
values: KIND_CREATEAGENT_ADD
ChangeRowStageView3
One row's stage and its live approval join, without duplicating approval state.
rowKeyrequiredstring
stagerequiredChangeListStage
inboxItemIdrequiredstring | null
ChangeRowStatusvalues · 2
Whether the person keeps a row in the next proposal. Apply/revert state is ELTA's, never here.
values: KEPTDISCARDED
ChangesRequest9
A serving read of derived fact changes for one owner: the fact read's own selection.
familyKeyrequiredstring
The fact family to read.
daysrequiredDayRange
Inclusive reporting days in the account's timezone.
storeIdsoptionalstring[]
Stores to include; empty selects the asserted owner's stores.
default: []
accountIdsoptionalstring[]
Accounts to read; empty means every account of the owner.
default: []
entitiesoptionalstring[]
Stored entity keys to read; empty means every entity.
default: []
attributesoptionalAttributeMatch[]
View selections that restrict which rows are returned.
default: []
asOfoptionalstring | null
Instant to read as of; set this or capture_id, never both.
captureIdoptionalstring | null
Committed capture to read as of; set this or as_of, never both.
pageoptionalPageRequest
Row limit and cursor for this read.
default: {"limit":200}
Channelvalues · 7
Identify a source channel without exposing its provider implementation.
values: AMAZONTIKTOKSHOPIFYALIBABA_1688YOUTUBEINSTAGRAMREDDIT
ClaimEmotionvalues · 5
How the item feels about the claimed entity, on a 5-level scale.
values: STRONGLY_NEGATIVENEGATIVENEUTRALPOSITIVESTRONGLY_POSITIVE
ClaimStancevalues · 4
The stance one claim's supporting text shows toward the entity.
values: RECOMMENDSNEUTRALCRITICIZESCOMPARES_AGAINST
ClarificationAnswer2
The console's reply to one CLARIFY: the stored partial query the choice binds into, and the choice itself.
queryKeyrequiredstring
Key of the stored partial query this choice binds into.
choicerequiredstring
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).
typeoptionalstring
values: CLASSIFY
default: "CLASSIFY"
actionKeyrequiredstring
dimensionKeysrequiredstring[]
itemKeysoptionalstring[] | null
Color1
An sRGB colour with alpha, stored as #rrggbbaa.
hexrequiredstring
ColorField2
Override value: a text layer's colour.
fieldoptionalstring
values: COLOR
default: "COLOR"
colorrequiredColor | BrandColorRef
ColorRemap2
Replace one authored colour value (hex or kit ref) with another, by exact match, before kit lookup (A7).
sourcerequiredColor | BrandColorRef
targetrequiredColor | 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 (K-31, S-24).
namerequiredstring
Field code of this result column.
valueTyperequiredstring
Scalar type the column's values carry; DECIMAL is a major-unit number carried as a JSON string.
values: STRINTFLOATBOOLTIMESTAMPDECIMALNULL
unitoptionalMetricUnit | null
Metric unit of the cell's values; null when the column declares none.
currencyColumnoptionalstring | null
Sibling column carrying the currency; set iff unit is MONEY.
CombineOne of · 3
One of: SumCombine | LastCombine | RatioCombine · Variant field kind
CommandReceipt3
Record one successful caller command for bounded replay and conflict detection.
replayKeyrequiredstring
bodySha256requiredstring
revisionrequiredinteger
Comment9
Represent one comment nested beneath its Content item.
externalIdrequiredstring
parentExternalIdoptionalstring | null
authorNameoptionalstring | null
authorHandleoptionalstring | null
authorRefoptionalSourceSubject | null
bodyoptionalstring | null
publishedAtoptionalstring | null
depthoptionalinteger
default: 0
metricsoptionalMetricObservation[]
default: []
ComposedPost7
One post as the composer edits and renders it: title, featured image, ordered blocks, metadata.
titlerequiredstring
handleStemrequiredstring
featuredImageoptionalExistingShopifyFile | ShopifyRemoteImage | PostExportedImage | null
blocksrequiredHeadingBlock[] | ParagraphBlock[] | ListBlock[] | ImageBlock[] | QuoteBlock[]
summaryoptionalstring | null
tagsoptionalstring[]
default: []
authorrequiredstring
Concept6
An extracted concept attached to one scoped source record.
kindoptionalstring
Node discriminator; always CONCEPT.
values: CONCEPT
default: "CONCEPT"
conceptKindrequiredConceptKind
Which kind of concept this is.
keyrequiredstring
Per-item concept identity, 'revision:label'.
labelrequiredstring
Normalized label text of the concept.
subjectRefsrequiredNodeRef[]
Scoped references to the source records this concept was extracted from.
itemCountrequiredinteger
Number of source items carrying this concept.
ConceptKindvalues · 14
Concept records the extract capability yields, in two families.
values: 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.
labelrequiredstring
Normalized label of the concept.
kindrequiredConceptKind
Which kind of concept the label names.
ConclusionDetailValue5
A CONCLUSION detail row: the cell's status and, when a signal is raised, its prose.
objectoptionalstring
values: conclusion_detail_value
default: "conclusion_detail_value"
kindoptionalstring
values: CONCLUSION
default: "CONCLUSION"
keyrequiredstring
conclusionrequiredConclusionStatus
assessmentoptionalAssessmentResult | null
ConclusionRow2
The cell's tinted conclusion: the first raised signal wins, else NEUTRAL.
kindoptionalstring
values: CONCLUSION
default: "CONCLUSION"
signalsrequiredConclusionSignal[]
ConclusionSignal2
One FLAG assessment that, when raised, sets the conclusion's tone.
assessmentrequiredstring
tonerequiredTone
ConclusionStatusvalues · 4
A cell's conclusion (today's detail status values).
values: OPPORTUNITYCAUTIONNEUTRALUNAVAILABLE
ConnectStylevalues · 2
How an owner binds a source: a consent redirect, or credentials they enter.
values: CONSENTCREDENTIALS
ConnectionRecord14
One owner's grant for one plugin source, and the accounts it reaches.
objectoptionalstring
Document type: connector record.
values: connection_record
default: "connection_record"
connectionIdrequiredstring
Connector identifier within the asserted owner scope.
storeIdrequiredstring
Store this connector belongs to.
sourceKeyrequiredstring
Catalog source authorized by this connector.
statusrequiredConnectionStatus
Current authorization state.
accountsoptionalDiscoveredAccount[]
Accounts reached by this connector.
default: []
regionsoptionalProviderRegion[]
Sales regions reached by the discovered accounts.
default: []
boundAtrequiredstring
When the connector was first bound.
consentedAtoptionalstring | null
Latest successful consent instant; null when no consent was recorded.
lastSyncedAtoptionalstring | null
When this connection last synced successfully.
syncedThroughoptionalstring | null
Provider data instant this connection synced through.
boundWithrequiredConnectStyle
The way the current grant was bound.
reconsentDueAtoptionalstring | 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.
issueoptionalProviderIssue | null
Invalid-access reason requiring renewed consent, if present.
ConnectionStatusvalues · 3
Where one bound connection stands (mirror of the core enum).
values: PENDINGACTIVERECONSENT_REQUIRED
Contact9
Represent one creator-linked contact record with optional contact facts.
kindoptionalstring
values: CONTACT
default: "CONTACT"
channelrequiredChannel
externalIdrequiredstring
creatorRefrequiredSourceSubject
emailoptionalstring | null
whatsappoptionalstring | null
instagramoptionalstring | null
observedAtrequiredstring
provenancerequiredProvenance
ContactClause2
T8 (D9: "okay, should be optional"): the CREATOR result has a stored CONTACT carrying every named contact fact.
kindrequiredstring
values: CONTACT
presentrequiredstring[]
CONTACT field codes that must all be present and non-empty on one stored contact of the creator.
Content23
Represent one published item with typed creator/product references.
kindoptionalstring
values: CONTENT
default: "CONTENT"
channelrequiredChannel
externalIdrequiredstring
contentTyperequiredContentType
titleoptionalstring | null
bodyoptionalstring | null
hashtagsoptionalstring[]
default: []
creatorRefoptionalSourceSubject | null
creatorNameoptionalstring | null
creatorHandleoptionalstring | null
communityoptionalstring | null
publishedAtoptionalstring | null
metricsoptionalMetricObservation[]
default: []
mediaoptionalMediaRef[]
default: []
productRefsoptionalSourceSubject[]
default: []
languageoptionalstring | null
mentionedRefsoptionalSourceSubject[]
default: []
sponsorshipoptionalContentSponsorship
default: "UNKNOWN"
textTracksoptionalSocialTextTrack[]
default: []
commentsoptionalComment[]
default: []
statusoptionalContentStatus
default: "AVAILABLE"
observedAtrequiredstring
provenancerequiredProvenance
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.
storerequiredStoreOwner
objectKeyrequiredstring
sha256requiredstring
byteCountrequiredinteger
mediaTyperequiredstring
ContentSourcevalues · 2
Whether an image owns its canvas or resolves from an OWN parent (discriminator of ImageContent).
values: OWNVARIANT
ContentSponsorshipvalues · 4
What the platform itself declares about payment for one Content item (K-06, D-33).
values: ORGANICPAID_ADPAID_PARTNERSHIPUNKNOWN
ContentStatusvalues · 4
Describe whether one Content item remains available.
values: AVAILABLEDELETED_BY_AUTHORREMOVED_BY_MODERATORUNKNOWN
ContentTypevalues · 4
Describe the provider-neutral presentation form of one Content item.
values: VIDEOIMAGETEXTTHREAD
Continue3
Accept the reviewed step's current result (as edited) and let the run go on.
typeoptionalstring
values: CONTINUE
default: "CONTINUE"
actionKeyrequiredstring
afterrequiredRunStep
ContinueRequest2
A signed continuation request with an optional per-call row ceiling.
cursorrequiredstring
Opaque signed continuation token.
maxRowsoptionalinteger | 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.
len1requirednumber
len2requirednumber
len3requirednumber
lenUnitrequiredstring
values: cmminch
marketplacerequiredAmazonMarketplace
weightrequirednumber
weightUnitrequiredstring
values: poundouncekgg
expectedAdsCostRatiorequirednumber
expectedCustomerReturnedRatiooptionalnumber
default: 0.025
expectedPurchasingCostrequiredMinorUnitMoney
expectedAverageDailyInventoryVolumerequiredinteger
expectedAverageDailyShippedVolumerequiredinteger
isApparelrequiredboolean
isDangerousGoodsrequiredboolean
isBatteryrequiredboolean
feeCategoryStringrequiredstring
exchangeRatesrequiredExchangeRateInUsd[]
pricerequiredMinorUnitMoney
CoverageNote4
ONE disclosed gap in the world the page was computed over (owner decision D10). 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.
kindrequiredGapKind
Non-empty-cause gap this note discloses.
countrequiredinteger
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.
detailrequiredstring
Plain description of the gap.
totaloptionalinteger | null
Distinct records of the searched kind in scope; absent when the gap has no record population.
CreateResult3
Stored item and whether the call admitted a new row.
objectoptionalstring
values: create_result
default: "create_result"
itemrequiredTodoItem | AlertItem | ApprovalItem | NotificationItem
createdrequiredboolean
CreateVariants3
Create variants of one OWN image; free unless a spec carries a scene prompt (each its own paid step).
actionoptionalstring
values: CREATE_VARIANTS
default: "CREATE_VARIANTS"
sourceIdrequiredstring
variantsrequiredVariantSpec[]
Creator13
Represent one publishing account without inferring a real-world person.
kindoptionalstring
values: CREATOR
default: "CREATOR"
channelrequiredChannel
externalIdrequiredstring
namerequiredstring
handleoptionalstring | null
biographyoptionalstring | null
marketoptionalstring | null
linksoptionalstring[]
default: []
verifiedoptionalboolean | null
metricsoptionalMetricObservation[]
default: []
mediaoptionalMediaRef[]
default: []
observedAtrequiredstring
provenancerequiredProvenance
CreatorHandleSuggestion2
Prefill a creator handle input; this suggestion never runs a search.
kindoptionalstring
Handle-prefill suggestion discriminator.
values: CREATOR_HANDLE
default: "CREATOR_HANDLE"
channelrequiredChannel
Channel of the creator handle to enter.
Credential8
One piece of grant material the source declares, entered by the owner or returned.
keyrequiredstring
Credential field identifier.
labeloptionalstring | null
Label for an owner-entered credential field.
enteredoptionalboolean
Whether the owner enters this value when connecting.
default: false
secretoptionalboolean
Whether this value must be hidden when displayed.
default: true
updatableoptionalboolean
Whether the owner may replace this entered value alone on the held connection.
default: false
requiredoptionalboolean
Whether the binding form requires this entered value.
default: true
lifetimeDaysoptionalinteger | null
Days after entry the value stops working, when the provider forces a renewal.
renewHintoptionalStoreLocalizedText | 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).
keyrequiredstring
labelrequiredLocalizedText
promptrequiredstring
CropField2
Override value: an image layer's crop (None = uncropped).
fieldoptionalstring
values: CROP
default: "CROP"
croprequiredBox | null
Currencyvalues · 159
Currencies full list: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
values: AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBRLBSDBTNBWPBYNBYRBZDCADCDFCHFCLPCNYCOPCRCCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJEPJMDJODJPYKESKGSKHRKIDKMFKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUYUUZSVEFVESVNDVUVWSTXAFXCDXOFXPFXXXYERZARZMW
CurrencyBasisvalues · 2
State how a MONEY value's currency is known (K-08, S-21).
values: STATEDASSUMED
CustomerArtifectCreateResponseOne of · 3
Expose an Artifect reference or sanitized Artifect failure.
One of: ArtifectRef | ArtifectAccountRequired | ArtifectFailure · Variant field object
CustomerArtifectDecisionResponseOne of · 4
Expose an Artifect decision status, rejection or sanitized failure.
One of: ArtifectStatus | ArtifectDecisionRejection | ArtifectFailure | ArtifectProductImagesQuote · Variant field object
CustomerArtifectDetailResponseOne of · 2
Expose one kind-typed Artifect detail answer or sanitized failure (AWPD D-4).
One of: ArtifectDetail | ArtifectFailure · Variant field object
CustomerArtifectInputPageOne of · 10
One of: ArtifectReportScopeInputPage | ArtifectSampleRelevanceInputPage | ArtifectMaterialFactsInputPage | ArtifectStandoutInputPage | ArtifectJudgmentInputPage | ArtifectPositioningStepInputPage | ArtifectAdsRowAuditInputPage | ArtifectShopifyBlogPostsStepInputPage | ArtifectMonitorSetupInputPage | ArtifectMonitorConfirmInputPage · Variant field decisionType
CustomerArtifectInputResponseOne of · 3
Expose an Artifect input page, a terminal-run rejection or a sanitized failure.
One of: CustomerArtifectInputPage | ArtifectDecisionRejection | ArtifectFailure · Variant field object
CustomerArtifectPluginListResponse2
Expose the installed positioning plugins in a JSON-object envelope.
objectoptionalstring
values: artifect_plugin_list
default: "artifect_plugin_list"
pluginsrequiredRoomPublicDeclaration[]
CustomerArtifectSnapshotResponseOne of · 2
Expose an Artifect snapshot or sanitized failure.
One of: ArtifectSnapshot | ArtifectFailure · Variant field object
CustomerArtifectStatusResponseOne of · 2
Expose an Artifect lifecycle status or sanitized failure.
One of: ArtifectStatus | ArtifectFailure · Variant field object
CustomerDpCatalogResponseOne of · 2
Expose the DP catalog or its typed refusal as one customer root schema.
One of: CapabilityCatalog | SearchRefused · Variant field object
CustomerDpContinueResponseOne of · 4
Expose one discriminated DP continuation answer.
One of: SearchPage | EntityPage | SearchPending | SearchRefused · Variant field object
CustomerDpFreshnessResponseOne of · 2
Expose the DP freshness projection or its typed refusal.
One of: Freshness | SearchRefused · Variant field object
CustomerDpMotifsResponseOne of · 3
Expose one DP motif page, its pending variant or a typed refusal.
One of: EntityPage | SearchPending | SearchRefused · Variant field object
CustomerDpRecordResponseOne of · 2
Expose one DP record detail or its typed refusal.
One of: RecordDetail | SearchRefused · Variant field object
CustomerDpSearchResponseOne of · 6
Expose the full discriminated DP search answer without copying DP fields.
One of: SearchPage | EntityPage | SearchPending | SearchClarify | SearchAnswer | SearchRefused · Variant field object
CustomerInboxItemResponseOne of · 4
Expose the inbox owner's todo/approval union without copying either item model.
One of: TodoItem | AlertItem | ApprovalItem | NotificationItem · Variant field kind
CutOutProduct3
Paid: cut the product out of a PRODUCT layer's photo.
actionoptionalstring
values: CUT_OUT_PRODUCT
default: "CUT_OUT_PRODUCT"
designIdrequiredstring
layerIdrequiredstring
Dataset6
One captured dataset, including the visible provider-number parity label.
keyrequiredstring
Captured dataset identifier.
familiesrequiredFamily[]
Fact families produced by this dataset.
capturerequiredCaptureStyle
How this dataset is captured and scheduled.
backfillDaysrequiredinteger
Historical days initially captured within source retention.
requiresoptionalPermission[]
Permissions needed to capture this dataset.
default: []
unverifiedoptionalboolean
Whether equality with source-reported totals remains unverified.
default: false
DateClause4
Bound one K-04 launch instant from below or above (P5 C-7, X-7).
kindoptionalstring
values: DATE
default: "DATE"
fieldrequiredstring
values: released_atpublished_atfirst_tracked_at
oprequiredstring
values: GTELTE
valuerequiredstring
DateWindow2
Bound one explicit inclusive calendar window for keyword trend reads.
startrequiredstring
endrequiredstring
DayCoverage6
What ELTA holds for one account x family x day, and whether it is settled.
accountrequiredAccountRef
The provider account this coverage is for.
familyKeyrequiredstring
The fact family this coverage is for.
dayrequiredstring
The reporting day this coverage is for.
availabilityrequiredAvailability
What is held for this account, family and day.
maturityrequiredMaturity
Whether the value may still be restated by the source.
capturedAtoptionalstring | null
Newest capture that confirmed this day; none when unconfirmed.
DayRange2
Inclusive reporting days in one account's timezone.
startsOnrequiredstring
First reporting day, inclusive.
endsOnrequiredstring
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.
typeoptionalstring
values: DECIDE
default: "DECIDE"
actionKeyrequiredstring
Decidervalues · 2
Who decides a step's result before the run moves on.
values: MODELCALLER
DecisionPick4
One recommended cell with its score, headline and the model's explanation (when written).
cellKeyrequiredstring
scorerequiredinteger
titleoptionalstring | null
proseoptionalstring | null
DecisionRecord3
The latest decision over the scorecard; headline and prose may be unavailable while picks stand.
decisionIdrequiredstring
statusrequiredDecisionStatus
picksoptionalDecisionPick[]
default: []
DecisionRefusalvalues · 3
Why core cannot offer a decision run now (existing wire tokens; the frontend maps copy).
values: NO_EVIDENCERUN_IN_FLIGHTTABLE_NOT_READY
DecisionStatusvalues · 3
A decision run is one explicit intent; only one runs at a time (existing ruling).
values: RUNNINGSUCCEEDEDFAILED
DeleteCriterion3
Delete one criterion and its results; views naming it show no criterion.
typeoptionalstring
values: DELETE_CRITERION
default: "DELETE_CRITERION"
actionKeyrequiredstring
keyrequiredstring
DeleteDimension3
Delete one dimension and its placements; views naming it fall back to their other axes.
typeoptionalstring
values: DELETE_DIMENSION
default: "DELETE_DIMENSION"
actionKeyrequiredstring
dimensionKeyrequiredstring
DeleteView5
Delete one saved view from the viewer's viewport (the first definition cannot be deleted).
typeoptionalstring
values: DELETE_VIEW
default: "DELETE_VIEW"
actionKeyrequiredstring
viewerrequiredViewerRef
expectedRevisionrequiredinteger
viewIdrequiredstring
DetachVariant2
Freeze a variant's resolved design into OWN content (kit refs stay refs); it stops following its parent.
actionoptionalstring
values: DETACH_VARIANT
default: "DETACH_VARIANT"
objectIdrequiredstring
DetailSection3
One section of the dialog a person opens by clicking a cell.
keyrequiredstring
titlerequiredLocalizedText
rowsrequiredMeasureRow[] | AssessmentRow[] | ConclusionRow[] | ItemsRow[] | ReferencesRow[]
DetailSectionRead2
One declared section with its rows filled for one cell.
sectionrequiredDetailSection
valuesrequiredMeasureDetailValue[] | AssessmentDetailValue[] | ConclusionDetailValue[] | ItemsDetailValue[] | ReferencesDetailValue[]
DiffLine6
One mutation or estimate line, optionally private or a raw text hunk.
kindrequiredDiffLineKind
Diff-line operation and display color.
fieldrequiredstring
Changed field name or quote JSON pointer.
beforeoptionalJsonValue | null
Previous field value, when present.
afteroptionalJsonValue | null
Requested value or estimate, when present.
privateoptionalboolean
Whether this line contains owner-only data.
default: false
textHunksoptionalTextHunk[]
Raw line operations for a text-file diff.
default: []
DiffLineKindvalues · 4
Meaning and display treatment of one requested change or provider estimate.
values: ADDEDCHANGEDREMOVEDESTIMATE
DimensionOriginvalues · 2
Where a dimension's placements come from: cut from a fact, or judged (model or caller).
values: COMPUTEDCLASSIFIED
DimensionRecord5
One dimension of a positioning and its ordered options.
keyrequiredstring
labelrequiredLocalizedText
originrequiredDimensionOrigin
factoptionalstring | null
optionsrequiredOptionRecord[]
DiscardRow2
Leave one row out of the next proposal; it stays visible and restorable.
opoptionalstring
values: DISCARD_ROW
default: "DISCARD_ROW"
rowKeyrequiredstring
DiscoveredAccount7
An account a binding reaches, as the plugin reports it at discovery.
accountIdrequiredstring
Account identifier within the source.
titlerequiredstring
Account display name.
timezonerequiredstring
Account's reporting timezone.
currencyoptionalstring | null
Account currency; null when no money is reported.
regionoptionalProviderRegion | null
Sales region reached by this account; null for sources without regional accounts.
attributesoptionalobject
Account metadata keyed by the source's declared attributes.
default: {}
grantedoptionalPermission[] | 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).
statusrequiredSetStatus
revisionrequiredinteger
titlerequiredstring
kitsrequiredBrandKit[]
photosrequiredOwnedPhotoRef[]
objectsrequiredObjectOutline[]
focusoptionalstring[]
default: []
latestEditoptionalEditSummary | null
DriftPolicyvalues · 2
Whether a write may proceed after its target changed since preview.
values: APPLY_ANYWAYREFUSE
DropPost2
Leave one post out of create-all.
editoptionalstring
values: DROP_POST
default: "DROP_POST"
postKeyrequiredstring
DropShadow4
A rendered shadow under any leaf layer (procedural, deterministic, free; D-13, VV-4).
colorrequiredColor | BrandColorRef
blurrequirednumber
offsetXoptionalnumber
default: 0
offsetYoptionalnumber
default: 0
EditActionKindvalues · 32
Every edit the agent or the editor can make (discriminator of EditAction).
values: 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
EditRefusal7
A refused batch or step, pointing at the first offending action so the agent can fix and resubmit.
outcomeoptionalstring
values: REFUSED
default: "REFUSED"
coderequiredEditRefusalCode
actionIndexoptionalinteger | null
layerIdoptionalstring | null
objectIdoptionalstring | null
changedObjectsoptionalstring[]
default: []
limitoptionalinteger | null
EditRefusalCodevalues · 25
Why a batch (or a paid step on re-check) was not applied; the head is unchanged in every case.
values: 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.
opoptionalstring
values: EDIT_ROW
default: "EDIT_ROW"
rowKeyrequiredstring
actionrequiredUnboundAction
rationaleoptionalstring | null
EditSummary6
One recorded edit summary for the agent's last-change card and the editor's version history.
revisionrequiredinteger
actorrequiredProductImagesActorKind
actionTypesrequiredEditActionKind[]
changedObjectsrequiredstring[]
committedAtrequiredstring
batchKeyoptionalstring | null
EllipseGeometry1
An ellipse inscribed in the box (callout dots, circular badges).
kindoptionalstring
values: ELLIPSE
default: "ELLIPSE"
EntityLevel3
One catalog-declared entity level: its key, bilingual title and one-hop parent (4.0.0).
keyrequiredstring
Level key carried by every value.
titlerequiredStoreLocalizedText
Display name of the level, in both languages.
parentoptionalstring | null
Level whose entity scopes this one; never itself parented.
EntityPage9
One customer page with honest progress and an opaque continuation.
objectrequiredstring
Public object discriminator.
values: entity_page
itemsrequiredNodeHit[]
Final typed node hits in page order.
cursorrequiredstring | null
Opaque signed short token for continuation; null when complete.
progressrequiredPageProgress
Requested count and progress per step.
coverageoptionalCoverageNote[]
Disclosed gaps in the world this page searched.
default: []
unappliedoptionalstring[]
At most eight request parts that this page did not apply.
default: []
familiesoptionalFamilySummary[]
Product families represented by this page's listings.
default: []
windowoptionalResolvedWindow | null
Time axis and inclusive span read; null when none.
marketoptionalstring | 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.
levelrequiredstring
Granularity of the entity: a catalog level key.
entityrequiredstring
Identifier at the declared granularity.
parentoptionalEntityRef | null
labeloptionalstring | null
Display title only, never identity; excluded from proposal hashes and target keys.
EstimateSourcevalues · 5
Provenance of one economic input used by a profit breakdown line.
values: AMAZON_OBSERVEDUSER_SUPPLIEDCOHORT_INFERREDPUBLIC_WEB_RESEARCHUNRESOLVED
EstimationStatusvalues · 3
State whether a reported metric is actual, estimated, or unknown.
values: UNKNOWNACTUALESTIMATED
EvidenceBasisvalues · 3
HOW STRONGLY a fact supports a hit (K-25, D-15, S-26).
values: RECORDEDMENTIONEDSIMILAR
ExchangeRateInUsd2
Legacy fixed-two quote expressing currency major units per one USD.
currencyrequiredCurrency
exchangeRaterequiredStdMoneyAmount
ExcludeAsinsAdjustment2
Remove ASINs from the analysis and recompute dependent sections.
adjustmentTypeoptionalstring
values: EXCLUDE_ASINS
default: "EXCLUDE_ASINS"
asinsrequiredstring[]
ASINs removed from the analysis.
ExistingShopifyFile2
An image body segment that refers to a file already in this Shopify store.
file_idrequiredstring
alt_textoptionalstring
default: ""
ExportOptions4
How an export renders: format, scale, which images, or one layer alone (stated once per export).
formatoptionalRenderFormat | null
scaleoptionalnumber
default: 1
objectIdsoptionalstring[] | null
layerIdoptionalstring | null
ExportSet6
An immutable, ordered group of rendered images pinned to one revision: what the listing artifect consumes.
exportIdrequiredstring
setIdrequiredstring
revisionrequiredinteger
optionsoptionalExportOptions
imagesrequiredExportedImage[]
createdAtrequiredstring
ExternalIdentity3
Retain a universal product alias without provider attribution.
kindrequiredExternalIdentityKind
valuerequiredstring
marketoptionalstring | null
ExternalIdentityKindvalues · 5
Name provider-neutral product aliases that are safe for consumer data.
values: GTINEANUPCSKUMODEL_NUMBER
FactChangeOne of · 2
One of: AttributeChange | MeasureChange · Variant field kind
FactChangePage4
One bounded page of derived fact changes; total_rows counts every change matched.
rowsrequiredFactChange[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | null
Why this page is empty and what selection or source to check.
FactHistoryResponse5
One bounded page of every stored version, superseded ones included.
rowsrequiredFactVersion[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | null
Why this page is empty and what selection or source to check.
objectoptionalstring
Fixed tag marking this object as a fact history page.
values: fact_history_response
default: "fact_history_response"
FactPage8
One bounded page of fact rows plus the coverage of every requested day.
rowsrequiredFactRow[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | null
Why this page is empty and what selection or source to check.
objectoptionalstring
Fixed tag marking this object as a fact page.
values: fact_page
default: "fact_page"
coveragerequiredDayCoverage[]
Coverage of every requested account, family and day.
readAsOfrequiredstring
The single instant all rows were read at.
blockedoptionalBlockedLane[]
Blocked lanes with their reason and fix.
default: []
FactRow8
One stored fact value: identity values, day, typed cells.
accountrequiredAccountRef
The provider account this row belongs to.
familyKeyrequiredstring
The fact family this row belongs to.
identityrequiredstring[]
One value per family identity attribute, in declared order.
parentsoptionalEntityRef[]
default: []
dayrequiredstring
The reporting day this value is for.
occurredAtoptionalstring | null
When the event happened; only for event-style families.
measuresoptionalobject
Measure values keyed by declared measure key; absent is unknown.
default: {}
dimsoptionalobject
Attribute values keyed by declared attribute key.
default: {}
FactSpec3
One fact every item of this plugin may carry.
keyrequiredstring
labelrequiredLocalizedText
kindrequiredFactValueKind
FactVersion5
One stored version of one fact row (change-only history).
rowrequiredFactRow
The stored fact row this version belongs to.
captureIdrequiredstring
The capture whose processing made this version readable.
contentHashrequiredstring
Hash of the row content used to detect a new version.
observedAtrequiredstring
Instant this version became readable.
supersededAtoptionalstring | 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.
familyKeyrequiredstring
The fact family to read.
daysrequiredDayRange
Inclusive reporting days in the account's timezone.
storeIdsoptionalstring[]
Stores to include; empty selects the asserted owner's stores.
default: []
accountIdsoptionalstring[]
Accounts to read; empty means every account of the owner.
default: []
entitiesoptionalstring[]
Stored entity keys to read; empty means every entity.
default: []
attributesoptionalAttributeMatch[]
View selections that restrict which rows are returned.
default: []
asOfoptionalstring | null
Instant to read as of; set this or capture_id, never both.
captureIdoptionalstring | null
Committed capture to read as of; set this or as_of, never both.
pageoptionalPageRequest
Row limit and cursor for this read.
default: {"limit":200}
FailureRef2
A typed, self-describing reference to one durable failure record (Q9).
kindrequiredFailureRefKind
Store the referenced durable record lives in.
idrequiredstring
Durable record id in that store.
FailureRefKindvalues · 1
What kind of durable record a public failure reference names (Q9).
values: PUBLIC_REQUEST
Family8
One family of facts: identity, time placement, columns and settle window.
keyrequiredstring
Fact-family identifier.
kindrequiredTemporalFactKind
How these facts are placed in time.
levelrequiredstring
Granularity of each fact row: a catalog level key.
identityrequiredAttribute[]
Ordered text columns identifying a fact.
dimsoptionalAttribute[]
Additional descriptive text columns.
default: []
measuresrequiredMeasure[]
Numeric columns reported by this family.
settlesAfterDaysrequiredinteger
Days after reporting before a value is final; zero means final on capture.
absencerequiredAbsencePolicy
Meaning of an entity missing from a confirmed day.
FamilySummary6
One product family on a page: its label, size and price range (K-30, D-32).
familyKeyrequiredstring
Stable family key, matching NodeHit.family_key.
labelrequiredstring
Readable family label.
memberCountrequiredinteger
Listings in this family.
priceCurrencyoptionalCurrency | null
Currency of min_price and max_price.
minPriceoptionalnumber | string | null
Lowest member price in major units.
maxPriceoptionalnumber | string | null
Highest member price in major units.
FbaInboundPlanStatusvalues · 3
The live plan state, read through ELTA's amazon.seller.fba_inbound_plan_status lookup.
values: ACTIVEVOIDEDCLOSED
FbaInboundStagevalues · 7
Where one FBA inbound plan is; the kind's pure stage(...) derives it on every read.
values: DRAFTCREATE_PENDINGCREATE_UNKNOWNPACKING_DRAFTPACKING_PENDINGPACKEDCANCELLED
FeatureValue5
One windowed analyzed metric, distinct from label adoption counts.
featureCoderequiredstring
Code of the analyzed feature this value measures.
windowDaysrequiredinteger
Length in days of the window the value was computed over.
valuerequirednumber
The feature's value inside this window.
velocityoptionalnumber | null
Change of the value against the previous window; null when none was measured.
rankoptionalinteger | 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.
fieldoptionalstring | null
JSON pointer into the change, when known.
coderequiredstring
Provider or contract field-problem code.
messagerequiredstring
Provider explanation and repair guidance.
FiledBatch4
Pointers and selected row keys for one filing; no copy of ELTA or inbox state.
proposalIdrequiredstring
inboxItemIdrequiredstring
revisionrequiredinteger
rowKeysrequiredstring[]
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.
requestrequiredActionBatch | RevertRequest
replayKeyrequiredstring
commandReceiptoptionalCommandReceipt | null
revisionrequiredinteger
FillField2
Override value: a shape layer's fill, solid or gradient (None = no fill).
fieldoptionalstring
values: FILL
default: "FILL"
fillrequiredColor | BrandColorRef | LinearGradient | RadialGradient | null
FirstLegLineDetail3
Transport composition of the first-leg shipping breakdown line.
shippingModerequiredShippingMode
billableWeightKgrequirednumber
ratePerKgrequiredMinorUnitMoney
FlipField3
Override value: an image layer's mirror flags.
fieldoptionalstring
values: FLIP
default: "FLIP"
flipXrequiredboolean
flipYrequiredboolean
FontField2
Override value: a text layer's font.
fieldoptionalstring
values: FONT
default: "FONT"
fontrequiredstring | BrandFontRef
FontSizeField2
Override value: a text layer's font size in canvas pixels.
fieldoptionalstring
values: FONT_SIZE
default: "FONT_SIZE"
sizerequirednumber
FontWeightvalues · 3
The static weights available in the hosted, licence-cleared font manifest.
values: REGULARMEDIUMBOLD
FontWeightField2
Override value: a text layer's font weight.
fieldoptionalstring
values: FONT_WEIGHT
default: "FONT_WEIGHT"
weightrequiredFontWeight
FrameEvidence3
The frame ONE element cites as its evidence (T1).
kindoptionalstring
Evidence discriminator; always FRAME.
values: FRAME
default: "FRAME"
framerequiredContentRef
Content reference of the retained frame this element cites.
timestampMsrequiredinteger
Publication-relative offset of the cited frame in milliseconds.
Freshness6
Cached freshness rows and one scope-level pending-ingest count.
objectrequiredstring
Public object discriminator.
values: freshness
rowsrequiredFreshnessRow[]
One freshness aggregate per channel and kind.
activationEpochrequiredinteger
Visible activation epoch.
activatedAtrequiredstring
Activation timestamp of the epoch.
asOfrequiredstring
Timestamp at which the report was computed.
ingestPendingoptionalinteger | null
Jobs waiting in this scope's DP ingest queue; null means not measured.
FreshnessRow4
One freshness aggregate identified by (channel, node_kind).
channelrequiredChannel | null
Channel this row counts; null for channel-agnostic rows.
nodeKindrequiredNodeKind | ConceptKind
Node or concept kind this row counts.
recordsrequiredinteger
Number of cached records for this (channel, kind) coordinate.
latestObservedAtrequiredstring | null
Newest known source observation time; null when all are unknown.
FromObject9
The source object or source facts from which a path begins (R34).
kindrequiredNodeKind
Node kind the path starts from.
channeloptionalChannel | null
Source channel the source records live in; null for derived kinds.
sourceIdsoptionalNodeRef[]
Exact source records the path starts from.
default: []
descriptionsoptionalKeywordTerm[]
Descriptive facts (title, brand, handle and similar) hydrated from the source.
default: []
identitiesoptionalExternalIdentity[]
Universal product aliases (GTIN, EAN, UPC, SKU, model number) carried by the source.
default: []
handlesoptionalstring[]
Creator or store handles supplied as source facts.
default: []
conceptKindoptionalConceptKind | null
Concept kind to start from when the source kind is CONCEPT.
marketoptionalstring | null
Market the source records belong to.
dateWindowoptionalDateWindow | null
Inclusive publication-date span of source topic videos; null means unbounded.
GapKindvalues · 7
ONE gap vocabulary for coverage notes and empty step causes (K-28).
values: UNLINKED_CLAIMSUNHYDRATED_ENDPOINTSMISSING_OBSERVATIONSCELL_EMPTYNO_MATCHNO_INPUTUPSTREAM_EMPTY
GatewayError8
The one customer error body: a stable code, a localized message and the offending fields.
objectoptionalstring
values: error
default: "error"
coderequiredGatewayErrorCode
messagerequiredstring
fieldsoptionalstring[]
default: []
failureRefoptionalFailureRef | null
Upstream failure reference for operator lookup.
operationIdoptionalstring | null
The call's operation id (also the X-Keble-Operation-Id header); quote it to support.
redeemRefusalReasonoptionalRedeemCodeRefusalReason | null
Finite redeem-refusal reason; set only on a redeem-code refusal.
retryAfterSecondsoptionalinteger | null
Seconds until a retry may succeed (the request window reset); null when unknown.
GatewayErrorCodevalues · 23
Every customer/admin refusal code on REST, MCP and the V3 feature routes.
values: INVALID_API_KEYSIGNED_IN_ONLYACCOUNT_DISABLEDLAST_ORG_OWNERORG_DELETE_BLOCKEDIDENTITY_VERIFICATION_REQUIREDINVALID_REQUESTNOT_FOUNDRATE_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).
actionoptionalstring
values: GENERATE_DECOR
default: "GENERATE_DECOR"
objectIdrequiredstring
promptrequiredstring
newLayerIdoptionalstring | null
boxoptionalBox | null
replacesoptionalstring | null
GenerateFromPlan3
Create one variant per plan row that has none (id {plan_id}-{row_id}); row_ids=None = every such row.
actionoptionalstring
values: GENERATE_FROM_PLAN
default: "GENERATE_FROM_PLAN"
planIdrequiredstring
rowIdsoptionalstring[] | null
GenerateScene7
Paid: generate a BACKGROUND under the product layer, or across the whole canvas, from a prompt.
actionoptionalstring
values: GENERATE_SCENE
default: "GENERATE_SCENE"
designIdrequiredstring
layerIdrequiredstring | null
newLayerIdoptionalstring | null
replacesoptionalstring | null
promptrequiredstring
styleReferencesoptionalAssetRef[]
default: []
GeometryField2
Override value: a shape layer's whole geometry (a variant may round a panel or swap a badge outline).
fieldoptionalstring
values: GEOMETRY
default: "GEOMETRY"
geometryrequiredRectGeometry | EllipseGeometry | LineGeometry | PolygonGeometry | PathGeometry
GradientStop2
One colour at offset 0–1, following a kit or literal colour (D-13, VV-2).
offsetrequirednumber
colorrequiredColor | BrandColorRef
GrantedByvalues · 2
Who can grant a permission, which decides who must act when it is missing.
values: OWNERAPP
GridSpec5
Which measures may size the circle and be printed in it.
sizeMeasuresrequiredstring[]
numberMeasuresrequiredstring[]
defaultSizerequiredstring
defaultNumberrequiredstring
cellAssessmentsoptionalstring[]
default: []
GroupLayer8
Layers moved and hidden together; children are placed in canvas coordinates and the box is derived.
layerIdrequiredstring
namerequiredstring
opacityoptionalnumber
default: 1
blendModeoptionalBlendMode
default: "NORMAL"
visibleoptionalboolean
default: true
lockedoptionalboolean
default: false
kindoptionalstring
values: GROUP
default: "GROUP"
childrenrequiredImageLayer[] | TextLayer[] | ShapeLayer[] | GroupLayer[]
GroupLayers5
Wrap sibling layers into a new group (caller-minted id); its box is derived from them.
actionoptionalstring
values: GROUP_LAYERS
default: "GROUP_LAYERS"
designIdrequiredstring
layerIdsrequiredstring[]
groupIdrequiredstring
namerequiredstring
GuardedFetchRefusalCodevalues · 7
Why a guarded fetch was refused; each is a policy decision, never a transport fault.
values: 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.
kindoptionalstring
values: HEADING
default: "HEADING"
levelrequiredinteger
values: 23
textrequiredstring
HopProgress6
ONE public step entry: how far a page's step got (K-28, S-30).
edgeIdoptionalstring | null
Public catalog edge id; null when unavailable (direct searches or older records).
toKindrequiredNodeKind
Node kind this step reads.
readrequiredinteger
Rows this step read so far.
fetchedoptionalinteger | null
Rows this step fetched before a post-fetch filter removed some; null when no rows were removed after fetching.
exhaustedrequiredboolean
True when this step has no further rows.
emptyCauseoptionalGapKind | 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.
designIdrequiredstring
assetrequiredAssetRef
urlrequiredstring
expiresAtrequiredstring
findingsrequiredSlotFinding[]
HtmlSegment1
One literal HTML fragment in the ordered body sent to Shopify.
htmlrequiredstring
HttpsImageUrl1
An image the owner already hosts (their own cloud link); Amazon fetches it at apply.
urlrequiredstring
ImageBlock3
One shape-selected image placed between paragraphs, with an optional caption.
kindoptionalstring
values: IMAGE
default: "IMAGE"
imagerequiredExistingShopifyFile | ShopifyRemoteImage | PostExportedImage
captionoptionalstring | null
ImageExportRef3
The consumer-held reference to one exported design: set, immutable export, design.
imageSetIdrequiredstring
exportIdrequiredstring
designIdrequiredstring
ImageFill2
Fill an image placeholder with an asset (the product photo, a logo); never a found REFERENCE.
placeholderrequiredstring
values: bodycallout_1callout_2callout_3headlineproduct_photo
assetrequiredAssetRef
ImageFinding2
One W3.1 slot-rule result placed on one image of the draft; a hint, never a refusal.
pointerrequiredstring
findingrequiredSlotFinding
ImageLayer15
A placed image; mask is a cut-out alpha matte applied to asset's own pixels.
layerIdrequiredstring
namerequiredstring
opacityoptionalnumber
default: 1
blendModeoptionalBlendMode
default: "NORMAL"
visibleoptionalboolean
default: true
lockedoptionalboolean
default: false
boxrequiredBox
shadowoptionalDropShadow | null
kindoptionalstring
values: IMAGE
default: "IMAGE"
rolerequiredImageRole
assetrequiredAssetRef
maskoptionalAssetRef | null
flipXoptionalboolean
default: false
flipYoptionalboolean
default: false
cropoptionalBox | null
ImageMediaTypevalues · 3
Accepted and produced image encodings.
values: image/pngimage/jpegimage/webp
ImageOperationvalues · 3
The paid image-model operations; each is one OperationSpec in library.OPERATIONS.
values: CUT_OUTSCENEDECOR
ImageRolevalues · 4
What an image layer shows; the fidelity law and the slot checks read it.
values: PRODUCTBACKGROUNDDECORATIONLOGO
InboxItemRef1
Which inbox item a read or completion names (one tool/route input).
itemIdrequiredstring
InboxPendingRequest2
One pending page: an opaque cursor and a bounded size (one tool/route input).
cursoroptionalstring | null
limitoptionalinteger
default: 20
IntakeFinding2
One hint on one accepted upload (index into the uploads tuple).
coderequiredIntakeFindingCode
uploadIndexrequiredinteger
IntakeFindingCodevalues · 1
A hint about an accepted upload; the owner decides whether it suits their slot.
values: TOO_SMALL
IntakeRefusal4
An upload the intake refused (index into the uploads tuple), with the limits in force on TOO_LARGE.
coderequiredIntakeRefusalCode
uploadIndexrequiredinteger
maxUploadBytesoptionalinteger | null
maxPixelsoptionalinteger | null
IntakeRefusalCodevalues · 2
Why an upload was not accepted: only bytes that cannot be an image or cannot be stored.
values: NOT_AN_IMAGETOO_LARGE
IssueKindvalues · 7
Why a provider refused or failed one call, in the terms ELTA acts on.
values: AUTH_INVALIDPERMISSION_MISSINGACCOUNT_UNAVAILABLERATE_LIMITEDPROVIDER_UNAVAILABLEREQUEST_REJECTEDNOT_FOUND
ItemAction2
Host-defined alert remedy, such as a store reason and its store identity.
keyrequiredstring
refrequiredstring
ItemCardSpec4
How one item group is shown in the item list and approval step.
titleFactrequiredstring
imageFactoptionalstring | null
factsoptionalstring[]
default: []
pivotFactsoptionalstring[]
default: []
ItemContent4
Human-visible and editable todo/alert/approval content.
titlerequiredstring
descriptionoptionalstring
default: ""
priorityoptionalPriority
default: "NORMAL"
assigneeoptionalstring | null
ItemPrompt2
What the models see of one item, as typed parts.
textrequiredstring
imageUrlsoptionalstring[]
default: []
ItemRead2
One item with its relevance and its group's placements (what the SOURCE and PLACE reviews show).
recordrequiredItemRecord
placementsrequiredobject
ItemRecord2
One stored item, as the plugin sourced it or a caller added it, with its relevance.
itemrequiredSourcedItem
relevantrequiredboolean
ItemUpdate4
One item's changed fields; an omitted field is unchanged, a named fact is replaced.
keyrequiredstring
nameoptionalstring | null
factsoptionalobject
relevantoptionalboolean | null
ItemsDetailValue4
An ITEMS detail row: the cell's sample items projected to the declared facts.
objectoptionalstring
values: items_detail_value
default: "items_detail_value"
kindoptionalstring
values: ITEMS
default: "ITEMS"
keyrequiredstring
itemsoptionalobject[]
default: []
ItemsRow2
A detail row listing the cell's sample items with the named facts.
kindoptionalstring
values: ITEMS
default: "ITEMS"
factsrequiredstring[]
JsonValue0
No fields.
JudgmentAdjustment4
Rewrite the conclusion text of the head revision; numbers untouched, 0 model calls.
adjustmentTypeoptionalstring
values: JUDGMENT
default: "JUDGMENT"
verdictoptionalReportJudgmentVerdict | null
Replacement verdict, when given.
sectionsoptionalReportJudgmentSection[]
Replacement slot texts, each slot at most once.
default: []
overviewoptionalReportOverviewEvidence | null
Replacement overview, when given.
JudgmentQuestion8
Write the conclusion for the committed numbers of one revision.
decisionTypeoptionalstring
values: JUDGMENT
default: "JUDGMENT"
languagerequiredLanguage
Reader language of every text.
verdictOpenrequiredboolean
False: a policy pre-check already fixed the verdict.
fixedReasonCodeoptionalReportReasonCode | null
Set iff the verdict is not open.
materialInputUnresolvedAdmissiblerequiredboolean
Whether MATERIAL_INPUT_UNRESOLVED may be the reason.
ruleLinesoptionalstring[]
Policy rules the verdict must follow.
default: []
sectionKindsrequiredReportNarrativeSectionKind[]
The section slots to write, once each.
itemsoptionalReportJudgmentEvidenceItem[]
Citable accepted artifacts.
default: []
KebleBlockKindvalues · 2
The block kinds a Keble section may repeat: one FAQ question, one feature of a feature list.
values: QUESTIONFEATURE
KebleSectionKindvalues · 5
The v1 Keble section library; every member has exactly one SectionSpec (totality test).
values: HERO_BANNERRICH_TEXTIMAGE_WITH_TEXTFAQFEATURE_LIST
Keyword11
Represent a market-scoped source term without embedding product relations.
kindoptionalstring
values: KEYWORD
default: "KEYWORD"
channelrequiredChannel
externalIdrequiredstring
textrequiredstring
keywordTypeoptionalKeywordType
default: "SEARCH_TERM"
marketoptionalstring | null
metricsoptionalMetricObservation[]
default: []
brandsoptionalstring[]
default: []
categoriesoptionalstring[]
default: []
observedAtrequiredstring
provenancerequiredProvenance
KeywordCandidate2
One caller term with the evidence the server attached (the core's one converter builds it).
termrequiredstring
evidencerequiredMeasuredKeywordEvidence[] | SuggestedKeywordEvidence[]
KeywordTerm2
A normalized description carried from a source into ONE named builder (R40).
valuerequiredstring
The normalized description text.
termTyperequiredSourceDescriptionKind
Which descriptive source field the text came from.
KeywordTypevalues · 3
Describe a source term without selecting its eventual query operation.
values: SEARCH_TERMHASHTAGTAG
KindRuleProblem4
One kind-owned rule a row's action breaks, located by JSON Pointer in action.change.
rowKeyrequiredstring
pointerrequiredstring
rulerequiredstring
messagerequiredstring
KitColor4
One named kit colour.
entryIdrequiredstring
namerequiredstring
colorrequiredColor
replacedByoptionalstring | null
KitFont3
One named kit font with its usage label, e.g. Anton for HEADLINES (demo 4). Weight stays on the layer.
entryIdrequiredstring
namerequiredstring
fontrequiredstring
values: intermontserratnoto_sans_scnoto_serif_scplayfair_display
Languagevalues · 22
values: ENGLISHSIMPLIFIED_CHINESEGERMANFRENCHITALIANSPANISHDUTCHPORTUGUESEJAPANESETURKISHPOLISHSWEDISHARABICHINDITHAIKOREANVIETNAMESEINDONESIANHEBREWNORWEGIANDANISHFINNISH
LastCombine1
Range value = the value of the last day that has one.
kindoptionalstring
Range combination: last day with a value.
values: last
default: "last"
LayerClippedRule1
No visible layer extends past the canvas edge (advisory, Leg-2 P3).
kindoptionalstring
values: LAYER_CLIPPED
default: "LAYER_CLIPPED"
LayerFieldvalues · 19
One editable field of a layer or of the canvas.
values: BOXTEXTCOLORFONTFONT_SIZEFONT_WEIGHTALIGNLINE_HEIGHTLETTER_SPACINGFILLSTROKEGEOMETRYSHADOWOPACITYBLENDVISIBLEFLIPCROPBACKGROUND
LayerOverride3
One field of one variant layer that differs from the parent; latest write per (layer_id, field) wins.
layerIdrequiredstring | null
valuerequiredBoxField | TextField | ColorField | FontField | FontSizeField | FontWeightField | AlignField | LineHeightField | LetterSpacingField | FillField | StrokeField | GeometryField | BlendField | ShadowField | OpacityField | VisibleField | FlipField | CropField | BackgroundField
atRevisionrequiredinteger
LeafEditabilityvalues · 3
How a page or agent may change one leaf of a row's change; derived from ELTA facts.
values: NOT_EDITABLEEDITABLEPRIVATE_WRITE_ONLY
LeafRule3
One editability fact for one action type at one JSON Pointer into change.
actionTypeKeyrequiredstring
pointerrequiredstring
editabilityrequiredLeafEditability
LetterSpacingField2
Override value: a text layer's letter spacing.
fieldoptionalstring
values: LETTER_SPACING
default: "LETTER_SPACING"
letterSpacingrequirednumber
LineGeometry2
A line across the box diagonal or midline (callout leader lines).
kindoptionalstring
values: LINE
default: "LINE"
diagonaloptionalboolean
default: false
LineHeightField2
Override value: a text layer's line height.
fieldoptionalstring
values: LINE_HEIGHT
default: "LINE_HEIGHT"
lineHeightrequirednumber
LinearGradient3
A fill across the box: angle 0 left-to-right, 90 top-to-bottom; rotates with the box.
stopsrequiredGradientStop[]
gradientoptionalstring
values: LINEAR
default: "LINEAR"
angleoptionalnumber
default: 90
ListBlock3
One bulleted or numbered list; items use the paragraph's inline subset.
kindoptionalstring
values: LIST
default: "LIST"
orderedrequiredboolean
itemsrequiredstring[]
ListingCapture1
A dataset read as the full current list on every run.
kindoptionalstring
Capture style: full current list.
values: listing
default: "listing"
ListingContent6
The seller-editable draft: PTD attributes, price, keyword terms and ordered images.
sellerSkurequiredstring
attributesoptionalobject
ourPriceoptionalnumber | string | null
keywordsoptionalstring[]
default: []
mainImageoptionalImageExportRef | OwnedPhotoRef | HttpsImageUrl | null
otherImagesoptionalImageExportRef[] | OwnedPhotoRef[] | HttpsImageUrl[]
default: []
ListingCreate3
Create one owner-fenced draft for one target; the body never carries an account.
replayKeyrequiredstring
targetrequiredListingTarget
contentrequiredListingContent
ListingOutcomevalues · 8
What happened to the draft's ADD, derived on every read from the live approval and ELTA reads.
values: NOT_FILEDAWAITING_APPROVALREJECTEDUNKNOWNNOT_YET_LISTEDLISTEDREVERT_PENDINGREMOVED
ListingReadBack3
ELTA's live read of the exact seller SKU after an applied ADD.
sellerSkurequiredstring
presentrequiredboolean
asinoptionalstring | null
ListingSnapshot15
The owner-visible draft at one revision with its pins, evidence, checks and live outcome.
artifectRefrequiredArtifectRef
revisionrequiredinteger
accountrequiredAccountRef
productTypeSchemarequiredProductTypeSchema
contentrequiredListingContent
keywordCandidatesoptionalKeywordCandidate[]
default: []
screeningrequiredScreeningResult
imageFindingsoptionalImageFinding[]
default: []
previewoptionalRowPreview | null
stagerequiredChangeListStage
guiderequiredStageGuide
outcomerequiredListingOutcome
approvaloptionalApprovalState | null
revertApprovaloptionalApprovalState | null
readBackoptionalListingReadBack | null
ListingStatusvalues · 4
Name the known availability states of one Product listing.
values: ACTIVEUNPUBLISHEDREMOVEDUNKNOWN
ListingTarget3
The ELTA store, its selected marketplace account and the product type of one draft.
storeIdrequiredstring
marketplaceIdrequiredstring
productTyperequiredstring
LlmProductDiversityvalues · 4
values: 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
Lookup5
One live provider read a source supports: answered on request, never stored.
keyrequiredstring
Live lookup identifier.
titlerequiredstring
Display name of this live lookup.
querySchemarequiredJsonValue
JSON Schema of the lookup input.
resultSchemarequiredJsonValue
JSON Schema of a lookup result.
requiresoptionalPermission[]
Permissions needed to run this lookup.
default: []
LookupPage3
One bounded page of live results; next_cursor is the provider's page token.
objectoptionalstring
Fixed tag marking this object as a lookup page.
values: lookup_page
default: "lookup_page"
rowsrequiredJsonValue[]
The result rows in the lookup's own shape.
nextCursoroptionalstring | 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.
storeIdrequiredstring
Owner-visible store to read.
lookupKeyrequiredstring
The declared lookup to run.
accountIdoptionalstring | null
Stored account to read; required when the source has several.
queryrequiredJsonValue
The lookup's own query payload.
pageoptionalPageRequest
Row limit and cursor for this read.
default: {"limit":200}
MatchedFact10
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.
clauseIndexoptionalinteger | null
Index of the query clause this fact satisfies; null when the fact carries no clause position.
basisrequiredEvidenceBasis
Evidence basis of this fact: RECORDED, MENTIONED or SIMILAR.
fieldOrCoderequiredstring
Field or feature code the fact was read from.
valuerequiredstring | integer | number | string | boolean
The stored value that matched the clause; money is an exact major-unit decimal.
observedAtrequiredstring | null
When the fact was observed; null when unknown.
measureoptionalstring | null
Trend column the fact read: VALUE, VELOCITY or RANK; null when the fact is not a feature.
pathoptionalRelationHop[]
Relation hops that connect the result to the fact; empty when the match needed none.
default: []
windowoptionalResolvedWindow | null
The resolved window this fact was read in; null when the fact carries none.
currencyBasisoptionalCurrencyBasis | null
How a monetary fact's currency is known (STATED or ASSUMED); null for a non-monetary fact.
estimationoptionalEstimationStatus | null
Whether a monetary fact's value is estimated; null for a non-monetary fact.
MaterialFactEstimate2
Use the system calculation for one key, without claiming seller authority.
choiceTypeoptionalstring
values: ESTIMATE
default: "ESTIMATE"
questionKeyrequiredstring
Question settled by system estimation.
MaterialFactResolution3
One seller-fact choice for one committed material question.
choiceTypeoptionalstring
values: RESOLUTION
default: "RESOLUTION"
questionKeyrequiredstring
Answered question identity.
resolutionrequiredReportMaterialResolution
Typed seller facts.
MaterialFactsAnswer2
Settle offered material keys in one non-empty, typed request.
decisionTypeoptionalstring
values: MATERIAL_FACTS
default: "MATERIAL_FACTS"
resolutionsrequiredMaterialFactResolution[] | MaterialFactEstimate[]
One resolution or estimate choice per offered key.
Maturityvalues · 2
Whether a day's value may still be restated by the source.
values: PROVISIONALFINAL
MaxLongestSideRule2
The longest side is at most pixels (Shopify 5000, Amazon 10000).
kindoptionalstring
values: MAX_LONGEST_SIDE
default: "MAX_LONGEST_SIDE"
pixelsrequiredinteger
Measure3
One declared numeric column, its unit and its display name.
keyrequiredstring
Numeric-column identifier; fact queries use its declared row path.
unitrequiredUnit
Physical unit of values in this column.
titlerequiredStoreLocalizedText
Display name of the column, in both languages.
MeasureChange7
One measure changed; values stay Decimal and an absent side is None, never 0.
entityrequiredstring
Stored entity key of the row that changed.
observedAtrequiredstring
Instant the new value became readable.
captureIdrequiredstring
The capture that made the new value readable.
kindoptionalstring
Discriminator marking this as a measure change.
values: measure
default: "measure"
measureKeyrequiredstring
The declared measure whose value changed.
oldValueoptionalnumber | string | null
The value before the change; none when there was none.
newValueoptionalnumber | 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.
countedrequiredinteger
totalrequiredinteger
MeasureDetailValue4
A MEASURE detail row: one declared measure's computed value for the cell.
objectoptionalstring
values: measure_detail_value
default: "measure_detail_value"
kindoptionalstring
values: MEASURE
default: "MEASURE"
keyrequiredstring
measureoptionalMeasureValue | null
MeasureFormatvalues · 4
How the frontend prints a measure value.
values: INTEGERDECIMALMONEYPERCENT
MeasureRow2
A detail row showing one measure's value.
kindoptionalstring
values: MEASURE
default: "MEASURE"
measurerequiredstring
MeasureValue4
One measure's value in one cell; coverage is set for DISTINCT and fact-based rules.
statusrequiredValueStatus
valueoptionalnumber | string | null
currencyoptionalstring | null
coverageoptionalMeasureCoverage | null
MeasuredKeywordEvidence8
One ELTA fact row the server read for this term: family, account, day, row identity, metric.
kindoptionalstring
values: MEASURED
default: "MEASURED"
familyKeyrequiredstring
accountIdrequiredstring
dayrequiredstring
sourceRowIdrequiredstring
sourceRowSha256requiredstring
measureKeyrequiredstring
valuerequirednumber | string
MediaKindvalues · 2
Name the common image or video media forms carried by entities.
values: IMAGEVIDEO
MediaRef6
Reference one public media URL without carrying its bytes.
kindrequiredMediaKind
sourceUrlrequiredstring
thumbnailUrloptionalstring | null
widthoptionalinteger | null
heightoptionalinteger | null
durationSecondsoptionalnumber | null
Metric5
One metric the plugin calculates per day, and how ELTA combines its days.
keyrequiredstring
Calculated metric identifier.
unitrequiredUnit
Physical unit of the metric's values.
levelsrequiredstring[]
Granularities where this metric is available.
meaningrequiredstring
Business meaning of this metric.
combinerequiredCombine
How daily values combine across a reporting range.
MetricClause4
Compare one typed metric against an integer, finite number, or Money.
kindoptionalstring
values: METRIC
default: "METRIC"
metricrequiredMetricKind
oprequiredstring
values: GTELTE
valuerequiredinteger | number | MinorUnitMoney
MetricCoveragevalues · 5
Describe whether a metric is a point, interval, cumulative, or board fact.
values: POINTINTERVALCUMULATIVEBOARDUNKNOWN
MetricGapvalues · 7
Why a range value is missing or qualified (mirror of the core enum).
values: NOT_CAPTUREDSOURCE_BLOCKEDINCOMPLETENOT_MEASURABLEMIXED_CURRENCYMIXED_TIMEZONERECALCULATING
MetricKindvalues · 46
Name entity and product-keyword measurements with stable units and periods.
values: 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.
metricrequiredMetricKind
unitrequiredMetricUnit
periodrequiredMetricPeriod
intValueoptionalinteger | null
floatValueoptionalnumber | null
moneyValueoptionalMinorUnitMoney | null
currencyBasisoptionalCurrencyBasis | null
marketoptionalstring | null
measuredAtoptionalstring | null
periodStartoptionalstring | null
periodEndoptionalstring | null
coverageoptionalMetricCoverage
default: "UNKNOWN"
estimationStatusoptionalEstimationStatus
default: "UNKNOWN"
confidenceoptionalnumber | null
originoptionalObservationOrigin
default: "CAPTURED"
changeoptionalboolean
default: false
MetricPage5
One bounded page of combined range values: the /v2/metrics/query response.
rowsrequiredMetricRangeValue[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | null
Why this page is empty and what selection or source to check.
objectoptionalstring
Fixed tag marking this object as a metric page.
values: metric_page
default: "metric_page"
MetricPeriodvalues · 6
Name the temporal coverage of a metric observation.
values: CURRENTD7D30LIFETIMEWEEKMONTH
MetricRangeValue11
One metric for one entity over the requested days, combined by its declared rule.
metricKeyrequiredstring
The metric this value is for.
entityrequiredstring
The entity these days were combined for.
valuerequirednumber | string | null
The combined value; none means no value, not zero.
availabilityrequiredAvailability
What is held for this metric, entity and range.
maturityrequiredMaturity
Whether the combined days may still be restated.
currencyoptionalstring | null
Currency of the value when it is money; none otherwise.
timezoneoptionalstring | null
Timezone the days were read in, when combining needs it.
accountIdoptionalstring | null
Set only when the value could not be combined across accounts.
gapsoptionalMetricGap[]
Reasons the value is missing or qualified.
default: []
provisionalDaysoptionalstring[]
Days in the range that may still be restated.
default: []
blockedoptionalBlockedLane[]
Lanes named with a source-blocked gap: which and why.
default: []
MetricUnitvalues · 6
THE one unit vocabulary for metric values; DPC imports it (K-08).
values: COUNTMONEYRATIORATINGSCOREDURATION_MS
MetricsRequest7
A serving read of one or more metrics over a date range, current values only.
metricKeysrequiredstring[]
Metrics to read; at least one.
levelrequiredstring
The entity level key the caller wants values at.
daysrequiredDayRange
Inclusive reporting days in the account's timezone.
storeIdsoptionalstring[]
Stores to include; empty selects the asserted owner's stores.
default: []
accountIdsoptionalstring[]
Accounts to read; empty means every account of the owner.
default: []
entitiesoptionalstring[]
Stored entity keys to read; empty means every entity.
default: []
pageoptionalPageRequest
Row limit and cursor for this read.
default: {"limit":200}
MinLongestSideRule2
The longest side is at least pixels (Amazon: 1000 enables zoom).
kindoptionalstring
values: MIN_LONGEST_SIDE
default: "MIN_LONGEST_SIDE"
pixelsrequiredinteger
Monitor13
One user-owned standing question with its watches, schedule and delivery.
monitorIdrequiredstring
ownerrequiredMonitorOwnerScope
confirmedByoptionalstring | null
titlerequiredstring
languageoptionalLanguage
default: "ENGLISH"
statusrequiredMonitorStatus
pauseReasonoptionalMonitorPauseReason | null
specRevisionrequiredinteger
watchesoptionalMonitorWatch[]
default: []
cadenceoptionalMonitorCadence | null
deliveryoptionalMonitorDelivery
default: {"chat":true,"email":false}
agentrequiredMonitorAgentBinding
nextDueAtoptionalstring | null
MonitorCadence6
One schedule; next_due is the only schedule math in the estate.
unitrequiredMonitorCadenceUnit
everyrequiredinteger
atoptionalstring | null
weekdayoptionalinteger | null
dayOfMonthoptionalinteger | null
timezonerequiredstring
MonitorConfirmPage6
The confirm input page, "What we'll monitor": watches, schedule, next run and the request estimate.
pageoptionalstring
values: CONFIRM
default: "CONFIRM"
monitorrequiredMonitor
nextRunAtrequiredstring
checksPerDayrequirednumber | string
requestsPerDayrequirednumber | string
expiresAtrequiredstring
MonitorCycle10
One scheduled check of one monitor, running the frozen spec_revision (P22).
monitorIdrequiredstring
seqrequiredinteger
specRevisionrequiredinteger
dueAtrequiredstring
staterequiredMonitorCycleState
watchesrequiredMonitorWatchCycle[]
baselinerequiredboolean
startedAtrequiredstring
finishedAtoptionalstring | null
deliveriesoptionalMonitorChannelDelivery[]
default: []
MonitorDelivery2
Per-monitor channel toggles (P23); the inbox notification is always filed for a reported cycle.
chatoptionalboolean
default: true
emailoptionalboolean
default: false
MonitorFinding3
One reported item of one cycle: the item as seen, and what changed.
findingKeyrequiredMonitorFindingKey
itemrequiredMonitorFindingItem
changerequiredMonitorNewItem | MonitorValueChange | MonitorRankMove
MonitorSetupPage5
The setup input page: the capability catalog frozen at create, and the cadence floor.
pageoptionalstring
values: SETUP
default: "SETUP"
monitorrequiredMonitor
offersrequiredMonitorCapabilityOffer[]
minIntervalrequiredstring
expiresAtrequiredstring
MonitorSnapshot3
What the host reads to show a monitor and derive its artifect stage (from status + open cycle only).
monitorrequiredMonitor
openCycleoptionalMonitorCycle | null
lastCycleoptionalMonitorCycle | null
MonitorStatusvalues · 5
Lifecycle of one monitor; the artifect stage is derived from it and the open cycle, never stored.
values: SETTING_UPAWAITING_CONFIRMACTIVEPAUSEDSTOPPED
MonitorWatch11
One stored watch: the compiled spec under the core's stable watch_key, with the request it came from.
titlerequiredstring
channelLabelrequiredstring
subjectLabelrequiredstring
policyrequiredMonitorFindingPolicy
sourceKeyrequiredstring
fetchesrequiredboolean
minIntervalrequiredstring
readsPerCheckrequiredinteger
dataAsOfoptionalstring | null
watchKeyrequiredstring
requestrequiredMonitorWatchRequest
MonthlyStorageFee8
monthrequiredinteger
isDangerousGoodsrequiredboolean
productSizeTierrequiredstring
feeCategoryrequiredstring
volumeCubicrequirednumber
cubicUnitrequiredstring
values: ftm
perCubicStorageFeerequirednumber
storageFeerequirednumber
Motif11
ONE MOTIF NODE — a group of elements several creators independently did (T1; replacing the R54 one-record motif).
kindoptionalstring
Node discriminator; always MOTIF.
values: MOTIF
default: "MOTIF"
keyrequiredstring
Identity key 'motif:{first member element key}'; a merge keeps the older key.
namerequiredstring
Display name of the motif.
elementKindrequiredConceptKind
Concept kind of the elements this motif groups.
sectionsrequiredMotifSection[]
Named sections this motif belongs to; empty when it belongs to none.
featuresrequiredFeatureValue[]
Windowed motif figures (creators, posts, quality) with velocity and rank.
trendoptionalMotifTrend | null
Read-time trending reading over the reader's own window; null when the read names no trending window.
dailyPostsrequiredinteger[]
Posts per day across the requested window, oldest first, ending at the window end day; length equals the window's days.
productsoptionalRelationRef[]
Distinct products featured by the motif's member content.
default: []
membersTotalrequiredinteger
Number of member elements grouped by this motif.
examplesoptionalMotifMember[]
Newest-first member examples, at most five.
default: []
MotifMember10
ONE member element shown on a motif card (T1).
elementKeyrequiredstring
Key of the member element inside the motif.
contentRefrequiredNodeRef
Scoped reference to the content the element was extracted from.
creatorRefrequiredNodeRef | null
Scoped reference to the content's creator; null when it has no author.
patternrequiredstring
Generic pattern label of the element, without brand or product names.
appearancerequiredstring
How the element appears: subject, action, framing and on-screen text.
instancerequiredstring | null
This content's brand or product specifics for the pattern; null when none.
evidencerequiredFrameEvidence[] | SpanEvidence[]
Frame or transcript citations that support this member.
publishedAtrequiredstring | null
Publication time of the member content; null when unknown.
creatorHandleoptionalstring | null
Handle of the member content's creator, when known.
viewsoptionalinteger | null
Latest view count of the member content, when known.
MotifQuery6
One named motif section and window with an optional row ceiling.
daysoptionalinteger | null
Length in days of the current window; null when start/end state the span.
startoptionalstring | null
Inclusive first day of an explicit span.
endoptionalstring | null
Inclusive last day of the current window; null uses the newest member publication day in scope.
sectionrequiredMotifSection
termsoptionalstring[]
Word-match terms tested against each member's label or instance, or the member content's searchable fields; at most eight.
default: []
maxRowsoptionalinteger | 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.
MotifSectionvalues · 2
THE TWO NAMED MOTIF QUESTIONS the platform asks of itself on every page load, as a closed vocabulary rather than free text.
values: SPREADINGEARLY
MotifTrend8
ONE MOTIF'S TRENDING READING for the resolved window and the equally long window immediately before it (T2, owner rulings Q6 and Q9 of 2026-09-26).
scorerequirednumber
Trending score: creators x growth x buzz x freshness.
growthrequirednumber
Current creators over previous creators, plus one each; the previous count is 0 when nothing published in the previous window.
buzzrequirednumber
Log10(1 + likes + 2 x comments) over the current window.
freshnessrequirednumber
Recency decay of the newest member publication, in (0, 1].
ageDaysrequiredinteger
Days from the window's end day back to the newest in-window member publication.
newestPublishedAtrequiredstring
Publication time of the newest member inside the current window.
currentrequiredMotifWindowFigures
Member figures of the current window.
previousoptionalMotifWindowFigures | null
Member figures of the equally long previous window; null when nothing published in it.
MotifWindow3
WHICH CALENDAR DAYS one motif trending read compares (T2, owner rulings Q2 and Q9 of 2026-09-26).
daysoptionalinteger | null
Length in days of the current window; null when start/end state the span.
startoptionalstring | null
Inclusive first day of an explicit span.
endoptionalstring | 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 (T2, 2026-09-26).
creatorsrequiredinteger
Distinct member creators who published inside the window.
postsrequiredinteger
Distinct member contents published inside the window.
likesrequiredinteger
Likes summed over the window's member contents; a missing count is 0.
commentsrequiredinteger
Comments summed over the window's member contents; a missing count is 0.
viewsrequiredinteger
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).
actionoptionalstring
values: MOVE_BLOCK
default: "MOVE_BLOCK"
sectionKeyrequiredstring
blockKeyrequiredstring
afteroptionalstring | null
MoveSection3
Move one section within its page to after another entry (None: to the end).
actionoptionalstring
values: MOVE_SECTION
default: "MOVE_SECTION"
sectionKeyrequiredstring
afteroptionalstring | null
NewChangeRow2
A new account-free row action and the one-sentence rationale shown to the person.
actionrequiredUnboundAction
rationalerequiredstring
NewKeblePage2
The store page Keble creates at publish for a Keble landing-page template (CD-2: unpublished).
titlerequiredstring
handlerequiredstring
NewThemePage4
FROZEN (D-03): removed in the first theme release after SEO and GEO migrate.
titlerequiredstring
handlerequiredstring
templateSuffixrequiredstring
bodyrequiredHtmlSegment[] | ExistingShopifyFile[] | ShopifyRemoteImage[]
NoArguments0
The request of an operation that takes nothing but its caller (a catalog, a freshness report).
No fields.
NoBadgeClaimsRule1
No visible text layer carries a badge or claim word from the package's fixed zh/en lexicon (hint, D-07).
kindoptionalstring
values: NO_BADGE_CLAIMS
default: "NO_BADGE_CLAIMS"
NoEdgeCropRule2
At most max_hidden_ratio of the product's content box is hidden by the canvas edge or a crop (hint, D-07).
kindoptionalstring
values: NO_EDGE_CROP
default: "NO_EDGE_CROP"
maxHiddenRatiorequirednumber
NoGraphicsRule1
Only product image layers over the background: no shapes, logos or decorations (Amazon main).
kindoptionalstring
values: NO_GRAPHICS
default: "NO_GRAPHICS"
NoTextRule1
The design has no visible text layer (Amazon main image: no text or pricing).
kindoptionalstring
values: NO_TEXT
default: "NO_TEXT"
NodeHit7
A returned typed node and the source refs that led to it.
itemrequiredProduct | Store | Creator | Content | Keyword | Contact | PlatformDefinedCategory | Brand | ProductFamily | Motif | Concept
The returned node, either a source entity or a declared derived kind.
viaoptionalNodeRef[]
Scoped source references that led to this node.
default: []
analysisoptionalAnalysis | null
Analyzed facts attached when the analyzed store has them; null otherwise.
recordKeyrequiredstring
The stored row's key, else stable_key_of over the subject claim.
familyKeyoptionalstring | null
Product family key shared by this row's siblings; null when the row belongs to no family.
evidenceoptionalMatchedFact[]
Matched facts explaining why this hit is here; at most 8.
default: []
promotedoptionalboolean
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.
default: false
NodeKindvalues · 11
Every node kind one DP search can start from or ask for (R42).
values: PRODUCTSTORECREATORCONTENTKEYWORDCONTACTPLATFORM_DEFINED_CATEGORYBRANDPRODUCT_FAMILYMOTIFCONCEPT
NodeRef3
One kind- and channel-scoped reference used in DP, never a bare ID list.
kindrequiredNodeKind
Node kind that defines the key namespace.
channeloptionalChannel | null
Source channel the referenced record lives in; null for a derived node's own scope.
keyrequiredstring
Kind- and scope-qualified key of the referenced node.
NotificationCreate4
Immutable generic producer-filed note that people read per source event.
kindoptionalstring
values: NOTIFICATION
default: "NOTIFICATION"
contentrequiredItemContent
keyrequiredstring
refrequiredstring
NotificationItem9
A stored note with no shared status; who read it lives in per-person receipts.
idrequiredstring
ownerrequiredOwnerRef
currentrequiredItemContent
created_atrequiredstring
revisionrequiredinteger
created_byoptionalActorRef | null
kindoptionalstring
values: NOTIFICATION
default: "NOTIFICATION"
objectoptionalstring
values: notification_item
default: "notification_item"
creationrequiredNotificationCreate
ObjectKindvalues · 7
Name the seven source entity kinds returned by Data Infra.
values: PRODUCTSTORECREATORCONTENTKEYWORDCONTACTPLATFORM_DEFINED_CATEGORY
ObjectOutline20
One object as the agent reads it; focus objects carry their resolved layers and overrides.
objectIdrequiredstring
kindrequiredBoardObjectKind
namerequiredstring
positionrequiredBoardPoint
staterequiredObjectState
changedAtRevisionrequiredinteger
sourceoptionalContentSource | null
parentIdoptionalstring | null
recipeoptionalVariantRecipe | null
presetoptionalstring | null
sizeoptionalPixelSize | null
backgroundoptionalColor | null
layersoptionalImageLayer[] | TextLayer[] | ShapeLayer[] | GroupLayer[] | null
overridesoptionalLayerOverride[] | null
stalePartsoptionalStalePart[]
default: []
unresolvedoptionalUnresolvedBrandRef[]
default: []
findingsoptionalSlotFinding[]
default: []
columnsoptionalPlanColumn[] | null
rowsoptionalPlanRow[] | null
kitIdoptionalstring | null
ObjectStatevalues · 7
The one badge an object shows; derived, never stored. Precedence top to bottom.
values: GENERATINGQUEUEDBROKENFAILEDSTALELOCKEDREADY
ObjectStatus4
One non-READY object's badge, lock and the steps behind it (SetStatus.objects).
objectIdrequiredstring
staterequiredObjectState
lockedrequiredboolean
stepIdsoptionalstring[]
default: []
ObservationOriginvalues · 2
Label who measured one metric value (K-09, S-03).
values: SOURCE_REPORTEDCAPTURED
OpacityField2
Override value: a layer's opacity.
fieldoptionalstring
values: OPACITY
default: "OPACITY"
opacityrequirednumber
OperationQuote2
How many paid steps of one operation a batch would admit.
operationrequiredImageOperation
stepsrequiredinteger
OptionRecord5
One option of a dimension; banded options keep their bounds.
keyrequiredstring
labelrequiredLocalizedText
lowoptionalnumber | string | null
highoptionalnumber | string | null
catchAlloptionalboolean
default: false
OrderDesigns3
Move one object in the board order (z-order and LAYERS tree): directly above above, or to the bottom.
actionoptionalstring
values: ORDER_DESIGNS
default: "ORDER_DESIGNS"
objectIdrequiredstring
aboverequiredstring | null
OrderLayer4
Move one layer in the stack: directly above above, or to the bottom when None.
actionoptionalstring
values: ORDER_LAYER
default: "ORDER_LAYER"
designIdrequiredstring
layerIdrequiredstring
aboverequiredstring | null
OwnedPhotoRef1
The consumer-held reference to one photo the owner uploaded through add_photos.
assetrequiredAssetRef
OwnerKindvalues · 2
The two supported item-list owners.
values: USERORG
OwnerRef2
One user or organization list selected by the authenticated host.
kindrequiredOwnerKind
idrequiredstring
OwnerTypevalues · 3
values: USERORGROOT
PageProgress2
How far one page got against what the caller asked for (K-27).
requestedrequiredinteger
Rows the caller asked for.
hopsoptionalHopProgress[]
One entry per executed step, in plan order.
default: []
PageRequest2
How one bounded read pages: a row limit and the opaque cursor that continues it.
limitoptionalinteger
Maximum rows in this page.
default: 200
cursoroptionalstring | null
Opaque cursor from the previous page.
PaidStepStatevalues · 9
Lifecycle of one paid step (one attempt): admitted in the request, run by the worker, landed alone.
values: RESERVEDQUEUEDRUNNINGSUCCEEDEDAPPLIEDSKIPPEDFAILEDUNKNOWNCANCELLED
PaidStepView8
One paid step as the agent and the editor see it.
attemptIdrequiredstring
actionrequiredCutOutProduct | GenerateScene | GenerateDecor
staterequiredPaidStepState
refusaloptionalEditRefusalCode | null
failureoptionalProviderFailureCode | null
revisionoptionalinteger | null
queuedAtoptionalstring | null
waitingForUnlockoptionalboolean
default: false
ParagraphBlock2
One paragraph of plain text with inline **strong**, *em* and [label](https://...).
kindoptionalstring
values: PARAGRAPH
default: "PARAGRAPH"
textrequiredstring
PathGeometry2
A library outline filling the box, stretched/rotated by it; no free-form path data (VV-1).
kindoptionalstring
values: PATH
default: "PATH"
pathrequiredPathKey
PathKeyvalues · 20
One immutable curated outline from the keble-core 1000-unit square path library (VV-1).
values: SEAL_SCALLOPRIBBON_BANNERSPEECH_BUBBLEPRICE_TAGTORN_BANDBRUSH_BANDBRUSH_SWIRLBRUSH_STROKEBRUSH_UNDERLINESPLASHBLOB_SOFTBLOB_WAVEWAVE_EDGEFLAMELEAFDROPHEARTCHECKARROWSPARKLE
PeerIntentvalues · 2
What a same-kind search means when it asks for peers (K-37).
values: COMPETITORSLOOKALIKES
Permission4
One provider-side permission a read or write needs, as the plugin declares it.
keyrequiredstring
The declared permission key.
titlerequiredstring
Short label of the permission.
grantedByrequiredGrantedBy
Who can grant it, which decides who must act.
grantHintrequiredStoreLocalizedText
What the grantor must change and where, in both languages.
Phasevalues · 4
The four user-visible phases (the existing stepper), subject-neutral.
values: SCOPEITEMSDIMENSIONSANALYSIS
PhaseStatusvalues · 4
WAITING_FOR_USER is distinct from WORKING: busy is not idle (existing ruling).
values: WORKINGWAITING_FOR_USERCOMPLETEFAILED
PhotoLinkProblem3
Why one owner photo link produced no photo; the same shape for every code.
urlrequiredstring
coderequiredGuardedFetchRefusalCode | PhotoLinkTransportCode
detailrequiredstring
PhotoLinkTransportCodevalues · 1
A link's transport fault that is not a policy refusal (owned here; keble-helpers stays raise-only).
values: UNREACHABLE
PhotoLinksAdded2
The one owner-scoped intake result plus one typed problem per link that produced no photo.
intakerequiredPhotosAdded | IntakeRefusal
problemsoptionalPhotoLinkProblem[]
default: []
PhotoLinksRequest2
HTTPS images stored as owner photos or scene-only references in one bounded intake.
urlsrequiredstring[]
originoptionalstring
values: UPLOADREFERENCE
default: "UPLOAD"
PhotosAdded4
The accepted uploads, in upload order, and their hints.
photosrequiredOwnedPhotoRef[]
referencesoptionalAssetRef[]
default: []
findingsoptionalIntakeFinding[]
default: []
defaultStarterPaidStepsrequiredinteger
PixelSize2
A raster size in pixels.
widthrequiredinteger
heightrequiredinteger
PlaceBrandKit5
Add a card showing one owner kit (UNKNOWN_BRAND_KIT for an unknown or foreign kit).
actionoptionalstring
values: PLACE_BRAND_KIT
default: "PLACE_BRAND_KIT"
objectIdrequiredstring
namerequiredstring
kitIdrequiredstring
positionoptionalBoardPoint | null
PlaceholderBinding2
A plan column whose cell text replaces every source text layer carrying this placeholder.
bindingoptionalstring
values: PLACEHOLDER
default: "PLACEHOLDER"
placeholderrequiredstring
values: bodycallout_1callout_2callout_3headlineproduct_photo
PlanColumn3
One plan column; binding=None is a note column the agent reads (angle, audience).
columnIdrequiredstring
titlerequiredstring
bindingoptionalTextLayerBinding | PlaceholderBinding | SceneCueBinding | null
PlanRow3
One plan row: cells maps a column id to its text; name names the generated image.
rowIdrequiredstring
cellsoptionalobject
nameoptionalstring | null
PlanRowRef2
One row of one plan; held by the variant that row produced (the only row -> image link).
planIdrequiredstring
rowIdrequiredstring
PlannedPost6
One row of the post plan (1.2): topic, abstract, tone, length and intended images.
postKeyrequiredstring
topicrequiredstring
abstractrequiredstring
toneKeyrequiredstring
targetWordsrequiredinteger
imagePlanrequiredstring
PlatformDefinedCategory10
Represent one catalog category node that a platform itself defines.
kindoptionalstring
values: PLATFORM_DEFINED_CATEGORY
default: "PLATFORM_DEFINED_CATEGORY"
channelrequiredChannel
externalIdrequiredstring
namerequiredstring
parentRefoptionalSourceSubject | null
pathoptionalstring[]
default: []
marketoptionalstring | null
metricsoptionalMetricObservation[]
default: []
observedAtrequiredstring
provenancerequiredProvenance
PluginDeclaration5
Everything one plugin package declares: sources, metrics and write-family switches.
keyrequiredstring
Catalog plugin identifier.
titlerequiredstring
Display name of this plugin.
sourcesrequiredSource[]
Sources this plugin can connect.
metricsoptionalMetric[]
Metrics this plugin calculates; empty for live-read-only plugins.
default: []
actionFamiliesoptionalActionFamily[]
Unique owner-facing families used by this plugin's actions.
default: []
PolicyCitation4
The captured official source passage behind one rule.
policyUrlrequiredstring
sectionrequiredstring
capturedOnrequiredstring
snapshotSha256requiredstring
PolygonGeometry3
A polygon (inner_ratio=1) or star inscribed in the box, first corner up (D-13, VV-1).
kindoptionalstring
values: POLYGON
default: "POLYGON"
cornersrequiredinteger
innerRatiooptionalnumber
default: 1
PositioningCellQuery3
Ask for one cell's detail dialog, the reading client's cell read.
objectoptionalstring
values: positioning_cell
default: "positioning_cell"
cellKeyrequiredstring
viewIdoptionalstring | null
PositioningDetail3
One answered detail query: the reading client's answer plus the labels it uses.
objectoptionalstring
values: positioning_detail
default: "positioning_detail"
answerrequiredCellDetail | PositioningItemPage
labelsrequiredPositioningDetailLabels
PositioningDetailLabels7
The labels one detail answer needs to be read by a person, and nothing more.
objectoptionalstring
values: positioning_detail_labels
default: "positioning_detail_labels"
itemNounrequiredLocalizedText
dimensionsoptionalDimensionRecord[]
default: []
measuresoptionalRoomPublicMeasure[]
default: []
assessmentsoptionalRoomPublicAssessment[]
default: []
factsoptionalFactSpec[]
default: []
criterionoptionalLocalizedText | null
PositioningItemsQuery3
Ask for one page of items, the reading client's items read.
objectoptionalstring
values: positioning_items
default: "positioning_items"
cellKeyoptionalstring | null
cursoroptionalstring | null
PositioningRecord12
One positioning: its one plugin, its setup, its review setting, and its stepper.
refrequiredPositioningRef
positioningIdrequiredstring
gridIdoptionalstring | null
pluginIdrequiredstring
languageoptionalLanguage
The language every model-written, user-visible positioning text must use.
default: "ENGLISH"
briefrequiredstring
ownerNoteoptionalstring
default: ""
setupoptionalobject | null
reviewoptionalobject
phaserequiredPhase
statusrequiredPhaseStatus
createdAtrequiredstring
PositioningRef2
One positioning, addressed by its owner and the host task that holds it.
ownerrequiredOwnerScope
taskIdrequiredstring
PostDraft3
POST_DRAFTS (1.4): one planned post written in its tone with text and images mixed.
stepoptionalstring
values: POST_DRAFTS
default: "POST_DRAFTS"
postKeyrequiredstring
postrequiredComposedPost
PostEntry3
One planned post and its latest content; post is empty until its draft lands.
planrequiredPlannedPost
postoptionalComposedPost | null
reviewNotesoptionalstring | null
PostPlan3
POST_PLAN (1.2): the tones, then how many posts in which order; the count bound is a Setting.
stepoptionalstring
values: POST_PLAN
default: "POST_PLAN"
tonesrequiredToneSpec[]
postsrequiredPlannedPost[]
PostSelfReview4
SELF_REVIEW (1.5): the agent's own pass for a natural, human tone, and the revised post.
stepoptionalstring
values: SELF_REVIEW
default: "SELF_REVIEW"
postKeyrequiredstring
reviewNotesrequiredstring
postrequiredComposedPost
PostSet8
The whole guided state: direction, plan with tones and posts, style examples, the parked step.
statusrequiredPostSetStatus
parkedSteprequiredBlogStep | null
directionoptionalBlogDirection | null
tonesoptionalToneSpec[]
default: []
postsoptionalPostEntry[]
default: []
styleExamplesoptionalStyleExample[]
default: []
sampleoptionalSampleConfirmation | null
reviewRoundoptionalinteger
default: 0
PostSetStatusvalues · 2
Where the post set stands.
values: WAITING_FOR_AGENTREADY
PreviewSession4
The run's one preview copy: which theme, copied from which target, and which revision it holds.
copyThemeIdrequiredstring
createdFromThemeIdrequiredstring
documentRevisionOnCopyoptionalinteger | null
createdAtrequiredstring
PreviewView3
Stateless answer to a preview request, with outcomes and diffs aligned to its batch.
batchrequiredActionBatch
Requested action batch; nothing is persisted by preview.
previewsrequiredActionOutcome[]
One live outcome per action, in order.
diffsrequiredActionDiff[]
One derived diff per action, in order.
PriceClause5
Apply a typed monetary bound without binary-float price values.
kindoptionalstring
values: PRICE
default: "PRICE"
oprequiredstring
values: GTELTE
valuerequiredMinorUnitMoney
metricoptionalstring
values: pricelist_price
default: "price"
averageDaysoptionalinteger | null
Priorityvalues · 2
The initial human-attention levels.
values: NORMALCRITICAL
PrivateValue3
One private leaf held outside its row; never returned by any read (W3.5 G3).
rowKeyrequiredstring
pointerrequiredstring
valuerequiredJsonValue
Product27
Represent one provider-neutral sellable item.
kindoptionalstring
values: PRODUCT
default: "PRODUCT"
channelrequiredChannel
externalIdrequiredstring
titleoptionalstring | null
descriptionoptionalstring | null
brandoptionalstring | null
manufactureroptionalstring | null
modelNumberoptionalstring | null
categoryoptionalstring | null
categoryPathoptionalstring[]
default: []
tagsoptionalstring[]
default: []
marketoptionalstring | null
urloptionalstring | null
featuresoptionalstring[]
default: []
attributesoptionalProductOption[]
default: []
publishedAtoptionalstring | null
releasedAtoptionalstring | null
firstTrackedAtoptionalstring | null
storeRefoptionalSourceSubject | null
storeNameoptionalstring | null
identitiesoptionalExternalIdentity[]
default: []
variantsoptionalProductVariant[]
default: []
metricsoptionalMetricObservation[]
default: []
mediaoptionalMediaRef[]
default: []
statusoptionalListingStatus
default: "ACTIVE"
observedAtrequiredstring
provenancerequiredProvenance
ProductContent9
The editable unpublished product draft; the whole value becomes one product.create.
titlerequiredstring
handleStemrequiredstring
descriptionHtmloptionalstring | null
vendoroptionalstring | null
productTypeoptionalstring | null
tagsoptionalstring[]
default: []
optionsoptionalShopifyProductOption[]
default: []
variantsrequiredProductVariantFields[]
imagesoptionalExistingShopifyFile[] | ShopifyRemoteImage[] | PostExportedImage[]
default: []
ProductCreateRequest3
Create one draft pinned to exactly one ELTA store; it carries only store_id.
replayKeyrequiredstring
storeIdrequiredstring
contentrequiredProductContent
ProductFamily4
A DP-derived product family with its count; members are resolved through the `VARIANT_OF` relation, never through an unscoped array.
kindoptionalstring
Node discriminator; always PRODUCT_FAMILY.
values: PRODUCT_FAMILY
default: "PRODUCT_FAMILY"
keyrequiredstring
The product family's own analyzed key.
titlerequiredstring | null
Display title of the family; null when the source states none.
memberCountrequiredinteger
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%).
kindoptionalstring
values: PRODUCT_FILL
default: "PRODUCT_FILL"
minRatiorequirednumber
ProductImagesDetailViewvalues · 1
What may be read in detail about one image set.
values: EXPORTS
ProductOptionValue2
One option name/value pair that places a variant in the product's options.
optionNamerequiredstring
valuerequiredstring
ProductProposalFiling3
The ids of one FiledApproval this artifect keeps, and which ELTA action type it filed.
proposalIdrequiredstring
inboxItemIdrequiredstring
actionTypeKeyrequiredstring
ProductReleasedTypevalues · 4
values: UNIDENTIFIABLEOLD_RELEASEDNEW_RELEASEDNEW_RELEASED_ON_OLD_ASIN
ProductSimilarTypevalues · 4
values: 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.
artifectRefrequiredArtifectRef
storeIdrequiredstring
accountrequiredAccountRef
revisionrequiredinteger
contentrequiredProductContent
screeningrequiredScreeningResult
proposalsoptionalProductProposalFiling[]
default: []
filingIntentoptionalStagedProposal | null
approvalsoptionalApprovalState[]
default: []
ProductTypeSchema2
A resolved seller-specific definition with the pin that identifies its bytes.
referencerequiredProductTypeSchemaRef
schemaDocumentrequiredobject
ProductTypeSchemaRef3
Pin one target to the exact seller-specific Product Type Definition version and bytes.
targetrequiredListingTarget
versionrequiredstring
schemaSha256requiredstring
ProductVariant6
Retain the observed SKU, model number, and options of one Product variant.
skuoptionalstring | null
modelNumberoptionalstring | null
optionsoptionalProductOption[]
default: []
refoptionalSourceSubject | null
priceoptionalMinorUnitMoney | null
availableoptionalboolean | null
ProductVariantFields4
One variant sent in the same productSet call: option values, price, SKU and barcode.
optionValuesoptionalProductOptionValue[]
default: []
pricerequirednumber | string
skuoptionalstring | null
barcodeoptionalstring | null
ProfileInputsAdjustment11
Patch the seller's setup after finishing, then re-price the cohort.
suggestedPurchasingCostoptionalSuggestedPurchasingCost | null
The seller's own purchasing cost for one benchmark ASIN; never a Keble estimate.
acosLowerboundoptionalinteger | null
ACOS lower bound, whole percent.
acosUpperboundoptionalinteger | null
ACOS upper bound, whole percent.
fixedLengthoptionalnumber | null
Fixed length.
fixedWidthoptionalnumber | null
Fixed width.
fixedHeightoptionalnumber | null
Fixed height.
fixedLengthUnitoptionalstring | null
Unit of the fixed size; None means cm.
fixedWeightoptionalnumber | null
Fixed weight.
fixedWeightUnitoptionalstring | null
Unit of the fixed weight; None means g.
investmentDifficultyAmountThresholdoptionalMinorUnitMoney | null
Entry-budget threshold.
adjustmentTypeoptionalstring
values: PROFILE_INPUTS
default: "PROFILE_INPUTS"
ProfitBreakdown9
One coherent scenario's exact selling-price-to-profit waterfall.
scenarioKeyrequiredstring
rolerequiredScenarioRole
shippingModerequiredShippingMode
isPeakPeriodrequiredboolean
sellingPricerequiredMinorUnitMoney
linesrequiredProfitBreakdownLine[]
profitrequiredMinorUnitMoney
marginrequirednumber
sizingrequiredSizingDetail
ProfitBreakdownLine7
One settled deduction between selling price and unit profit.
kindrequiredProfitLineKind
amountrequiredMinorUnitMoney
shareOfPricerequirednumber
sourcerequiredEstimateSource
ratiooptionalnumber | null
storageDetailoptionalStorageLineDetail | null
firstLegDetailoptionalFirstLegLineDetail | null
ProfitEnvelope8
Margin range produced by evaluating every coherent scenario.
expectedrequiredProfitBreakdown
optimisticrequiredProfitBreakdown
pessimisticrequiredProfitBreakdown
tierProbesrequiredProfitBreakdown[]
marginLowerrequirednumber
marginUpperrequirednumber
marginBoundScenarioKeysrequiredany[]
profitBoundScenarioKeysrequiredany[]
ProfitInputOverride4
Named ASINs whose physical or purchasing inputs are replaced.
asinsrequiredstring[]
ASINs this override applies to.
dimensionsoptionalReportMaterialDimensionsAnswer | null
Replacement three-axis dimensions.
weightoptionalReportMaterialWeightAnswer | null
Replacement weight.
unitCostoptionalReportMaterialCostAnswer | null
Replacement purchasing unit cost bounds.
ProfitInputsAdjustment2
Replace profit-calculator inputs, then recompute the whole report.
adjustmentTypeoptionalstring
values: PROFIT_INPUTS
default: "PROFIT_INPUTS"
overridesrequiredProfitInputOverride[]
One override group per target ASIN set.
ProfitLineKindvalues · 8
One deductible economic line between selling price and unit profit.
values: PURCHASING_COSTFIRST_LEG_SHIPPINGFBA_FULFILLMENTSTORAGEREFERRALVATADSRETURNS
ProgressTaskStagevalues · 3
values: PENDINGSUCCESSFAILURE
ProgressiveReportSnapshot18
Everything a reader needs about a V3 report at one committed revision.
createdoptionalstring
updatedoptionalstring
formatVersionoptionalstring
Frozen V3 read-model format identity.
values: 3.0.0
default: "3.0.0"
rootTaskIdrequiredstring
Owning keble-task identity.
reportRevisionrequiredinteger
Revision this snapshot reads.
amazonMarketplacerequiredAmazonMarketplace
PRODUCT market this report actually analysed.
completenessrequiredReportCompleteness
Completeness right now.
taskStagerequiredProgressTaskStage
Owning task stage.
readyUnitsoptionalReportUnitDescriptor[]
Phases with an accepted artifact.
default: []
missingUnitsoptionalReportGapDescriptor[]
Phases with an explicit typed gap.
default: []
conclusionoptionalReportConclusion | null
Business verdict, when one was reached.
terminalStateoptionalReportTerminalState | null
Operational stop state, when the run stopped.
listingsoptionalReportListingPage | null
First cursor page of listing summaries.
listingSummariesoptionalReportListingSummaryView[] | null
Optional UNSLICED listing summaries for the whole committed LISTING_BUILD cohort; None on the Keble-line read.
estimationMethodologyoptionalReportEstimationMethodologyView | null
How every material verdict was reached.
openMaterialQuestionsoptionalReportMaterialQuestion[]
Typed material questions awaiting an owner answer.
default: []
updatedAtrequiredstring
Instant the read revision was committed.
seoIndexableoptionalboolean
Backend-owned crawlability decision.
default: false
ProposalAttribution3
Why a proposal exists and which origin asked for it; display data that grants no authority.
originKindrequiredstring
Opaque origin label, such as an Artifect kind.
originRefrequiredstring
Origin reference, such as an Artifect id.
reasonoptionalstring | null
Short display reason, if any.
ProposalDecline3
Who declined an open proposal, when, and their optional display reason.
actorrequiredStoreActorRef
Verified actor that declined the proposal.
declinedAtrequiredstring
Instant the proposal was declined.
reasonoptionalstring | null
Display reason for declining.
ProposalFiled2
The result of filing an ELTA proposal and its SYSTEM-created approval.
proposalrequiredProposalView
itemrequiredApprovalItem
ProposalFiling2
The two ids of one FiledApproval an artifect keeps: what to view and what to revert.
proposalIdrequiredstring
inboxItemIdrequiredstring
ProposalRef2
Reference to the exact immutable proposal preview shown to a human.
sourcerequiredstring
idrequiredstring
ProposalStatevalues · 5
Where a proposal stands in its one-time approval and apply lifecycle.
values: PROPOSEDAPPLYINGAPPLIEDEXPIREDDECLINED
ProposalTargetvalues · 2
What a model proposal is asked for.
values: SCOPEDIMENSIONS
ProposalView2
The response shared by every proposal route: stored proposal plus derived action diffs.
proposalrequiredActionProposal
Stored proposal, preview or applied result.
diffsrequiredActionDiff[]
One derived diff per action, in batch order.
Propose4
Ask the model for a new proposal, steered by a note (today's REFINE answer, and add-dimension).
typeoptionalstring
values: PROPOSE
default: "PROPOSE"
actionKeyrequiredstring
targetrequiredProposalTarget
noteoptionalstring
default: ""
Provenance6
Record non-provider-identifying capture facts attached to an entity.
capturedAtrequiredstring
sourceRequestIdoptionalstring | null
artifactIdsoptionalstring[]
default: []
estimatedoptionalboolean
default: false
confidenceoptionalnumber | null
readFieldsoptionalstring[] | null
ProviderAction6
One requested provider change; its live before-value is read at apply time, not previewed.
actionKeyrequiredstring
Caller-owned key aligning outcomes with this action.
actionTypeKeyrequiredstring
The declared action type to perform.
accountrequiredAccountRef
Provider account the change targets.
targetrequiredEntityRef
changerequiredJsonValue
The requested change payload.
baseVersionoptionalstring | null
Live token the caller based this draft on.
ProviderFailureCodevalues · 7
The finite, sanitized provider failure vocabulary (consumers never parse provider text).
values: INVALID_INPUTINVALID_OUTPUTCONTENT_REFUSEDRATE_LIMITEDUNAVAILABLEOUTCOME_UNKNOWNNOT_CONFIGURED
ProviderIssue8
A provider refusal or failure, carried as data instead of raised as an error.
objectoptionalstring
Fixed tag marking this object as a provider issue.
values: provider_issue
default: "provider_issue"
kindrequiredIssueKind
Why the provider refused or failed the call.
permissionoptionalPermission | null
The missing permission; only for a permission-missing issue.
credentialoptionalCredential | null
The updatable value to renew; only for an auth-invalid issue that names one.
retryAfteroptionalstring | null
When to retry a wait-style issue; none uses the default back-off.
providerCodeoptionalstring | null
The provider's own code, kept for support.
providerMessageoptionalstring
The provider's text, kept for support; never a secret.
default: ""
resolutionoptionalResolution
Who must resolve it; derived from kind and permission.
ProviderRegionvalues · 3
Sales region chosen before consent, mirrored by the plugin contract.
values: NAEUFE
QueryPage5
One bounded aggregation result page, reusing the shared cursor/total contract.
rowsrequiredQueryRow[]
Rows in this page.
nextCursoroptionalstring | null
Continuation cursor; null on the last page.
totalRowsrequiredinteger
Rows matching the whole read, across all pages.
emptyReasonoptionalstring | null
Why this page is empty and what selection or source to check.
objectoptionalstring
Document type: aggregation query page.
values: query_page
default: "query_page"
QueryRequest5
Select a logical target and optionally narrow the authenticated owner's stores/accounts.
targetrequiredQueryTarget
Catalog fact family to read, or METRIC_DAYS for calculated daily values.
storeIdsoptionalstring[]
Stores to include; empty selects the asserted owner's stores.
default: []
accountIdsoptionalstring[]
Accounts to include within those stores; empty selects all their accounts.
default: []
pipelinerequiredQueryStage[]
Read-only aggregation stages over the selected logical rows.
pageoptionalPageRequest
Page size and continuation cursor for this exact read.
default: {"limit":200}
QueryRow0
No fields.
QueryStage0
No fields.
QueryTargetOne of · 2
One of: string | string
QuoteBlock2
One pull quote or customer quote the merchant supplied.
kindoptionalstring
values: QUOTE
default: "QUOTE"
textrequiredstring
RadialGradient2
A fill from the box centre to its farthest corner for a vignette or spotlight.
stopsrequiredGradientStop[]
gradientoptionalstring
values: RADIAL
default: "RADIAL"
RangeValue5
One range an assessment produced for a cell, with its own evidence and references.
labelrequiredstring
lowrequirednumber | string
highrequirednumber | string
evidenceoptionalstring
default: ""
referencesoptionalSourceReference[]
default: []
RankingWindow2
Identify one calendar ranking-board edition without a trend date span.
windowTyperequiredRankingWindowType
windowValuerequiredstring
RankingWindowTypevalues · 3
Name calendar editions for provider ranking boards, not metric periods.
values: DAYWEEKMONTH
RatioCombine3
Range value = sum(numerator) / sum(denominator) over the same days and entity.
kindoptionalstring
Range combination: ratio of summed operands.
values: ratio
default: "ratio"
numeratorrequiredstring
Metric summed for the ratio's numerator.
denominatorrequiredstring
Metric summed for the ratio's denominator.
RecordAddress3
The ONE public record address: one analyzed record's kind and key.
kindrequiredAnalyzedRecordKind
recordKeyrequiredstring
seriesWindowoptionalDateWindow | null
Inclusive date window for an opt-in record-level metric series; null requests no series.
RecordDetail13
A public detail object for one analyzed record.
objectrequiredstring
Public object discriminator.
values: record_detail
recordKindrequiredAnalyzedRecordKind
Record family.
recordKeyrequiredstring
Stable record key.
channelrequiredChannel | null
Source channel, when applicable.
externalIdoptionalstring | null
Channel-native id of the source subject (the ASIN of an Amazon product), when stored.
marketoptionalstring | null
ISO 3166-1 alpha-2 market of the source subject, when stored.
labeloptionalstring | null
Readable display label, when known.
relationsoptionalRelationRef[]
Observed relations to other served nodes.
default: []
unlinkedMentionsoptionalUnlinkedMention[]
Claims of the record that name an entity no held record matched; at most 16.
default: []
fieldsrequiredobject
Authorized record scalar fields.
conceptsrequiredConceptRef[]
Concepts attached to the record.
metricsoptionalMetricObservation[]
Latest typed observation heads for this record; at most 128.
default: []
seriesoptionalMetricObservation[]
Opt-in dated observations for the requested window; at most 32 points.
default: []
RectGeometry2
A rectangle filling the box; corner_radius in pixels (badges, panels).
kindoptionalstring
values: RECT
default: "RECT"
cornerRadiusoptionalnumber
default: 0
RedeemCodeRefusalReasonvalues · 10
Finite refusal facts for code updates, redemption and trial application.
values: INVALID_CODELEGACY_TOKENDISABLEDUPDATE_LOCKEDMAX_CONSUMEACTOR_LIMITIDENTITY_CONFLICTRELEASEDGRANT_CHANGEDTRIAL_NOT_ELIGIBLE
ReferencesDetailValue4
A REFERENCES detail row: the cell's deduplicated source references.
objectoptionalstring
values: references_detail_value
default: "references_detail_value"
kindoptionalstring
values: REFERENCES
default: "REFERENCES"
keyrequiredstring
referencesoptionalSourceReference[]
default: []
ReferencesRow1
Every source reference of the cell's assessments and items, deduplicated.
kindoptionalstring
values: REFERENCES
default: "REFERENCES"
Refusal3
One typed refusal: the code, the request field it concerns, and one DP-worded sentence (K-26, P5 C-3).
coderequiredRefusalCode
Stable refusal code.
fieldoptionalstring | string | null
Request field the refusal concerns; null when it concerns the whole request.
detailrequiredstring
Safe explanation of the refusal.
RefusalCodevalues · 23
THE ONE refusal vocabulary (K-26, S-29, D-07): every way DP declines to serve a request or a plan as asked, in a code an agent can act on.
values: 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_SETCHANNEL_REQUIREDLEG_UNAVAILABLEINVALID_REFERENCESOURCE_REJECTED_REQUESTUNSUPPORTED_QUESTIONVALIDATION_EXHAUSTEDDATA_CHANGEDINVALID_CURSORNOT_AVAILABLE
RelationHop3
ONE typed step of a relation path, so an answer can say HOW two records were connected instead of asserting that they are.
relationrequiredAnalyzedRelationKind
The relation this hop traverses.
fromKeyrequiredstring
Analyzed key of the hop's subject node.
toKeyrequiredstring
Analyzed key of the hop's object node.
RelationRef13
One typed relation shared by analyzed details and public node results.
stanceoptionalClaimStance | 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).
mainSubjectoptionalboolean | null
Whether the cited claim names what the source item mainly promotes or is about; null when stance is null.
emotionoptionalClaimEmotion | null
How the source item feels about the named entity in the cited claim, STRONGLY_NEGATIVE to STRONGLY_POSITIVE; null when stance is null.
phraseoptionalstring | 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.
relationrequiredAnalyzedRelationKind
Canonical relation joining the record to its other end.
directionrequiredstring
Direction of the relation relative to the record: OUT or IN.
values: OUTIN
otherrequiredNodeRef
Scoped reference to the node at the relation's other end.
otherLabeloptionalstring | null
Readable label of the related node, when known.
otherRecordKeyoptionalstring | null
Analyzed record key of the related node when served.
evidencerequiredstring
Stored citation that supports the relation.
basisrequiredEvidenceBasis
Evidence basis of this relation: RECORDED, MENTIONED or SIMILAR.
placementsoptionalSearchPlacement[]
Display placements carried by a RANKED_FOR relation; empty otherwise.
default: []
metricsoptionalMetricObservation[]
Metric observations carried by any relation kind (S-08).
default: []
RelativeTargetBidChange2
A percentage change of the row's observed keyword, target or default bid.
kindoptionalstring
values: target_bid_adjustment
default: "target_bid_adjustment"
percentChangerequirednumber | string
RemoveBlock3
Remove one block from a section.
actionoptionalstring
values: REMOVE_BLOCK
default: "REMOVE_BLOCK"
sectionKeyrequiredstring
blockKeyrequiredstring
RemoveDesign2
Remove any board object; HAS_VARIANTS while a variant or plan still names it.
actionoptionalstring
values: REMOVE_DESIGN
default: "REMOVE_DESIGN"
designIdrequiredstring
RemoveItems3
Delete items; their placements go with them (a placement of a missing item reads as nothing).
typeoptionalstring
values: REMOVE_ITEMS
default: "REMOVE_ITEMS"
actionKeyrequiredstring
keysrequiredstring[]
RemoveLayers3
Remove layers (and a group's children with it).
actionoptionalstring
values: REMOVE_LAYERS
default: "REMOVE_LAYERS"
designIdrequiredstring
layerIdsrequiredstring[]
RemoveScopevalues · 2
The targets a REMOVE action is declared to be allowed to delete.
values: ELTA_CREATEDANY_WITH_SNAPSHOT
RemoveSection2
Remove one section from the document; publish then removes its placement (D-02).
actionoptionalstring
values: REMOVE_SECTION
default: "REMOVE_SECTION"
sectionKeyrequiredstring
RenderFormatvalues · 3
Export encodings the stores accept and we produce (WEBP: agent previews and owner downloads).
values: JPEGPNGWEBP
ReorderViews5
Put the viewer's saved views in a new order (every existing view id, once).
typeoptionalstring
values: REORDER_VIEWS
default: "REORDER_VIEWS"
actionKeyrequiredstring
viewerrequiredViewerRef
expectedRevisionrequiredinteger
viewIdsrequiredstring[]
ReplacePost3
Replace one post's composed content.
editoptionalstring
values: REPLACE_POST
default: "REPLACE_POST"
postKeyrequiredstring
postrequiredComposedPost
ReportAdjudication8
The adjudicator's structured choice between the two analyses.
createdoptionalstring
updatedoptionalstring
candidaterequiredReportAdjudicationCandidate
The single outcome chosen from the closed candidate set.
reasonCodeoptionalReportReasonCode | null
Closed-set reason for a concluding candidate; None for CONTINUE or CONCLUDE_SUITABLE.
userReasoningrequiredstring | null
Reader-facing justification of the choice.
evidenceRefsoptionalReportEvidenceRef[]
Citations into accepted artifacts.
default: []
overruledDissentoptionalstring
What the losing analysis argued and why it was overruled.
default: ""
proseWithheldoptionalboolean
True only where a public read withheld this adjudication's prose.
default: false
ReportAdjudicationCandidatevalues · 4
The closed set of outcomes an adjudicator may choose.
values: CONTINUECONCLUDE_SUITABLECONCLUDE_NOT_SUITABLECONCLUDE_NOT_DETERMINABLE
ReportAnalystFinding5
One structured finding from a risk or opportunity analyst.
createdoptionalstring
updatedoptionalstring
headlinerequiredstring
Short headline of the finding.
reasoningrequiredstring
Why the cited evidence produces this finding.
evidenceRefsoptionalReportEvidenceRef[]
Citations into accepted artifacts.
default: []
ReportAnalystRolevalues · 3
Which independently prompted role produced a structured analysis.
values: RISKOPPORTUNITYADJUDICATOR
ReportClosureKindvalues · 2
Whether the report closed before or after every required phase ran.
values: EARLYFINAL
ReportCohortBandCount4
How many members fall into ONE margin band.
createdoptionalstring
updatedoptionalstring
bandrequiredReportCohortMarginBand
The margin band.
countrequiredinteger
Members in the band.
ReportCohortBrandAgevalues · 3
Whether a brand entered the analysed market recently.
values: NEWOLDUNKNOWN
ReportCohortBrandRow9
ONE brand of the population with its lead product.
createdoptionalstring
updatedoptionalstring
brandrequiredstring
Provider brand.
brandAgerequiredReportCohortBrandAge
NEW, OLD or UNKNOWN.
enteredAtoptionalstring | null
Earliest population release of the brand.
memberCountrequiredinteger
newReleaseCountrequiredinteger
profitableNewReleaseCountrequiredinteger
leadrequiredReportCohortMemberRow
Member with the highest monthly units (None last, then ASIN).
ReportCohortBrandScopevalues · 3
Which brands one brand-scope summary covers.
values: ALLNEW_BRANDSOLD_BRANDS
ReportCohortBrandScopeView18
New-release outcomes of the brands in ONE brand scope.
createdoptionalstring
updatedoptionalstring
scoperequiredReportCohortBrandScope
Which brands are covered.
brandCountrequiredinteger
brandNamesoptionalstring[]
default: []
brandsWithNewReleaseCountrequiredinteger
newReleaseCountrequiredinteger
profitableNewReleaseCountrequiredinteger
notProfitableNewReleaseCountrequiredinteger
unresolvedNewReleaseCountrequiredinteger
profitableNewReleasedCountrequiredinteger
profitableNewReleasedOnOldAsinCountrequiredinteger
newReleaseSuccessRaterequiredReportSuccessRate
Profitable / determinate new releases.
newReleaseFailureRaterequiredReportSuccessRate
Not profitable / determinate new releases.
profitableBrandNamesoptionalstring[]
Brands with at least one profitable new release.
default: []
notProfitableBrandNamesoptionalstring[]
Brands with at least one not-profitable new release.
default: []
successByBrandoptionalReportCohortBrandSlice[]
Profitable new releases: top brands, then OTHER.
default: []
failureByBrandoptionalReportCohortBrandSlice[]
Not-profitable new releases: top brands, then OTHER.
default: []
ReportCohortBrandSlice5
One donut slice of new releases by brand.
createdoptionalstring
updatedoptionalstring
brandoptionalstring | null
Brand; None = OTHER.
countrequiredinteger
New releases in the slice.
otherBrandsoptionalstring[]
Brands folded into the OTHER slice.
default: []
ReportCohortMarginBandvalues · 8
One [gte, lt) band of the expected-scenario margin ratio, or OTHER.
values: 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.
createdoptionalstring
updatedoptionalstring
populationCountrequiredinteger
Members partitioned.
byResolvedSalesrequiredReportCohortBandCount[]
OTHER = no margin OR an unresolved sale; 8 bands in order.
byKnownMarginrequiredReportCohortBandCount[]
OTHER = no margin only; 8 bands in order.
ReportCohortMemberRow22
ONE competitor as every cohort table, card and brand lead shows it.
createdoptionalstring
updatedoptionalstring
economicListingKeyoptionalstring | null
Internal listing identity; owner reads only.
publicListingHandleoptionalstring | null
Opaque public listing handle; public reads only.
asinrequiredstring
DISPLAY ONLY provider ASIN.
titleoptionalstring | null
Provider title.
brandoptionalstring | null
Provider brand.
imageUrloptionalstring | null
Primary image.
ratingIntoptionalinteger | null
Star rating in tenths (0-50).
reviewCountoptionalinteger | null
Provider review count.
releasedAtoptionalstring | null
Credible observed release instant.
releasedTypeoptionalProductReleasedType | null
Retained lifecycle classification.
isProfitableoptionalboolean | null
The report's profitable flag; None unresolved.
sellingPriceoptionalMinorUnitMoney | null
Expected-scenario selling price.
monthlySoldoptionalinteger | null
Latest observed monthly units.
monthlyRevenueoptionalMinorUnitMoney | null
Selling price x monthly units.
expectedProfitoptionalMinorUnitMoney | null
Expected-scenario unit profit.
monthlyProfitoptionalMinorUnitMoney | null
Expected unit profit x monthly units.
marginoptionalnumber | string | null
Expected-scenario margin ratio.
profitableCostBasisoptionalReportPurchasingCostProvenance | null
Purchase-cost provenance the profitable flag was priced with.
economicsCostBasisoptionalReportPurchasingCostProvenance | null
Purchase-cost provenance the expected scenario used.
profitWithheldoptionalboolean
True only where a public read withholds per-row profit.
default: false
ReportCohortPeriodCount11
New releases released in ONE UTC calendar period, by type and outcome.
createdoptionalstring
updatedoptionalstring
periodStartrequiredstring
Inclusive UTC period start.
periodEndrequiredstring
Exclusive UTC period end.
newProfitablerequiredinteger
newNotProfitablerequiredinteger
newUnresolvedrequiredinteger
newOnOldProfitablerequiredinteger
newOnOldNotProfitablerequiredinteger
newOnOldUnresolvedrequiredinteger
marginBandsoptionalReportCohortBandCount[]
Resolved-sales bands; empty before economics.
default: []
ReportCohortRankTable6
One profit ranking: the top rows plus the size of the ranked population.
createdoptionalstring
updatedoptionalstring
keyrequiredReportCohortRankTableKey
Which ranking this is.
populationCountrequiredinteger
Full filtered population.
rowsoptionalReportCohortMemberRow[]
Ranked rows with a known monthly profit.
default: []
profitWithheldoptionalboolean
True only where a public read withheld this table's rows.
default: false
ReportCohortRankTableKeyvalues · 4
Which profit ranking one rank table is.
values: PROFITABLE_ALLNOT_PROFITABLE_ALLPROFITABLE_NEWNOT_PROFITABLE_NEW
ReportCohortStandoutCase4
ONE STANDOUT pick as a case card: its listing row plus the agent's reason.
createdoptionalstring
updatedoptionalstring
rowrequiredReportCohortMemberRow
The pick's listing representative.
reasonrequiredstring | 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 (F10).
createdoptionalstring
updatedoptionalstring
asinrequiredstring
DISPLAY ONLY subject ASIN.
titleoptionalstring | null
Provider title.
brandoptionalstring | null
Provider brand.
imageUrloptionalstring | null
Primary image.
ratingIntoptionalinteger | null
Star rating in tenths (0-50).
reviewCountoptionalinteger | null
Provider review count.
ReportCompactAbsence5
One requested section that is explicitly unavailable, with its reason.
createdoptionalstring
updatedoptionalstring
sectionrequiredReportCompactSection
Section that is unavailable.
reasonrequiredReportCompactAbsenceReason
Typed reason it is absent.
detailrequiredstring
Reader-facing explanation, safe to display.
ReportCompactAbsenceReasonvalues · 4
Why a requested section is not available as data.
values: NOT_BUILT_YETWAITING_FOR_INPUTFAILEDNOT_SUPPORTED_BY_FORMAT
ReportCompactAnalysis7
One independently prompted analyst's structured output.
createdoptionalstring
updatedoptionalstring
rolerequiredReportAnalystRole
Which analyst produced this.
summaryrequiredstring | null
One-paragraph summary; None only when prose_withheld.
proseWithheldoptionalboolean
True only where a public owner-costed read withheld this prose.
default: false
findingsoptionalReportCompactFinding[]
Structured findings, strongest first.
default: []
missingEvidenceoptionalstring[]
Evidence this analyst says it lacked.
default: []
ReportCompactCitation5
One citation into an accepted artifact, without its artifact key.
createdoptionalstring
updatedoptionalstring
phaserequiredReportPhase
Phase whose accepted artifact is cited.
claimrequiredstring
The statement the artifact is cited for.
strengthrequiredReportEvidenceStrength
How strongly it supports.
ReportCompactConclusion9
The report's verdict in the smallest form a tool can reason over.
createdoptionalstring
updatedoptionalstring
verdictrequiredReportVerdict
The business verdict reached.
reasonCodeoptionalReportReasonCode | null
Closed-set reason; None only for SUITABLE.
checkpointrequiredReportPhase
Phase the verdict was reached at.
policyRevisionoptionalstring | null
Frozen policy revision; owner reads only, never public.
userReasoningrequiredstring | null
Reader-facing explanation; None only when prose_withheld.
proseWithheldoptionalboolean
The adjudication's D-3 flag: True only where a public read of an owner-costed report withheld its prose.
default: false
isPartialrequiredboolean
Whether the report closed before every phase ran.
ReportCompactCorroboration6
One piece of evidence supporting or extending the lifecycle window.
createdoptionalstring
updatedoptionalstring
kindrequiredReportCorroborationKind
Which evidence class this is.
statementrequiredstring
The concrete claim being made.
sourceRefrequiredstring
Where the claim was observed.
observedAtoptionalstring | null
Instant the claim was observed, when known.
ReportCompactEconomics6
Market-level economics as a tool sees it.
createdoptionalstring
updatedoptionalstring
determinateListingCountrequiredinteger
Listings with a defensible profit envelope.
profitableListingCountrequiredinteger
Listings whose expected profit is positive.
unresolvedListingCountrequiredinteger
Listings that could not be costed.
successRatesoptionalReportSuccessRateProjection | null
Three-denominator market success rates.
ReportCompactEstimation5
How the report's material inputs were resolved.
createdoptionalstring
updatedoptionalstring
verdictCountsoptionalobject
EstimateSource value -> member count.
unresolvedCountrequiredinteger
Members with unresolved inputs.
policyFingerprintrequiredstring
Digest of thresholds plus policies.
ReportCompactFinding5
One analyst finding with the citations it rests on.
createdoptionalstring
updatedoptionalstring
headlinerequiredstring
Short headline of the finding.
reasoningrequiredstring
Reader-facing reasoning for the finding.
citationsoptionalReportCompactCitation[]
Citations supporting this finding.
default: []
ReportCompactGap6
One explicit hole a tool must report rather than fill in.
createdoptionalstring
updatedoptionalstring
phaserequiredReportPhase
Phase with no accepted artifact.
kindrequiredReportGapKind
Typed reason this phase is missing.
detailrequiredstring
Reader-facing explanation.
resumePhaseoptionalReportPhase | null
Phase a resumable gap restarts from.
ReportCompactLifecycle7
The market's lifecycle position as a tool sees it.
createdoptionalstring
updatedoptionalstring
verdictrequiredReportLifecycleVerdict
Lifecycle position verdict.
windowMonthsrequiredinteger
Frozen lifecycle window in months.
earliestEntryAgeMonthsoptionalinteger | null
Whole months since the earliest entry.
corroborationCountrequiredinteger
Valid corroboration items supporting an extension.
reasoningrequiredstring
Deterministic explanation of the verdict.
ReportCompactListing11
One comparable product as a tool sees it.
createdoptionalstring
updatedoptionalstring
economicListingKeyrequiredstring
Operational listing identity.
representativeAsinrequiredstring
DISPLAY ONLY provider ASIN.
memberAsinsoptionalstring[]
DISPLAY ONLY member ASINs, for external lookup.
default: []
outcomerequiredReportListingOutcome
Listing-level verdict.
memberCountrequiredinteger
Members in the listing.
familyEntryAgeMonthsoptionalinteger | null
Whole months since the family entered.
expectedProfitoptionalMinorUnitMoney | null
Expected profit; None when not costed.
marginLowoptionalnumber | null
Lower margin bound; None when not costed.
marginHighoptionalnumber | null
Upper margin bound; None when not costed.
ReportCompactMaterialGap6
One member whose material inputs could not be resolved, and why.
createdoptionalstring
updatedoptionalstring
memberKeyoptionalstring | null
Member the gap belongs to, when member-scoped.
economicListingKeyoptionalstring | null
Listing the gap belongs to, when listing-scoped.
reasonrequiredstring
Typed upstream gap reason.
detailrequiredstring
Reader-facing explanation.
ReportCompactQuestion5
One material question this revision is waiting on an owner to answer.
createdoptionalstring
updatedoptionalstring
economicListingKeyrequiredstring
Listing the question is about.
fieldsoptionalReportMaterialField[]
Which material inputs are being asked for.
default: []
reasonrequiredstring
Why the answer is needed.
ReportCompactSectionvalues · 6
The sections an agent query tool may ask a report for.
values: CONCLUSIONLISTINGSLIFECYCLEESTIMATIONECONOMICSGAPS
ReportCompactView15
Everything an agent query tool may read about one report.
createdoptionalstring
updatedoptionalstring
versionrequiredReportVersion
STORED report format identity.
rootTaskIdrequiredstring
Owning keble-task identity.
revisionrequiredinteger
Revision read; 0 for a V2 report.
completenessrequiredReportCompleteness
Completeness at read time.
amazonMarketplaceoptionalAmazonMarketplace | null
Product-market the report analysed.
updatedAtoptionalstring | null
Instant the read revision was committed.
conclusionoptionalReportCompactConclusion | null
Verdict, when one was reached.
listingsoptionalReportCompactListing[]
Comparable products the report covered.
default: []
lifecycleoptionalReportCompactLifecycle | null
Market lifecycle position, when built.
estimationoptionalReportCompactEstimation | null
Material-input resolution, when built.
economicsoptionalReportCompactEconomics | null
Market economics, when built.
gapsoptionalReportCompactGap[]
Explicit holes still open in the report.
default: []
absencesoptionalReportCompactAbsence[]
Sections that are explicitly unavailable.
default: []
ReportCompletenessvalues · 6
How complete the report is RIGHT NOW, as an explicit persisted fact.
values: PROCESSINGWAITING_FOR_INPUTPARTIAL_CONCLUDEDFULLCANCELLEDFAILED_PARTIAL
ReportConclusion12
The report's BUSINESS verdict with its full, auditable justification.
createdoptionalstring
updatedoptionalstring
verdictrequiredReportVerdict
The business verdict reached.
checkpointrequiredReportPhase
Phase at which the verdict was reached.
closurerequiredReportClosureKind
Whether this closure happened before the final phase.
policyRevisionoptionalstring | null
Frozen policy revision; owner reads only, never public.
reasonCodeoptionalReportReasonCode | null
Closed-set reason; None only for SUITABLE.
userReasoningrequiredstring | null
Reader-facing explanation of the verdict; None only when the adjudication's prose_withheld is True (owner-costed public read).
evidenceRefsoptionalReportEvidenceRef[]
Citations into accepted artifacts.
default: []
riskAnalysisrequiredReportRiskAnalysis
Independent risk analysis that fed the adjudication.
opportunityAnalysisrequiredReportOpportunityAnalysis
Independent opportunity analysis that fed the adjudication.
adjudicationrequiredReportAdjudication
Structured adjudication that chose this outcome.
ReportConclusionEvidenceView9
The verdict PLUS the reasoning chain that produced it.
createdoptionalstring
updatedoptionalstring
conclusionrequiredReportCompactConclusion
The verdict reached.
citationsoptionalReportCompactCitation[]
Citations the adjudicated verdict rests on.
default: []
analysesoptionalReportCompactAnalysis[]
Risk and opportunity analyses, in that order.
default: []
riskBlocksSuitabilityrequiredboolean
Whether the risk analyst blocked a SUITABLE verdict.
opportunitySupportsContinuationrequiredboolean
Whether the opportunity analyst supported continuing.
adjudicationCandidaterequiredReportAdjudicationCandidate
Outcome the adjudicator chose.
overruledDissentrequiredstring
What the adjudicator overruled; empty when none.
ReportCorroborationKindvalues · 2
The two independent evidence classes that may extend an older market.
values: REPEATED_USER_PAININNOVATION_ADDRESSES_PAIN
ReportDecisionTypevalues · 5
One question the report may park on for a typed agent answer.
values: REPORT_SCOPESAMPLE_RELEVANCEMATERIAL_FACTSSTANDOUT_SELECTIONJUDGMENT
ReportEstimateConfidencevalues · 4
Confidence attached to one member's effective material range.
values: HIGHMEDIUMLOWUNRESOLVED
ReportEstimationEvidenceView7
How the report resolved its material inputs, and what stayed open.
createdoptionalstring
updatedoptionalstring
estimationrequiredReportCompactEstimation
Resolution counts.
unresolvedMemberKeysoptionalstring[]
Members whose material inputs stayed unresolved.
default: []
excludedMemberKeysoptionalstring[]
Members excluded as mismatched.
default: []
completenessGapsoptionalReportCompactMaterialGap[]
Typed holes in the material evidence.
default: []
openQuestionsoptionalReportCompactQuestion[]
Material questions awaiting an owner answer.
default: []
ReportEstimationMethodologyView6
Report-level record of how every material verdict was reached.
createdoptionalstring
updatedoptionalstring
verdictCountsoptionalobject
EstimateSource value -> member count.
excludedMismatchedMemberKeysoptionalstring[]
Internal member keys excluded as mismatched; owner reads only.
default: []
completenessGapsoptionalReportMaterialGapView[]
Explicit unresolved holes.
default: []
provenanceoptionalReportEstimationProvenance | null
Replay identity; owner reads only, never public.
ReportEstimationProvenance8
The REPLAY identity of one estimation revision — never reader content.
createdoptionalstring
updatedoptionalstring
policyFingerprintrequiredstring
Digest of thresholds plus policies.
researchFingerprintrequiredstring
Digest of the research selection.
evidenceFingerprintrequiredstring
Digest of every evidence key used.
completenessFingerprintrequiredstring
Digest of the completeness gaps.
researchPolicyRevisionrequiredstring
Frozen MaterialResearchSelectionPolicy revision.
ownerResolutionFingerprintoptionalstring
Digest of the owner answers applied to this revision.
default: ""
ReportEvidenceQuery2
Ask for the evidence behind the verdict, the lifecycle or the estimation.
objectoptionalstring
values: report_evidence
default: "report_evidence"
topicrequiredstring
values: CONCLUSIONLIFECYCLEESTIMATION
ReportEvidenceRef6
A citation into ONE accepted artifact of this report.
createdoptionalstring
updatedoptionalstring
phaserequiredReportPhase
Phase whose accepted artifact is cited.
artifactKeyoptionalstring | null
Immutable artifact key; owner reads only, never public.
claimrequiredstring
The concrete claim this artifact supports.
strengthrequiredReportEvidenceStrength
How strongly the cited artifact supports the claim.
ReportEvidenceStrengthvalues · 3
How strongly one cited artifact supports the statement that cites it.
values: WEAKMODERATESTRONG
ReportExcludedGroup5
One group of listings removed from the rate cohort, and why.
createdoptionalstring
updatedoptionalstring
reasonrequiredstring
Policy reason for the exclusion.
countrequiredinteger
Listings removed for this reason.
economicListingKeysoptionalstring[]
Operational identities of the removed listings.
default: []
ReportFamilyEntrySourcevalues · 3
Which observation class supplied a family's earliest credible entry.
values: MEMBER_RELEASEPARENT_RELATIONABSENT
ReportFinalOverviewSectionView6
The closing headline and summary of a fully built report.
createdoptionalstring
updatedoptionalstring
kindoptionalstring
values: FINAL_OVERVIEW
default: "FINAL_OVERVIEW"
headlinerequiredstring | null
Reader-facing headline; None only when withheld.
summaryrequiredstring | null
Reader-facing closing summary; None only when withheld.
proseWithheldoptionalboolean
True only where a public read withheld the overview prose.
default: false
ReportGapDescriptor7
One EXPLICIT hole in the report, with the reason it is a hole.
createdoptionalstring
updatedoptionalstring
phaserequiredReportPhase
Phase with no accepted artifact.
kindrequiredReportGapKind
Typed reason this phase is missing.
detailrequiredstring
Reviewer-visible explanation of the gap.
awaitingInputKeyoptionalstring | null
Stable key of the input this gap waits on.
resumePhaseoptionalReportPhase | null
Phase the backend should run to continue.
ReportGapKindvalues · 5
Why one phase has no accepted artifact yet.
values: PENDINGWAITING_FOR_INPUTSKIPPEDFAILEDCONTINUABLE
ReportJudgmentAnswer4
The create-time conclusion for one revision (07a §2.1).
decisionTypeoptionalstring
values: JUDGMENT
default: "JUDGMENT"
verdictoptionalReportJudgmentVerdict | null
Required iff the question's verdict is open.
sectionsrequiredReportJudgmentSection[]
Exactly the question's section kinds, once each.
overviewrequiredReportOverviewEvidence
Headline and summary.
ReportJudgmentEvidenceItem3
One citable accepted artifact: its block from build_evidence_digest.
itemKeyrequiredstring
The artifact_key a ReportEvidenceRef cites.
phaserequiredReportPhase
Phase of the cited artifact.
evidencerequiredstring
Rendered evidence block.
ReportJudgmentQuery1
Ask for the HEAD revision's conclusion question, so an agent can cite it.
objectoptionalstring
values: report_judgment
default: "report_judgment"
ReportJudgmentSection2
One old-page interpretation slot's text; number-free (R-D1).
sectionKindrequiredReportNarrativeSectionKind
Old-page slot.
bodyrequiredstring
Number-free reader text.
ReportJudgmentVerdict3
The three analyses one agent now writes (disclosed in README, grill A-4).
riskAnalysisrequiredReportRiskAnalysis
Risk analysis.
opportunityAnalysisrequiredReportOpportunityAnalysis
Opportunity analysis.
adjudicationrequiredReportAdjudication
Candidate, reason code and citations.
ReportLengthUnitvalues · 2
The length units a material question may be asked and answered in.
values: CENTIMETREINCH
ReportLifecycleEvidenceView8
The market's lifecycle position PLUS the evidence behind the verdict.
createdoptionalstring
updatedoptionalstring
lifecyclerequiredReportCompactLifecycle
Lifecycle position.
evaluatedAtrequiredstring
Frozen instant ages were measured at.
earliestEntryAtoptionalstring | null
Earliest credible family entry, when known.
contributingListingKeysoptionalstring[]
Listings that fixed the earliest entry.
default: []
corroborationoptionalReportCompactCorroboration[]
Evidence supporting or extending the window.
default: []
droppedCorroborationCountoptionalinteger | null
Search results not retained; None for historical artifacts.
ReportLifecycleVerdictvalues · 4
Where the market sits against the frozen lifecycle window.
values: WITHIN_WINDOWBEYOND_WINDOW_CORROBORATEDBEYOND_WINDOW_UNCORROBORATEDENTRY_UNKNOWN
ReportListingCohortSectionView18
The competitor cohort of ONE revision, ready for the old-report layout.
createdoptionalstring
updatedoptionalstring
kindoptionalstring
values: LISTING_BUILD
default: "LISTING_BUILD"
evaluatedAtrequiredstring
Frozen INPUT_FREEZE evaluation instant.
memberCountrequiredinteger
Population ASIN members.
excludedMemberCountrequiredinteger
Loaded market members excluded by policy.
newReleaseCountrequiredinteger
Population new releases.
economicsReadyrequiredboolean
Whether LISTING_ECONOMICS is accepted.
marginAlloptionalReportCohortMarginDistribution | null
Every population member; by_resolved_sales puts an unresolved sale in OTHER, by_known_margin only a missing margin.
marginNewoptionalReportCohortMarginDistribution | null
Population new releases; by_resolved_sales puts an unresolved sale in OTHER, by_known_margin only a missing margin.
rankTablesoptionalReportCohortRankTable[]
Four profit rankings in key order.
default: []
timelineYearlyoptionalReportCohortPeriodCount[]
New releases per UTC calendar year, oldest first.
default: []
timelineMonthlyoptionalReportCohortPeriodCount[]
New releases per UTC calendar month, oldest first.
default: []
brandScopesoptionalReportCohortBrandScopeView[]
ALL, NEW_BRANDS and OLD_BRANDS, in that order.
default: []
oldBrandNewReleaseSharerequiredReportSuccessRate
OLD_BRANDS new releases / ALL new releases.
brandsoptionalReportCohortBrandRow[]
Brands by member count desc, then name.
default: []
standoutCasesoptionalReportCohortStandoutCase[] | null
None = no STANDOUT artifact; () = ran with no picks.
subjectoptionalReportCohortSubjectDisplay | null
Subject product display facts; None when not loaded.
ReportListingDetailView7
One listing with its members, evidence counts, and economics.
createdoptionalstring
updatedoptionalstring
summaryrequiredReportListingSummaryView
The paged summary view.
membersrequiredReportListingMemberView[]
Every projected member of this listing.
outcomeReasoningrequiredstring
Deterministic explanation of the listing verdict.
groupingEvidenceCountrequiredinteger
Number of retained pair-scoring evidence records.
economicsoptionalReportListingEconomicsView | null
Listing economics when the phase produced them.
ReportListingEconomicsView10
The economics of ONE listing, with scenario ranges kept honest.
createdoptionalstring
updatedoptionalstring
economicListingKeyrequiredstring
Operational listing identity.
sellingPriceoptionalReportMoneyPoint | null
Observed selling price of the representative.
profitoptionalReportMoneyEnvelope | null
Profit envelope; None when inputs are unresolved.
purchasingCostoptionalReportPurchasingCostView | null
Effective purchasing cost with its authorisation.
marginoptionalReportRatioRange | null
Margin range with its explicit range kind.
scenariosoptionalProfitEnvelope | null
Every coherent scenario waterfall, verbatim.
sizingoptionalReportListingSizingView | null
Physical size and fee tier behind the scenarios.
unresolvedDetailoptionalstring | null
Why this listing has no economics, when it has none.
ReportListingMemberKindvalues · 2
Whether a projected member was actually loaded from the provider.
values: LOADEDPLACEHOLDER
ReportListingMemberView10
One member of an economic listing, projected for display and citation.
createdoptionalstring
updatedoptionalstring
memberKeyrequiredstring
Operational member identity.
asinrequiredstring
DISPLAY ONLY provider ASIN.
kindrequiredReportListingMemberKind
LOADED or PLACEHOLDER.
isRepresentativerequiredboolean
Whether this member is the listing's representative.
excludedReasonoptionalstring | null
Policy exclusion reason, when excluded.
excludedDetailoptionalstring | null
Reviewer-visible exclusion explanation.
releasedAtoptionalstring | null
Credible observed release instant.
ageMonthsoptionalinteger | null
Whole months since this member's release.
ReportListingOutcomevalues · 3
Whether a listing proves success, proves a failed launch, or neither.
values: SUCCESSNEW_RELEASE_FAILEDNOT_DETERMINABLE
ReportListingPage5
One cursor page of listing summaries.
createdoptionalstring
updatedoptionalstring
itemsrequiredReportListingSummaryView[]
Ordered listing summaries in this page.
nextCursoroptionalstring | null
Opaque cursor for the next page; None at the end.
totalKnownrequiredinteger
Total listings known at the read revision.
ReportListingQuery2
Ask for the one listing that CONTAINS an Amazon ASIN.
objectoptionalstring
values: report_listing
default: "report_listing"
asinrequiredstring
Any member ASIN.
ReportListingSizingView9
What the report shows about ONE listing's physical size and fee tier.
createdoptionalstring
updatedoptionalstring
acceptedrequiredSizingDetail
Sizing the expected scenario used.
materialBoundsoptionalReportMaterialBoundsView | null
Accepted low/high physical correction range.
materialSourceoptionalEstimateSource | null
Provenance of the accepted correction.
materialConfidenceoptionalReportEstimateConfidence | null
Confidence of the accepted correction.
anomalyHeadlinesoptionalstring[]
Typed anomaly labels observed for this listing.
default: []
tierProbeSizeTiersoptionalstring[]
Size tiers of the retained fee-tier probes.
default: []
reasoningoptionalstring | null
Deterministic explanation of the accepted size.
ReportListingSummaryView25
A listing as it appears in a paged list, for ONE audience at a time.
createdoptionalstring
updatedoptionalstring
economicListingKeyoptionalstring | null
Internal listing identity; owner reads only, never public.
publicListingHandleoptionalstring | null
Opaque public listing reference; public reads only.
representativeMemberKeyoptionalstring | null
Internal member identity; owner reads only, never public.
representativeAsinrequiredstring
DISPLAY ONLY provider ASIN.
representativeQualityrequiredReportRepresentativeQuality
Whether a real sales signal chose the representative.
marketplaceoptionalAmazonMarketplace | null
Product marketplace this listing was analysed in.
outcomerequiredReportListingOutcome
Listing-level success verdict.
memberCountrequiredinteger
All members of the listing.
loadedMemberCountrequiredinteger
Members loaded from provider.
excludedMemberCountrequiredinteger
Members excluded by policy.
familyEntryAtoptionalstring | null
Earliest credible family entry instant.
familyEntryAgeMonthsoptionalinteger | null
Whole months since the family entered.
familyEntrySourcerequiredReportFamilyEntrySource
Which observation supplied the family entry.
sellingPriceoptionalMinorUnitMoney | null
Expected-scenario selling price; None until costed.
monthlySoldoptionalinteger | null
Representative member's latest observed monthly units.
expectedProfitoptionalMinorUnitMoney | null
Expected-scenario profit; None until costed.
marginoptionalnumber | string | null
Expected-scenario margin ratio; None until costed.
titleoptionalstring | null
Representative member's provider title, read-time.
brandoptionalstring | null
Representative member's provider brand, read-time.
imageUrloptionalstring | null
Representative member's primary image; None before 2.62.0.
profitableCostBasisoptionalReportPurchasingCostProvenance | null
Purchase-cost provenance the profitable flag was priced with; stored at LISTING_BUILD, None before 2.62.0.
economicsCostBasisoptionalReportPurchasingCostProvenance | null
Purchase-cost provenance the expected scenario used, owner answers included; read-time, None without economics.
profitWithheldoptionalboolean
True only on a public owner-costed read, where per-row profit and margin are withheld rather than absent.
default: false
ReportListingsQuery2
Ask for one cursor page of the report's comparable listings.
objectoptionalstring
values: report_listings
default: "report_listings"
cursoroptionalstring | null
Previous page's next cursor.
ReportMarketSectionView6
The market's success rates and the capital needed to enter it.
createdoptionalstring
updatedoptionalstring
kindoptionalstring
values: MARKET_SUCCESS_INVESTMENT
default: "MARKET_SUCCESS_INVESTMENT"
successRatesrequiredReportSuccessRateProjection
Three-denominator market success rates.
entryInvestmentoptionalReportMoneyPoint | null
Entry investment point plus peer benchmark.
marginBenchmarkoptionalReportRatioRange | null
Peer margin benchmark for the covered cohort.
ReportMassUnitvalues · 2
The mass units a material question may be asked and answered in.
values: GRAMKILOGRAM
ReportMaterialBoundsView12
The effective low/high physical and purchasing-cost bounds of a member.
createdoptionalstring
updatedoptionalstring
lowLengthCmoptionalnumber | null
Lower length bound.
lowWidthCmoptionalnumber | null
Lower width bound.
lowHeightCmoptionalnumber | null
Lower height bound.
lowWeightGoptionalnumber | null
Lower weight bound.
highLengthCmoptionalnumber | null
Upper length bound.
highWidthCmoptionalnumber | null
Upper width bound.
highHeightCmoptionalnumber | null
Upper height bound.
highWeightGoptionalnumber | null
Upper weight bound.
lowUnitCostoptionalMinorUnitMoney | null
Lower purchasing unit cost bound.
highUnitCostoptionalMinorUnitMoney | null
Upper purchasing unit cost bound.
ReportMaterialCostAnswer2
One purchasing unit cost, as a point or an inclusive range.
lowrequiredMinorUnitMoney
Lower purchasing unit cost bound.
highrequiredMinorUnitMoney
Upper purchasing unit cost bound.
ReportMaterialDimensionsAnswer4
The three physical axes of one product, with the unit they are in.
unitrequiredReportLengthUnit
Unit the three axes are given in.
lengthrequirednumber
Longest axis, in unit.
widthrequirednumber
Second axis, in unit.
heightrequirednumber
Third axis, in unit.
ReportMaterialEstimateView12
One member's effective material range with its provenance.
createdoptionalstring
updatedoptionalstring
estimateKeyrequiredstring
Stable identity of the upstream estimate.
memberKeyrequiredstring
Operational member identity.
economicListingKeyrequiredstring
Operational listing identity.
sourcerequiredEstimateSource
Where the effective range came from.
confidencerequiredReportEstimateConfidence
Confidence in the range.
unitCostSourceoptionalEstimateSource | null
Where the purchasing cost came from, if judged.
unitCostConfidenceoptionalReportEstimateConfidence | null
Confidence in the purchasing cost, if judged.
boundsrequiredReportMaterialBoundsView
Effective low/high bounds.
anomalyHeadlinesoptionalstring[]
Typed anomaly labels observed for this member.
default: []
reasoningrequiredstring
Deterministic explanation of the verdict.
ReportMaterialFieldvalues · 5
One physical or cost input a report may have to ask its owner about.
values: LENGTHWIDTHHEIGHTWEIGHTUNIT_COST
ReportMaterialGapView6
One explicitly reported hole in the material picture.
createdoptionalstring
updatedoptionalstring
memberKeyoptionalstring | null
Internal member identity; owner reads only, never public.
economicListingKeyoptionalstring | null
Internal listing identity; owner reads only, never public.
reasonrequiredstring
Typed upstream gap reason.
detailrequiredstring
Inputs still unmeasured and excluded from profit figures.
ReportMaterialQuestion12
One economic listing's unresolved material facts and safe choices.
createdoptionalstring
updatedoptionalstring
questionKeyrequiredstring
Stable question identity.
economicListingKeyrequiredstring
Operational listing identity.
fieldsrequiredReportMaterialField[]
Inputs the answer must supply.
lengthUnitoptionalReportLengthUnit
Unit a dimensions answer must be given in.
default: "CENTIMETRE"
massUnitoptionalReportMassUnit
Unit a weight answer must be given in.
default: "GRAM"
currencyoptionalCurrency | null
Currency a cost answer must be given in.
observedoptionalReportMaterialEstimateView | null
The estimate that is missing these inputs.
analysedoptionalReportMaterialBoundsView | null
The analysis's own low/high bounds for a disputed input; None when the analysis never established a range.
suggestedResolutionsoptionalReportMaterialResolution[]
Server suggestions the owner may pick.
default: []
reasonrequiredstring
Reviewer-visible reason the answer is needed.
ReportMaterialResolution5
ONE typed answer to ONE material question.
sourcerequiredReportMaterialResolutionSource
Whether the owner picked a suggestion or typed values.
suggestionKeyoptionalstring | null
Stable key of the picked server suggestion.
dimensionsoptionalReportMaterialDimensionsAnswer | null
Typed three-axis answer, when supplied.
weightoptionalReportMaterialWeightAnswer | null
Typed weight answer, when supplied.
unitCostoptionalReportMaterialCostAnswer | null
Typed purchasing unit cost answer, when supplied.
ReportMaterialResolutionSourcevalues · 2
Where one owner answer came from.
values: SERVER_SUGGESTIONOWNER_ENTERED
ReportMaterialWeightAnswer2
One product's weight, with the unit it is expressed in.
unitrequiredReportMassUnit
Unit the weight is given in.
weightrequirednumber
Product weight, in unit.
ReportMoneyEnvelope5
An expected value with a DEFENSIBLE scenario range around it.
createdoptionalstring
updatedoptionalstring
expectedrequiredMinorUnitMoney
Expected-scenario value.
boundsrequiredReportMoneyRange
Pessimistic/optimistic bounds.
boundScenarioKeysrequiredany[]
Frozen scenario keys that produced the low and high bounds.
ReportMoneyPoint4
One money value, optionally accompanied by a LABELLED peer benchmark.
createdoptionalstring
updatedoptionalstring
valuerequiredMinorUnitMoney
The single defensible value.
benchmarkoptionalReportMoneyRange | null
Separately labelled peer comparison range.
ReportMoneyRange7
A money low/high pair that always states what kind of range it is.
createdoptionalstring
updatedoptionalstring
lowrequiredMinorUnitMoney
Lower bound.
highrequiredMinorUnitMoney
Upper bound.
kindrequiredReportRangeKind
Scenario bound or cohort benchmark.
cohortLabeloptionalstring | null
Peer cohort described; required for a benchmark.
cohortSizeoptionalinteger | null
Peer cohort size; required for a benchmark.
ReportNarrativeSection6
One rendered narrative section keyed by the phase it explains.
createdoptionalstring
updatedoptionalstring
sectionKeyrequiredstring
Stable section identity.
sourcePhaserequiredReportPhase
Phase whose artifact it explains.
bodyrequiredstring | null
Reader-facing prose; None only when prose_withheld.
proseWithheldoptionalboolean
True only where a public read withheld this section's prose.
default: false
ReportNarrativeSectionKindvalues · 5
The FIVE old-page interpretation slots the report's prose fills (07a §2.3).
values: INVESTMENT_BUDGETINVESTMENT_BRANDSPROFIT_RATIOSMARKET_NEW_PRODUCTSMARKET_ENTRY_TIMING
ReportNarrativeSectionView4
The rendered prose sections in display order.
createdoptionalstring
updatedoptionalstring
kindoptionalstring
values: NARRATIVE
default: "NARRATIVE"
sectionsrequiredReportNarrativeSection[]
Rendered narrative sections in display order.
ReportOpportunityAnalysis7
Independent OPPORTUNITY analysis of the accepted artifacts.
createdoptionalstring
updatedoptionalstring
findingsoptionalReportAnalystFinding[]
Concrete opportunities, each with citations.
default: []
missingEvidenceoptionalstring[]
Evidence the analyst needed but did not find in the artifacts.
default: []
supportsContinuationrequiredboolean
Whether the opportunities justify continuing the analysis.
summaryrequiredstring | null
One-paragraph opportunity summary.
proseWithheldoptionalboolean
True only where a public read withheld this analysis' prose.
default: false
ReportOverviewEvidence2
Closing headline and summary for the FINAL_OVERVIEW phase.
headlinerequiredstring
Reader-facing headline.
summaryrequiredstring
Reader-facing closing summary.
ReportOverviewQuery1
Ask for the report's typed, absence-complete overview.
objectoptionalstring
values: report_overview
default: "report_overview"
ReportPhasevalues · 14
The ordered phases a V3 report walks; each produces exactly one artifact.
values: 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.
suggestedPurchasingCostoptionalSuggestedPurchasingCost | null
The seller's own purchasing cost for one benchmark ASIN; never a Keble estimate.
acosLowerboundoptionalinteger | null
ACOS lower bound, whole percent.
acosUpperboundoptionalinteger | null
ACOS upper bound, whole percent.
fixedLengthoptionalnumber | null
Fixed length.
fixedWidthoptionalnumber | null
Fixed width.
fixedHeightoptionalnumber | null
Fixed height.
fixedLengthUnitoptionalstring | null
Unit of the fixed size; None means cm.
fixedWeightoptionalnumber | null
Fixed weight.
fixedWeightUnitoptionalstring | null
Unit of the fixed weight; None means g.
investmentDifficultyAmountThresholdoptionalMinorUnitMoney | null
Entry-budget threshold.
ReportPurchasingCostProvenancevalues · 2
WHERE one priced listing's effective purchase cost came from.
values: USER_SUPPLIEDCOHORT_INFERRED
ReportPurchasingCostView8
The expected purchasing cost plus the evidence that AUTHORISED it.
createdoptionalstring
updatedoptionalstring
amountrequiredReportMoneyPoint
Settled expected purchasing cost.
sourcerequiredEstimateSource
Provenance of the costed line.
estimateKeyoptionalstring | null
Material estimate that authorised the amount.
confidenceoptionalReportEstimateConfidence | null
Confidence of the authorising material estimate.
boundsoptionalReportMoneyRange | null
Low/high unit-cost range the estimate allowed.
reasonoptionalstring | null
Deterministic reasoning behind the amount.
ReportRangeKindvalues · 2
Whether a range describes THIS product or a peer cohort.
values: SCENARIO_BOUNDCOHORT_BENCHMARK
ReportRateAbsenceReasonvalues · 2
Why a cohort rate is a typed absence rather than a percentage.
values: NO_ELIGIBLE_LISTINGNO_DETERMINATE_LISTING
ReportRatioRange8
A unitless low/high pair (for example a margin) with its range kind.
createdoptionalstring
updatedoptionalstring
lowrequirednumber
Lower bound as a unitless ratio.
highrequirednumber
Upper bound as a unitless ratio.
kindrequiredReportRangeKind
Scenario bound or cohort benchmark.
cohortLabeloptionalstring | null
Peer cohort described; required for a benchmark.
cohortSizeoptionalinteger | null
Peer cohort size; required for a benchmark.
boundScenarioKeysoptionalany[] | null
Frozen scenario keys behind low/high; required for a bound.
ReportReasonCodevalues · 7
The closed set of reasons a report did not end SUITABLE.
values: INSUFFICIENT_SIMILAR_LISTINGSMATERIAL_INPUT_UNRESOLVEDNO_QUALIFYING_LAUNCH_EVIDENCEEVIDENCE_CONFLICTSUSTAINED_UNPROFITABLE_MARKETNEW_RELEASE_FAILEDCOMPETITION_OR_INVESTMENT_UNSUITABLE
ReportRepresentativeQualityvalues · 2
Whether the representative was chosen from a real sales signal.
values: KNOWNUNKNOWN
ReportRetryEligibilityvalues · 3
Whether a terminated run may be retried, and by whom.
values: RETRYABLERETRYABLE_AFTER_INPUT_CHANGENOT_RETRYABLE
ReportRiskAnalysis7
Independent RISK analysis of the accepted artifacts.
createdoptionalstring
updatedoptionalstring
findingsoptionalReportAnalystFinding[]
Concrete risks, each with citations.
default: []
missingEvidenceoptionalstring[]
Evidence the analyst needed but did not find in the artifacts.
default: []
blockingUnsuitablerequiredboolean
Whether the risks alone would close the report unsuitable.
summaryrequiredstring | null
One-paragraph risk summary.
proseWithheldoptionalboolean
True only where a public read withheld this analysis' prose.
default: false
ReportScopeAnswer3
Store a category and the exact keyword text supplied for a report scope.
decisionTypeoptionalstring
values: REPORT_SCOPE
default: "REPORT_SCOPE"
categoryIdrequiredinteger
Confirmed category id.
keywordsoptionalstring[]
Stored keyword text; a NEW REPORT_SCOPE answer needs at least one owner-confirmed, non-blank keyword.
default: []
ReportScopeCandidate3
One category candidate the agent may confirm for the report scope.
categoryIdrequiredinteger
Candidate Amazon category node id.
categoryNamerequiredstring
Readable category name.
keywordsoptionalstring[]
Empty: candidate discovery supplies no keywords.
default: []
ReportSectionKindvalues · 4
The EXACT set of report sections a reader may request.
values: LISTING_BUILDMARKET_SUCCESS_INVESTMENTNARRATIVEFINAL_OVERVIEW
ReportSectionQuery2
Ask for one written section (market numbers, narrative, final overview).
objectoptionalstring
values: report_section
default: "report_section"
sectionrequiredReportSectionKind
ReportStandoutMarketTraits7
The old report's market traits the agent may attach to its standout choice.
newProfitableMustPrivateMoldrequiredboolean
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.
newProfitableSignificantRndrequiredboolean
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.
newProfitableHasBatteryrequiredboolean
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.
newProfitableHasBluetoothrequiredboolean
True if products have Bluetooth; otherwise False. If no profitable products are provided, decide based on old market products.
newProfitableChildrenProductrequiredboolean
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.
productDiversityrequiredLlmProductDiversity
How standardized the category is and how much design matters.
productAlternativesoptionalstring[]
Alternatives a buyer would weigh; ten at most.
default: []
ReportStandoutPick2
ONE chosen standout product, mirroring the legacy unique-product output.
itemKeyrequiredstring
Chosen listing identity.
reasonrequiredstring
Why this product stands out, in judgements and names only; never quote figures.
ReportSuccessRate6
One success rate with its explicit numerator, denominator, or absence.
createdoptionalstring
updatedoptionalstring
valueoptionalnumber | null
Rate in [0, 1]; None when absent.
numeratorrequiredinteger
Listings counted in the numerator.
denominatorrequiredinteger
Listings counted in the denominator.
absenceReasonoptionalReportRateAbsenceReason | null
Typed reason the rate has no value.
ReportSuccessRateProjection11
The three cohort success rates plus everything excluded from them.
createdoptionalstring
updatedoptionalstring
eligibleCountrequiredinteger
Listings with an eligible member.
successCountrequiredinteger
Eligible listings proving success.
failureCountrequiredinteger
Eligible listings proving failure.
unresolvedCountrequiredinteger
Eligible listings proving neither.
robustrequiredReportSuccessRate
successes / all eligible listings.
expectedrequiredReportSuccessRate
successes / determinate listings.
possiblerequiredReportSuccessRate
(successes + unresolved) / all eligible listings.
excludedCountrequiredinteger
Listings removed by policy.
excludedGroupsoptionalReportExcludedGroup[]
Removed listings grouped by policy reason.
default: []
ReportTerminalState8
Why a run stopped operationally, with the last durable revision.
createdoptionalstring
updatedoptionalstring
statusrequiredReportTerminalStatus
Operational stop status.
reasonrequiredstring
Internal, reviewer-facing reason.
userMessagerequiredstring
Reader-facing message safe to display.
committedRevisionrequiredinteger
Last committed revision; 0 when nothing was committed.
retryEligibilityrequiredReportRetryEligibility
Whether and how this run may be retried.
failedPhaseoptionalReportPhase | null
Phase that failed; required for FAILED_PARTIAL.
ReportTerminalStatusvalues · 2
Operational ways a run stops WITHOUT a business verdict.
values: CANCELLEDFAILED_PARTIAL
ReportUnitDescriptor6
One phase artifact that is READY and safe to render.
createdoptionalstring
updatedoptionalstring
phaserequiredReportPhase
Phase that produced the ready unit.
artifactKeyoptionalstring | null
Immutable artifact id; owner reads only, never public.
revisionrequiredinteger
Revision the artifact was committed in.
committedAtrequiredstring
Instant the artifact was committed.
ReportV3ConclusionToolResult7
One V3 report's verdict plus its reasoning chain, or a typed absence.
createdoptionalstring
updatedoptionalstring
objectoptionalstring
values: report_v3_conclusion
default: "report_v3_conclusion"
consultedRevisionrequiredinteger
Revision this answer read.
latestRevisionrequiredinteger
Latest committed revision.
viewoptionalReportConclusionEvidenceView | null
Verdict and reasoning; None when not reached.
absenceoptionalReportCompactAbsence | null
Typed reason no verdict exists at this revision.
ReportV3EstimationToolResult7
One V3 report's material-estimation evidence, or a typed absence.
createdoptionalstring
updatedoptionalstring
objectoptionalstring
values: report_v3_estimation
default: "report_v3_estimation"
consultedRevisionrequiredinteger
Revision this answer read.
latestRevisionrequiredinteger
Latest committed revision.
viewoptionalReportEstimationEvidenceView | null
How material inputs were resolved.
absenceoptionalReportCompactAbsence | null
Typed reason the methodology is unavailable.
ReportV3JudgmentToolResult6
One V3 report's head conclusion question, pinned to the revision read.
createdoptionalstring
updatedoptionalstring
objectoptionalstring
values: report_v3_judgment
default: "report_v3_judgment"
consultedRevisionrequiredinteger
Revision this answer read.
latestRevisionrequiredinteger
Latest committed revision.
questionrequiredJudgmentQuestion
The head's conclusion question.
ReportV3LifecycleToolResult7
One V3 report's lifecycle evidence, or a typed absence.
createdoptionalstring
updatedoptionalstring
objectoptionalstring
values: report_v3_lifecycle
default: "report_v3_lifecycle"
consultedRevisionrequiredinteger
Revision this answer read.
latestRevisionrequiredinteger
Latest committed revision.
viewoptionalReportLifecycleEvidenceView | null
Lifecycle verdict and corroboration.
absenceoptionalReportCompactAbsence | null
Typed reason the lifecycle is unavailable.
ReportV3ListingDetailToolResult5
One economic listing's members and economics at a revision.
createdoptionalstring
updatedoptionalstring
objectoptionalstring
values: report_v3_listing_detail
default: "report_v3_listing_detail"
consultedRevisionrequiredinteger
Revision this answer read.
detailrequiredReportListingDetailView
Listing detail view.
ReportV3ListingsToolResult5
One cursor page of a V3 report's comparable listings at a revision.
createdoptionalstring
updatedoptionalstring
objectoptionalstring
values: report_v3_listings
default: "report_v3_listings"
consultedRevisionrequiredinteger
Revision this answer read.
pagerequiredReportListingPage
Ordered listing summaries.
ReportV3OverviewToolResult6
One V3 report's typed facts at the exact revision that was consulted.
createdoptionalstring
updatedoptionalstring
objectoptionalstring
values: report_v3_overview
default: "report_v3_overview"
consultedRevisionrequiredinteger
Revision this answer read.
latestRevisionrequiredinteger
Latest committed revision.
viewrequiredReportCompactView
Typed, absence-complete facts.
ReportV3SectionToolResult6
One display-safe written section of a V3 report, or its typed gap.
createdoptionalstring
updatedoptionalstring
objectoptionalstring
values: report_v3_section
default: "report_v3_section"
consultedRevisionrequiredinteger
Revision this answer read.
sectionoptionalReportListingCohortSectionView | ReportMarketSectionView | ReportNarrativeSectionView | ReportFinalOverviewSectionView | null
Display-safe section view; None when not built.
absenceoptionalReportGapDescriptor | null
Typed gap of a section this revision has not built.
ReportVerdictvalues · 3
The three business verdicts a V3 report may reach.
values: SUITABLENOT_SUITABLENOT_DETERMINABLE
ReportVersionvalues · 2
Persisted report FORMAT identity, read from storage and never inferred.
values: 2.0.03.0.0
ResizeDesign5
Move an OWN image to another preset (e.g. secondary 2000x2000 -> A+ header 970x600).
actionoptionalstring
values: RESIZE_DESIGN
default: "RESIZE_DESIGN"
designIdrequiredstring
presetrequiredstring
values: 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
sizeoptionalPixelSize | null
moderequiredResizeMode
ResizeModevalues · 2
How layers follow a canvas resize (the Magic-Resize choice; also a variant recipe's fit).
values: SCALE_TO_FITREFLOW
Resolutionvalues · 5
Who resolves an issue, derived from its kind and permission.
values: RECONNECTFIX_AT_PROVIDERWAITSUPPORTCHECK_REQUEST
ResolvedWindow2
ONE resolved time window: its axis and the span it was resolved to.
axisrequiredTimeAxis
Which instant the window is measured on.
spanrequiredDateWindow
The resolved inclusive span.
RestoreRow2
Bring a discarded row back into the next proposal.
opoptionalstring
values: RESTORE_ROW
default: "RESTORE_ROW"
rowKeyrequiredstring
ResumeStoreRequest1
Resume capture after the caller has reconciled the store's slot policy.
storeIdrequiredstring
Store whose sync will resume.
RevertFidelityvalues · 3
How completely ELTA can undo an action, projected onto every action diff.
values: EXACTBEST_EFFORTNONE
RevertRequest4
Ask ELTA to construct the undo of one proposal; callers choose rows, never undo values.
proposalIdrequiredstring
Proposal to revert.
actionKeysoptionalstring[]
Optional rows to revert; empty means every revertible row.
default: []
replayKeyoptionalstring | null
Caller-owned idempotency key.
attributionoptionalProposalAttribution | null
Origin and reason of this undo; excluded from its hash.
RoomCell2
One rendered cell: the computed cell plus its stored score and tier (None when unscored).
cellrequiredCell
scoreoptionalCellScore | null
RoomPublicAssessment5
One declared judgement as a customer sees it, without its model brief or dependencies.
objectoptionalstring
values: room_assessment
default: "room_assessment"
keyrequiredstring
labelrequiredLocalizedText
kindrequiredAssessmentKind
rangesoptionalAssessmentRange[]
default: []
RoomPublicDecisionOffer4
Whether a decision run can start, without the internal decision-input size.
objectoptionalstring
values: room_decision_offer
default: "room_decision_offer"
eligiblerequiredboolean
refusaloptionalDecisionRefusal | null
offeredCellsoptionalinteger
default: 0
RoomPublicDecisionRead5
The decision read a customer sees, with request_chars dropped.
objectoptionalstring
values: room_decision
default: "room_decision"
scorecardoptionalRoomPublicScorecard | null
decisionoptionalDecisionRecord | null
offerrequiredRoomPublicDecisionOffer
scoredCellsoptionalRoomCell[]
default: []
RoomPublicDeclaration13
One plugin declaration as a customer room renders it.
objectoptionalstring
values: room_declaration
default: "room_declaration"
pluginIdrequiredstring
titlerequiredLocalizedText
descriptionrequiredLocalizedText
itemNounrequiredLocalizedText
setuprequiredSetupField[]
factsrequiredFactSpec[]
measuresrequiredRoomPublicMeasure[]
assessmentsrequiredRoomPublicAssessment[]
dimensionsrequiredRoomPublicDimensions
gridrequiredGridSpec
detailrequiredDetailSection[]
itemCardrequiredItemCardSpec
RoomPublicDimensions2
Which dimensions a positioning may use, without the classifier brief.
objectoptionalstring
values: room_dimensions
default: "room_dimensions"
computedoptionalBandedDimension[]
default: []
RoomPublicMeasure4
One declared measure as a customer sees it, without its computation rule.
objectoptionalstring
values: room_measure
default: "room_measure"
keyrequiredstring
labelrequiredLocalizedText
formatrequiredMeasureFormat
RoomPublicPositioning10
The customer-visible half of one positioning record.
objectoptionalstring
values: room_positioning
default: "room_positioning"
positioningIdrequiredstring
taskIdrequiredstring
gridIdoptionalstring | null
pluginIdrequiredstring
languagerequiredLanguage
briefrequiredstring
phaserequiredPhase
statusrequiredPhaseStatus
createdAtrequiredstring
RoomPublicRead8
Everything the customer room renders, with the plugin declaration projected safe.
objectoptionalstring
values: room
default: "room"
positioningrequiredRoomPublicPositioning
declarationrequiredRoomPublicDeclaration
viewportrequiredViewport
viewrequiredViewDefinition
dimensionsrequiredDimensionRecord[]
criteriarequiredCriterionRecord[]
cellsrequiredRoomCell[]
RoomPublicScorecard6
One stored scorecard as a customer sees it, without request_chars.
objectoptionalstring
values: room_scorecard
default: "room_scorecard"
profilerequiredstring
cellsrequiredCellScore[]
excludedoptionalstring[]
default: []
thresholdoptionalinteger
default: 60
scoredAtrequiredstring
RouteHints5
The pinned read preferences carried with a public question.
channeloptionalChannel | null
Channel pinned for the question; null lets the router choose.
marketoptionalstring | null
Market pinned for the selected channel and node family.
resultKindoptionalAnalyzedRecordKind | null
Record family pinned for the answer.
nodeKindoptionalNodeKind | null
Node family pinned for a node answer.
windowDaysoptionalinteger | 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.
diffrequiredActionDiff
outcomerequiredActionOutcome
RunEnding3
How a finished run ended, kept on its run state after the durable event is delivered.
outcomerequiredRunOutcome
failureCodeoptionalRunFailureCode | null
stepoptionalRunStep | null
RunFailureCodevalues · 4
The finite reasons a run ended without success.
values: IN_FLIGHT_CALLWAIT_EXPIREDSETUP_INVALIDSTEP_ATTEMPTS_EXHAUSTED
RunOutcomevalues · 3
The execution outcome of a run. The host owns settlement.
values: SUCCEEDEDFAILEDABANDONED
RunRead8
Where the run stands: the stepper, the step waiting for review, queued work, the grid's shape.
positioningrequiredPositioningRecord
nextSteprequiredRunStep | null
waitingAfterrequiredRunStep | null
waitingUntilrequiredstring | null
queuedrequiredChangeActionType[]
endingrequiredRunEnding | null
dimensionsrequiredDimensionRecord[]
criteriarequiredCriterionRecord[]
RunStepvalues · 6
The six run steps, in order. Each of the first five can be reviewed by the caller.
values: SCOPESOURCEDIMENSIONSPLACEASSESSSCORE
SampleConfirmation5
SAMPLE_CONFIRMATION (1.6): the sample shown, the seller's verdict, and what to change.
stepoptionalstring
values: SAMPLE_CONFIRMATION
default: "SAMPLE_CONFIRMATION"
shownPostKeysrequiredstring[]
verdictrequiredSampleVerdict
feedbackoptionalstring | null
revisePostKeysoptionalstring[]
default: []
SampleRelevanceAnswer2
A fragment of the delegated sample-relevance decision.
decisionTypeoptionalstring
values: SAMPLE_RELEVANCE
default: "SAMPLE_RELEVANCE"
verdictsrequiredSampleRelevanceVerdict[]
One verdict per judged item.
SampleRelevanceItem6
ONE frozen product projection: a labelled baseline or a candidate.
itemKeyrequiredstring
Stable candidate identity.
asinrequiredstring
Display ASIN.
titleoptionalstring | null
Display title.
brandoptionalstring | null
Display brand.
imageUrloptionalstring | null
Display image URL.
priceoptionalMinorUnitMoney | null
Observed selling price.
SampleRelevanceVerdict5
ONE verdict on whether a candidate belongs to the analysed product.
itemKeyrequiredstring
Judged candidate identity.
similarityrequiredProductSimilarType
Matcher similarity level.
isBatteryoptionalboolean | null
Whether the candidate contains a battery.
isAppareloptionalboolean | null
Whether the candidate is apparel.
reasonoptionalstring
Short justification.
default: ""
SampleVerdictvalues · 2
The seller's reaction to the sample the agent showed (1.6).
values: APPROVEDREVISE
SaveCriterion3
Create or replace one criterion; its results are judged only when asked (ASSESS).
typeoptionalstring
values: SAVE_CRITERION
default: "SAVE_CRITERION"
actionKeyrequiredstring
criterionrequiredCriterionRecord
SaveDimension3
Create or replace one dimension with its ordered options (rename, reorder, drop in one save).
typeoptionalstring
values: SAVE_DIMENSION
default: "SAVE_DIMENSION"
actionKeyrequiredstring
dimensionrequiredDimensionRecord
SaveView5
Create or replace one saved view in the viewer's own viewport.
typeoptionalstring
values: SAVE_VIEW
default: "SAVE_VIEW"
actionKeyrequiredstring
viewerrequiredViewerRef
expectedRevisionrequiredinteger
viewrequiredViewDefinition
ScenarioRolevalues · 4
Role of one coherent economic scenario inside a profit envelope.
values: ROBUSTEXPECTEDPOSSIBLETIER_PROBE
SceneCueBinding1
A plan column whose non-empty cell queues one paid GenerateScene(replaces=…) on that row's image.
bindingoptionalstring
values: SCENE_CUE
default: "SCENE_CUE"
Score2
Recompute the scorecard from the cells as they are now (after edits, if the caller wants).
typeoptionalstring
values: SCORE
default: "SCORE"
actionKeyrequiredstring
ScreeningEnforcementvalues · 2
Whether a cited screening finding blocks proposing or is shown as guidance.
values: BLOCKHINT
ScreeningFinding5
One finding: why, where, matched text, rule and copied enforcement.
reasonrequiredScreeningRefusal
pointerrequiredstring
matchedTextrequiredstring
rulerequiredScreeningRule
enforcementrequiredScreeningEnforcement
ScreeningRefusalvalues · 4
Why a text leaf is blocked; each value has its own user-facing explanation key.
values: SENSITIVE_CATEGORYFORBIDDEN_TERMKNOWN_NON_OWNER_BRANDDISALLOWED_CHARACTER
ScreeningResult3
Cited findings under one deployed rule bundle and one frozen brand corpus.
policyBundleVersionrequiredstring
brandCorpusrequiredBrandCorpusRef
findingsrequiredScreeningFinding[]
ScreeningRule3
One checked-in rule, its citation and whether its findings block.
ruleIdrequiredstring
citationrequiredPolicyCitation
enforcementrequiredScreeningEnforcement
SearchAnswer2
A public decoded single-subject answer.
objectrequiredstring
Public object discriminator.
values: answer
answerrequiredstring
Decoded answer text for the caller.
SearchClarify4
A public clarification request.
objectrequiredstring
Public object discriminator.
values: clarify
askUserrequiredstring
Question the caller must answer.
choicesrequiredstring[]
Allowed clarification choices.
queryKeyrequiredstring
Stored partial-query key being resumed.
SearchItem8
One public result item of the text-routed search page.
objectrequiredstring
Public object discriminator.
values: record
recordKindrequiredAnalyzedRecordKind
Record family of the item.
recordKeyrequiredstring
Stable record key.
channelrequiredChannel | null
Source channel, when applicable.
labeloptionalstring | null
Readable display label, when known.
fieldsrequiredobject
Authorized dynamic scalar values for the record.
evidencerequiredMatchedFact[]
Evidence explaining the matched query clauses.
relationsoptionalRelationRef[]
Observed relationships to other served nodes; at most 16.
default: []
SearchObject20
The requested target kind, exact identities and typed target predicates.
kindrequiredNodeKind
Node kind requested as the target of the search.
targetIdsoptionalNodeRef[] | null
Explicit target identities to restrict the result to; null means no explicit selection.
clausesoptionalTextClause[] | BrandClause[] | CategoryClause[] | MetricClause[] | PriceClause[] | DateClause[] | ContactClause[]
Predicates ANDed over the target; CONTACT is CREATOR-only and cannot appear in any_of.
default: []
anyOfoptionalTextClause[][] | BrandClause[][] | CategoryClause[][] | MetricClause[][] | PriceClause[][] | DateClause[][]
Groups whose member predicates are ORed together; the groups themselves are ANDed.
default: []
channeloptionalChannel | null
Channel to search; null searches stored rows across channels, and a live search needs a channel.
peersoptionalPeerIntent | null
Same-kind peer meaning (competitors/lookalikes); valid only when the source and target kinds match.
evidenceBasesoptionalEvidenceBasis[] | 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.
marketoptionalstring | null
Market the search runs in; null uses the searcher's default.
sortoptionalSort | null
Ordering of the returned target rows.
requireoptionalstring[]
Fields that every returned record must carry.
default: []
conceptKindoptionalConceptKind | null
Concept kind filter when the target kind is CONCEPT.
presetoptionalMotifSection | null
Named motif section preset; valid only for a MOTIF target read in ANALYZED mode.
textFromoptionalstring | null
Which source fact becomes the target's search text; null keeps the standard builder.
dateWindowoptionalDateWindow | null
Inclusive calendar span for a KEYWORD or CONTENT target.
motifWindowoptionalMotifWindow | null
Motif comparison window: the selected days and the equally long window before them.
livePageoptionalinteger | null
LIVE-only page number carried to the DIC query; null uses the DIC default. A stored read refuses it with UNSUPPORTED_QUESTION.
buyBoxFulfilledByMarketplaceoptionalboolean | null
PRODUCT LIVE only: carried to the DIC ProductQuery field of the same name; a stored read refuses it with UNSUPPORTED_QUESTION.
oneVariantPerParentoptionalboolean | 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.
acquisitionoptionalstring | null
Snapshot acquisition opt-in copied to the DIC query; null means LIVE. `:check` refuses it under ANALYZED or on a seeded or non-root hop.
limitoptionalinteger
Maximum number of target rows returned.
default: 20
SearchPage8
A public page of text-routed search items and its opaque cursor.
objectrequiredstring
Public object discriminator.
values: search_page
resultKindrequiredAnalyzedRecordKind
Family shared by all page items.
itemsrequiredSearchItem[]
Result items in page order.
coveragerequiredCoverageNote[]
Disclosed coverage gaps.
windowEndrequiredstring
Resolved window end for this page.
cursorrequiredstring | null
Opaque signed token for the next page.
unappliedoptionalstring[]
Verbatim question substrings the router could not apply; at most 8.
default: []
emptyCauseoptionalGapKind | null
Why this page returned no items; null when it carries items.
SearchPending3
A public search whose source has not settled yet.
objectrequiredstring
Public object discriminator.
values: search_pending
detailrequiredstring
Safe explanation: results are still being collected; repeat the same search shortly.
retryAfterSecondsrequiredinteger
Seconds after which the caller may repeat the same search.
SearchPlacement4
One typed display placement of a RANKED_FOR relationship.
placementrequiredSearchPlacementType
rankoptionalinteger | null
pageoptionalinteger | null
pageRankoptionalinteger | null
SearchPlacementTypevalues · 7
Name one documented Amazon search-result placement in plain channel terms.
values: ORGANICSPONSORED_PRODUCTSAMAZON_CHOICESPONSORED_BRANDSSPONSORED_BRANDS_VIDEOOTHER_ORGANICOTHER_SPONSORED
SearchRefused6
A typed public refusal with honest, topic-free next steps (D-23.1).
objectrequiredstring
Public object discriminator.
values: refused
reasonrequiredstring
Stable public refusal reason.
values: UNSUPPORTED_QUESTIONDATA_CHANGEDINVALID_CURSORNOT_AVAILABLE
detailrequiredstring
Safe explanation of the refusal.
refusalrequiredRefusal
Typed refusal code, field and DP-worded detail.
suggestionsoptionalCreatorHandleSuggestion[] | TopByMetricSuggestion[]
Supported next steps that do not reuse an unapplied topic.
default: []
failureRefoptionalFailureRef | null
Public request-ledger id this refusal was recorded as.
SearchRequest7
One question or structured search with an optional per-call row ceiling.
maxRowsoptionalinteger | null
Optional row ceiling for this call; the smaller of this and the normal page size is returned. Omission preserves the normal page size.
answerLanguageoptionalAnswerLanguage
Language of seller-facing clarifications and refusals.
default: "EN"
questionoptionalstring | null
The natural-language question to answer.
searchoptionalSearch | null
The typed structured search to execute.
hintsoptionalRouteHints | null
Optional predicates pinned into the stored plan.
clarificationoptionalClarificationAnswer | null
The stored clarification choice being resumed.
fieldsoptionalstring[] | null
Authorized display-field whitelist; null means all authorized fields.
SetBackground3
Set an image's background colour (literal or kit ref); on a VARIANT it is a BACKGROUND override.
actionoptionalstring
values: SET_BACKGROUND
default: "SET_BACKGROUND"
designIdrequiredstring
colorrequiredColor | BrandColorRef
SetBoardTitle2
Rename the board through the same revisioned edit batch as every other change (D-12a).
actionoptionalstring
values: SET_BOARD_TITLE
default: "SET_BOARD_TITLE"
titlerequiredstring
SetBox4
Move, resize or rotate one layer; on a group, its children move and scale so their bounds become box.
actionoptionalstring
values: SET_BOX
default: "SET_BOX"
designIdrequiredstring
layerIdrequiredstring
boxrequiredBox
SetDailyBudgetValue2
The suggested daily budget of one Sponsored Products campaign.
kindoptionalstring
values: daily_budget
default: "daily_budget"
dailyBudgetrequirednumber | string
SetImageTransform6
Set an image layer's flips and crop together (all stated, like SetLayerFlags); free.
actionoptionalstring
values: SET_IMAGE_TRANSFORM
default: "SET_IMAGE_TRANSFORM"
objectIdrequiredstring
layerIdrequiredstring
flipXrequiredboolean
flipYrequiredboolean
croprequiredBox | null
SetLayerFlags8
Set a layer's name, opacity, blend, visibility and lock together (all stated, none optional).
actionoptionalstring
values: SET_LAYER_FLAGS
default: "SET_LAYER_FLAGS"
designIdrequiredstring
layerIdrequiredstring
namerequiredstring
opacityrequirednumber
blendModerequiredBlendMode
visiblerequiredboolean
lockedrequiredboolean
SetObjectFrame4
Rename and/or move any object on the board; allowed while AI-busy (a landing never reads position).
actionoptionalstring
values: SET_OBJECT_FRAME
default: "SET_OBJECT_FRAME"
objectIdrequiredstring
nameoptionalstring | null
positionoptionalBoardPoint | null
SetObjectLock3
Lock or unlock one object against agent edits; sole in its batch, USER only, writes only the lock map (A1).
actionoptionalstring
values: SET_OBJECT_LOCK
default: "SET_OBJECT_LOCK"
objectIdrequiredstring
lockedrequiredboolean
SetPlacements4
Put groups into options of one dimension by hand (None takes a group out).
typeoptionalstring
values: SET_PLACEMENTS
default: "SET_PLACEMENTS"
actionKeyrequiredstring
dimensionKeyrequiredstring
placementsrequiredobject
SetPlan5
Edit a plan: replace its columns, upsert rows by id, delete rows (merges rev 1's two plan actions, A18).
actionoptionalstring
values: SET_PLAN
default: "SET_PLAN"
planIdrequiredstring
columnsoptionalPlanColumn[] | null
upsertRowsoptionalPlanRow[]
default: []
deletedRowIdsoptionalstring[]
default: []
SetResults4
Write cells' results of one assessment or criterion by hand (the ASSESS review's answer).
typeoptionalstring
values: SET_RESULTS
default: "SET_RESULTS"
actionKeyrequiredstring
assessmentrequiredstring
resultsrequiredobject
SetReview3
Change who decides the named steps; takes effect at the next step that ends.
typeoptionalstring
values: SET_REVIEW
default: "SET_REVIEW"
actionKeyrequiredstring
reviewrequiredobject
SetSettings4
Set values on one section, or on one of its blocks when block_key is given.
actionoptionalstring
values: SET_SETTINGS
default: "SET_SETTINGS"
sectionKeyrequiredstring
blockKeyoptionalstring | null
settingsrequiredobject
SetSetup3
Replace the named setup values (the SCOPE review's answer, or a later correction).
typeoptionalstring
values: SET_SETUP
default: "SET_SETUP"
actionKeyrequiredstring
valuesrequiredobject
SetShadow4
Set or clear the drop shadow of any leaf layer (image, text or shape).
actionoptionalstring
values: SET_SHADOW
default: "SET_SHADOW"
designIdrequiredstring
layerIdrequiredstring
shadowrequiredDropShadow | null
SetShapeStyle6
Replace a shape layer's fill and stroke, and optionally its geometry (None keeps the current one).
actionoptionalstring
values: SET_SHAPE_STYLE
default: "SET_SHAPE_STYLE"
designIdrequiredstring
layerIdrequiredstring
fillrequiredColor | BrandColorRef | LinearGradient | RadialGradient | null
strokerequiredStroke | null
geometryoptionalRectGeometry | 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.
setIdrequiredstring
headRevisionrequiredinteger
headCommittedAtoptionalstring | null
stepsoptionalPaidStepView[]
default: []
lastRefusaloptionalEditRefusal | null
aiPausedUntiloptionalstring | null
objectsoptionalObjectStatus[]
default: []
SetText4
Replace a text layer's text.
actionoptionalstring
values: SET_TEXT
default: "SET_TEXT"
designIdrequiredstring
layerIdrequiredstring
textrequiredstring
SetTextStyle4
Replace a text layer's whole style (font, weight, size, colour, alignment).
actionoptionalstring
values: SET_TEXT_STYLE
default: "SET_TEXT_STYLE"
designIdrequiredstring
layerIdrequiredstring
stylerequiredTextStyle
SetVariantRecipe3
Replace a variant's recipe: the one writer of its preset, size, fit, colour map and plan row.
actionoptionalstring
values: SET_VARIANT_RECIPE
default: "SET_VARIANT_RECIPE"
objectIdrequiredstring
reciperequiredVariantRecipe
SetupField8
One input a positioning of this plugin needs before sourcing.
keyrequiredstring
labelrequiredLocalizedText
helprequiredLocalizedText
kindrequiredSetupFieldKind
optionsoptionalSetupOption[]
default: []
requiredoptionalboolean
default: true
maxItemsoptionalinteger | null
minimumoptionalnumber | string | null
SetupFieldKindvalues · 5
How one setup input is entered in the create form and filled by the scope model.
values: TEXTTEXT_LISTCHOICEMULTI_CHOICENUMBER
SetupOption2
One allowed value of a CHOICE field.
valuerequiredstring
labelrequiredLocalizedText
ShadowField2
Override value: a leaf layer's drop shadow (None = no shadow).
fieldoptionalstring
values: SHADOW
default: "SHADOW"
shadowrequiredDropShadow | null
ShapeLayer12
Free vector composition: panels, bands, badges, outlines and icons (D-13, VV-1/2).
layerIdrequiredstring
namerequiredstring
opacityoptionalnumber
default: 1
blendModeoptionalBlendMode
default: "NORMAL"
visibleoptionalboolean
default: true
lockedoptionalboolean
default: false
boxrequiredBox
shadowoptionalDropShadow | null
kindoptionalstring
values: SHAPE
default: "SHAPE"
geometryrequiredRectGeometry | EllipseGeometry | LineGeometry | PolygonGeometry | PathGeometry
filloptionalColor | BrandColorRef | LinearGradient | RadialGradient | null
strokeoptionalStroke | null
ShippingModevalues · 3
First-leg transport mode from the manufacturer to the marketplace.
values: FREIGHTAIRRAIL
ShippingProfile5
Canonical shipping-rate inputs for legacy float weight formulas.
exchangeRatesrequiredExchangeRateInUsd[]
freightPerKgrequiredMinorUnitMoney
airPerKgrequiredMinorUnitMoney
railPerKgoptionalMinorUnitMoney | null
cubicCmBreakpointoptionalinteger
default: 6000
ShopifyRemoteImage2
An HTTPS image source Shopify must ingest through fileCreate before content write.
urlrequiredstring
alt_textoptionalstring
default: ""
SizingDetail18
Typed replacement for the legacy === METADATA === sizing prose.
sizeTierrequiredstring
longestSideInchesrequirednumber
medianSideInchesrequirednumber
shortestSideInchesrequirednumber
longestSideCmrequirednumber
medianSideCmrequirednumber
shortestSideCmrequirednumber
weightLbrequirednumber
weightKgrequirednumber
dimensionalWeightLboptionalnumber | null
dimensionalWeightKgoptionalnumber | null
shippingWeightLboptionalnumber | null
shippingWeightKgoptionalnumber | null
volumeCubicMeterrequirednumber
girthrequirednumber
girthUnitrequiredstring
values: inchcm
feeCategoryrequiredstring
sourcerequiredEstimateSource
SlotFinding4
One rule checked on one design: passed or not, with the measured value when numeric.
designIdrequiredstring
rulerequiredWhiteBackgroundRule | MinLongestSideRule | MaxLongestSideRule | ProductFillRule | NoTextRule | NoGraphicsRule | NoEdgeCropRule | NoBadgeClaimsRule | LayerClippedRule
passedrequiredboolean
measuredoptionalnumber | null
SocialTextTrack8
Retain one bounded transcript or caption with truthful truncation facts.
languageoptionalstring | null
kindrequiredSocialTextTrackKind
textoptionalstring | null
capturedAtrequiredstring
provenancerequiredProvenance
truncatedoptionalboolean
default: false
omittedoptionalboolean
default: false
originalLengthoptionalinteger | null
SocialTextTrackKindvalues · 2
Distinguish transcript and caption text without provider-specific kinds.
values: TRANSCRIPTCAPTION
Sort5
Request ordering by one typed metric, or by one launch instant (L-66(3)).
metricoptionalMetricKind | null
fieldoptionalstring | null
directionoptionalstring
values: DESCASC
default: "DESC"
windowoptionalRankingWindow | null
changeoptionalboolean
default: false
Source11
One thing an owner binds: a provider grant that reaches one or more accounts.
keyrequiredstring
Connectable catalog source identifier.
titlerequiredStoreLocalizedText
Display name of this source, in both languages.
connectrequiredConnectStyle[]
Ways this deployment offers to bind.
credentialsrequiredCredential[]
Access fields used by this source.
regionsoptionalProviderRegion[]
Sales regions the owner picks from before consent; empty means no region step.
default: []
availableoptionalboolean
False when this deployment cannot connect the source yet.
default: true
consentLifetimeDaysoptionalinteger | null
Provider-forced consent lifetime in days, when declared.
accountAttributesoptionalAttribute[]
Metadata attributes discovery reports for each account.
default: []
datasetsoptionalDataset[]
Datasets captured and retained.
default: []
lookupsoptionalLookup[]
Reads answered live without storing their results.
default: []
actionsoptionalProviderWriteActionType[]
Writes applied only after approval.
default: []
SourceDescriptionKindvalues · 10
DP-owned: WHICH descriptive field of a source a string came from.
values: SEARCH_TERMTAGHASHTAGTITLEBRANDNAMEHANDLECATEGORYCONCEPTMOTIF
SourceModevalues · 3
WHICH READ SOURCE one search step executes against.
values: LIVEANALYZEDANALYZED_THEN_LIVE
SourceReference5
A link that supports an item or an assessment, with the source context people saw.
urlrequiredstring
titleoptionalstring | null
snippetoptionalstring | null
publisheroptionalstring | null
publishedAtoptionalstring | null
SourceSubject3
Identify one source object by channel, content kind, and exact external ID.
channelrequiredChannel
kindrequiredObjectKind
externalIdrequiredstring
SourcedItem7
One item a plugin found: identity, facts and what models see.
keyrequiredstring
namerequiredstring
groupKeyoptionalstring | null
mainoptionalboolean
default: false
factsoptionalobject
promptrequiredItemPrompt
referencesoptionalSourceReference[]
default: []
SpanEvidence3
The transcript span or caption an element cites (T1).
kindrequiredstring
Citation shape: TRANSCRIPT for a timed span, CAPTION for a whole caption.
values: TRANSCRIPTCAPTION
startMsoptionalinteger | null
Start offset of the cited transcript span in milliseconds; null for a CAPTION.
endMsoptionalinteger | 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.
stagerequiredChangeListStage
instructionrequiredstring
StagedProposal3
The exact create batch staged on an artifect snapshot BEFORE propose is called.
replayKeyrequiredstring
batchrequiredActionBatch
validUntilrequiredstring
StalePart2
One out-of-date part of an image; the editor dims it with a "Refresh · N 次请求" chip.
reasonrequiredStaleReason
layerIdoptionalstring | null
StaleReasonvalues · 1
Why part of a variant is out of date (free parts never go stale: they resolve live).
values: SOURCE_CHANGED
StandingAdjust2
MIRROR wire ArtifectStandingAdjust: pause, resume or run a standing artifect now.
adjustmentTypeoptionalstring
values: STANDING
default: "STANDING"
commandrequiredStandingControl
StandingControlvalues · 3
The core-owned standing commands (MIRROR wire ArtifectStandingAdjust.command).
values: PAUSERESUMERUN_NOW
StandingPauseByvalues · 3
Who paused a standing run (StandingFacts.paused_by); core sets it on every move to PAUSED.
values: CALLERGATEKIND
StandingStatevalues · 4
Where one standing artifect is (MIRROR wire ArtifectStandingState); core owns the moves.
values: SETTING_UPACTIVEPAUSEDSTOPPED
StandoutItem13
ONE already-built listing the agent may choose as a standout.
itemKeyrequiredstring
Stable listing identity.
asinrequiredstring
Display ASIN.
titleoptionalstring | null
Display title.
brandoptionalstring | null
Display brand.
imageUrloptionalstring | null
Display image URL.
priceoptionalMinorUnitMoney | null
Observed selling price.
latestMonthlySoldoptionalinteger | 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.
ratingIntoptionalinteger | null
Star rating in tenths (0 through 50); the same name and meaning as ReportAsinDisplayFact.rating_int.
reviewCountoptionalinteger | null
Retained review count; the same name and meaning as ReportAsinDisplayFact.review_count.
memberCountoptionalinteger | null
Members the listing summary retained.
familyEntryAgeMonthsoptionalinteger | null
Family entry age in months; a FAMILY age, not the member's.
expectedProfitoptionalMinorUnitMoney | null
LISTING_ECONOMICS expected-scenario profit; None when the listing's profit inputs are unresolved.
marginoptionalReportRatioRange | null
LISTING_ECONOMICS margin range, verbatim.
StandoutSelectionAnswer4
The agent's standout choice for a completed analysis (D3).
decisionTypeoptionalstring
values: STANDOUT_SELECTION
default: "STANDOUT_SELECTION"
picksrequiredReportStandoutPick[]
Chosen standouts, in display order.
marketoptionalReportStandoutMarketTraits | null
Optional old-report market traits; omit to hide the market-traits part.
commonItemKeysoptionalstring[]
Offered itemKeys of typical, NOT standout, listings; omit to hide the common-products part.
default: []
StdMoneyAmount1
Store one immutable signed-Int64 monetary minor-unit amount.
valuerequiredinteger
StorageLineDetail4
Per-month composition of one aggregated storage breakdown line.
monthsrequiredinteger[]
volumeCubicrequirednumber
cubicUnitrequiredstring
values: ftm
perMonthrequiredMonthlyStorageFee[]
Store11
Represent a selling entity with a stable channel ID and alias fields.
kindoptionalstring
values: STORE
default: "STORE"
channelrequiredChannel
externalIdrequiredstring
namerequiredstring
descriptionoptionalstring | null
domainoptionalstring | null
marketoptionalstring | null
publishedAtoptionalstring | null
metricsoptionalMetricObservation[]
default: []
observedAtrequiredstring
provenancerequiredProvenance
StoreCapabilities5
What the installed sources can do right now for one store: live reads, writes and captures.
objectoptionalstring
Document type: store capabilities.
values: store_capabilities
default: "store_capabilities"
storeIdrequiredstring
Store whose current abilities this document describes.
lookupsrequiredCapabilityRow[]
Installed live reads: one row per (key, account).
actionsrequiredCapabilityRow[]
Installed provider writes: one row per (key, account).
datasetsrequiredCapabilityRow[]
Installed captured datasets: one row per (key, account).
StoreOwnervalues · 2
Which service's least-privilege byte API serves this ref (fixes the 'same ref type, unknown store' hole — examiner W2).
values: DATA_INFRAPLATFORM
StoreRecord11
One owner's store spanning installed sources, with lifecycle state and stored rows.
objectoptionalstring
Document type: store record.
values: store_record
default: "store_record"
storeIdrequiredstring
Store identifier within the asserted owner scope.
titlerequiredstring
Owner's display name for the store.
regionrequiredProviderRegion | null
Sales region chosen before consent; null while the store has no region.
statusrequiredStoreStatus
Whether this store may sync.
pauseReasonoptionalPauseReason | null
Why sync is paused; null when active.
connectionsoptionalConnectionRecord[]
Connectors bound to this store; empty means connection is unfinished.
default: []
createdAtrequiredstring
When the store was created.
lastSyncedAtoptionalstring | 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 (PD-13).
storedRowsoptionalinteger
Current stored fact rows across the store's connectors, never a per-sync count.
default: 0
writePolicyoptionalWritePolicy
Owner-controlled provider-write families.
StoreStatusvalues · 2
Whether capture may run for the store; paused reads remain available.
values: ACTIVEPAUSED
StoresResponse2
The stores belonging to the asserted owner, including unfinished stores.
objectoptionalstring
Document type: stores response.
values: stores_response
default: "stores_response"
storesrequiredStoreRecord[]
Stores belonging to the asserted owner.
Stroke2
An outline colour and width.
colorrequiredColor | BrandColorRef
widthrequirednumber
StrokeField2
Override value: a shape layer's stroke (None = no stroke).
fieldoptionalstring
values: STROKE
default: "STROKE"
strokerequiredStroke | null
StyleExample5
One real article the agent found as a model for one tone (1.3); dated on/after the Setting.
toneKeyrequiredstring
articleUrlrequiredstring
titlerequiredstring
publishedOnrequiredstring
styleNotesrequiredstring
StyleExamples2
STYLE_EXAMPLES (1.3): at least one example for every tone the plan declares.
stepoptionalstring
values: STYLE_EXAMPLES
default: "STYLE_EXAMPLES"
examplesrequiredStyleExample[]
SuggestedKeywordEvidence1
A term no server-read report row matched: a suggestion, explicitly not a measurement.
kindoptionalstring
values: SUGGESTED
default: "SUGGESTED"
SuggestedPurchasingCost5
User suggestion calibrated against one marketplace benchmark product.
asinrequiredstring
suggestedPurchasingCostrequiredMinorUnitMoney
benchmarkSellingPricerequiredMinorUnitMoney
amazonMarketplacerequiredAmazonMarketplace
suggestedPurchasingCostUpperoptionalMinorUnitMoney | 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.
kindoptionalstring
Range combination: sum of daily values.
values: sum
default: "sum"
TaskExceptionTypevalues · 7
Closed persisted task-failure classifications shared by maintained lines.
values: UNKNOWNPAID_ATTEMPT_UNKNOWNFAILED_TO_STARTNO_SUFFICIENT_DATATIMEOUTINPUT_EXPIREDCANCELLED
TaskStagevalues · 5
values: PENDINGPROCESSINGWAITING_FOR_INPUTSUCCESSFAILURE
TextAlignvalues · 3
Horizontal alignment inside the text box.
values: LEFTCENTERRIGHT
TextClause4
Search one named text field or request broad text discovery.
kindoptionalstring
values: TEXT
default: "TEXT"
fieldoptionalstring | null
valuerequiredstring
opoptionalstring
values: SEARCHPHRASE
default: "SEARCH"
TextField2
Override value: a text layer's text.
fieldoptionalstring
values: TEXT
default: "TEXT"
textrequiredstring
TextFill2
Fill a HEADLINE/BODY_TEXT placeholder.
placeholderrequiredstring
values: bodycallout_1callout_2callout_3headlineproduct_photo
textrequiredstring
TextHunk3
One contiguous text edit with its zero-based old/new origins and line operations.
oldStartrequiredinteger
Zero-based old-file hunk start.
newStartrequiredinteger
Zero-based new-file hunk start.
linesrequiredTextLine[]
Changed and context lines.
TextLayer12
Text wrapped inside its box width (line breaks computed by the one keble-core scene mapper).
layerIdrequiredstring
namerequiredstring
opacityoptionalnumber
default: 1
blendModeoptionalBlendMode
default: "NORMAL"
visibleoptionalboolean
default: true
lockedoptionalboolean
default: false
boxrequiredBox
shadowoptionalDropShadow | null
kindoptionalstring
values: TEXT
default: "TEXT"
textrequiredstring
stylerequiredTextStyle
placeholderoptionalstring | null
TextLayerBinding2
A plan column whose cell text replaces one TEXT layer of the plan's source image.
bindingoptionalstring
values: TEXT_LAYER
default: "TEXT_LAYER"
layerIdrequiredstring
TextLine4
One raw source line with one-based before/after coordinates.
operationrequiredTextLineOperation
Context, inserted or deleted line.
textrequiredstring
Raw text of the line.
oldLineoptionalinteger | null
One-based old-file line number.
newLineoptionalinteger | null
One-based new-file line number.
TextLineOperationvalues · 3
One unchanged, inserted or deleted source line in a text diff.
values: CONTEXTINSERTDELETE
TextStyle7
How a text layer is set; font is a reference (stored as its key).
fontrequiredstring | BrandFontRef
weightoptionalFontWeight
default: "REGULAR"
sizerequirednumber
colorrequiredColor | BrandColorRef
alignoptionalTextAlign
default: "LEFT"
lineHeightoptionalnumber
default: 1.2
letterSpacingoptionalnumber
default: 0
ThemeBlockInstance3
One block inside one Keble section: its stable key, its kind and its setting values.
blockKeyrequiredstring
kindrequiredKebleBlockKind
settingsoptionalobject
ThemeChangeSet6
FROZEN (D-03): removed in the first theme release after SEO and GEO migrate.
changeSetIdrequiredstring
draftrequiredThemeChangeSetDraft
basesoptionalThemeFileBase[]
default: []
previewoptionalThemePreviewCopy | null
proposalsoptionalThemeProposalLink[]
default: []
createdAtrequiredstring
ThemeChangeSetDraft3
FROZEN (D-03): removed in the first theme release after SEO and GEO migrate.
titlerequiredstring
editsrequiredThemeFileEdit[]
newPageoptionalNewThemePage | null
ThemeCreateLedger9
FROZEN (D-03): removed in the first theme release after SEO and GEO migrate.
artifectRefIdrequiredstring
ownerrequiredstring
replayKeyrequiredstring
storeIdrequiredstring
accountrequiredAccountRef
targetThemeIdrequiredstring
changeSetsrequiredThemeChangeSet[]
revisionrequiredinteger
createdAtrequiredstring
ThemeDocument1
The whole Keble document of one run: its pages, each placing Keble sections on one template.
pagesoptionalThemePage[]
default: []
ThemeDocumentCreateRequest6
The document-run create input: store, optional target, title, author and first actions (G-9).
replayKeyrequiredstring
storeIdrequiredstring
targetThemeIdoptionalstring | null
titlerequiredstring
authorrequiredThemeEditAuthor
initialActionsoptionalAddPage[] | AddSection[] | MoveSection[] | RemoveSection[] | SetSettings[] | AddBlock[] | MoveBlock[] | RemoveBlock[] | ShopifyThemeRestoreRevision[]
default: []
ThemeDocumentOperationvalues · 4
The document commands a caller may run next (the guide's vocabulary; the host maps its arms).
values: EDITUPDATE_PREVIEWPUBLISHDISCARD_PREVIEW
ThemeDocumentProposalStateRead4
The live inbox state of one document-run proposal link, read by the theme host on every read.
purposerequiredThemeProposalPurpose
proposalIdrequiredstring
documentRevisionoptionalinteger | null
approvalrequiredApprovalState | null
ThemeDocumentSnapshot6
The owner-fenced document-run snapshot: head, head document, guide, publish summary, link.
runKindoptionalstring
values: DOCUMENT
default: "DOCUMENT"
headrequiredThemeRunHead
documentrequiredThemeDocument
guiderequiredThemeStageGuide
publishSummaryoptionalThemePublishSummary | null
previewLinkoptionalstring | null
ThemeEditAuthorvalues · 2
Who submitted an edit: the chat agent or the person in the editor (revision provenance).
values: AGENTUSER
ThemeEditReceipt2
One recorded edit replay: its key and the revision it committed (ATJ-3).
replayKeyrequiredstring
revisionrequiredinteger
ThemeFileBase3
One theme file's stamped base: its filename and the checksum ELTA's drift law compares.
filenamerequiredstring
checksum_md5requiredstring
bodyoptionalnull
ThemeFileEdit2
FROZEN (D-03): removed in the first theme release after SEO and GEO migrate.
filenamerequiredstring
afterrequiredstring
ThemeFrameSourcevalues · 2
Which theme a page frame renders: the run's preview copy or its target (live vs draft).
values: PREVIEW_COPYTARGET
ThemePage4
One page of the document: the template it places on, its preview path, and its sections.
templaterequiredThemeTemplateRef
previewPathrequiredstring
newPageoptionalNewKeblePage | null
sectionsoptionalThemePlacedSection[]
default: []
ThemePageChange3
One changed page of a publish summary: the page's own change and/or its changed Keble sections.
pagerequiredThemeTemplateRef
changeoptionalThemeSectionChangeKind | null
sectionsoptionalThemeSectionChange[]
default: []
ThemePlacedSection2
One Keble section placed on a page: the section plus its anchor in the template's order.
sectionrequiredThemeSectionInstance
afteroptionalstring | null
ThemePreviewCopy3
FROZEN (D-03): removed in the first theme release after SEO and GEO migrate.
previewThemeIdrequiredstring
previewLinkoptionalstring | null
createdAtrequiredstring
ThemeProposalPurposevalues · 5
Why one ELTA proposal was opened for a change set or a document revision.
values: PREVIEW_COPYPREVIEW_FILESACCEPTREVERTDISCARD
ThemeProposalStateRead4
The live inbox state of one theme proposal link, read by the keble-artifect theme host.
changeSetIdrequiredstring
purposerequiredThemeProposalPurpose
proposalIdrequiredstring
approvalrequiredApprovalState | null
ThemePublishSummary5
What publishing would change, where, and whether the target moved since it was read (D-05).
revisionrequiredinteger
publishedRevisionoptionalinteger | null
targetThemerequiredThemeRef
pagesoptionalThemePageChange[]
default: []
driftoptionalstring[]
default: []
ThemeRef3
One theme as the store reports it now: its GID, display name and role.
theme_idrequiredstring
namerequiredstring
rolerequiredThemeRole
ThemeRevision7
One immutable committed revision of a document run: the document and the actions that made it.
runKindoptionalstring
values: DOCUMENT
default: "DOCUMENT"
artifectRefIdrequiredstring
revisionrequiredinteger
documentrequiredThemeDocument
actionsoptionalAddPage[] | AddSection[] | MoveSection[] | RemoveSection[] | SetSettings[] | AddBlock[] | MoveBlock[] | RemoveBlock[] | ShopifyThemeRestoreRevision[]
default: []
authorrequiredThemeEditAuthor
createdAtrequiredstring
ThemeRolevalues · 6
A Shopify theme's role; only MAIN is the published, write-protected live theme.
values: ARCHIVEDDEMODEVELOPMENTLOCKEDMAINUNPUBLISHED
ThemeRunHead15
The small owner-scoped head row of one document run (IDX-1); revisions live beside it.
runKindoptionalstring
values: DOCUMENT
default: "DOCUMENT"
artifectRefIdrequiredstring
ownerrequiredstring
replayKeyrequiredstring
createRequestHashrequiredstring
storeIdrequiredstring
accountrequiredAccountRef
targetThemeIdrequiredstring
titlerequiredstring
headRevisionrequiredinteger
editReceiptsoptionalThemeEditReceipt[]
default: []
previewoptionalPreviewSession | null
proposalsoptionalThemeDocumentProposalLink[]
default: []
createdAtrequiredstring
updatedAtrequiredstring
ThemeSectionChange3
One changed Keble section in a publish summary; the web names it from its kind's label.
sectionKeyrequiredstring
kindrequiredKebleSectionKind
changerequiredThemeSectionChangeKind
ThemeSectionChangeKindvalues · 3
How one Keble section differs between the published revision and the one being published.
values: NEWEDITEDREMOVED
ThemeSectionInstance4
One Keble section on a page: stable key (also its JSON-template entry id), kind, settings, blocks.
sectionKeyrequiredstring
kindrequiredKebleSectionKind
settingsoptionalobject
blocksoptionalThemeBlockInstance[]
default: []
ThemeStagevalues · 5
Where a document run stands, derived on every read and never stored (E-2).
values: DRAFTPREVIEWINGPREVIEW_READYPUBLISHINGPUBLISHED
ThemeStageGuide4
The stage and the commands allowed in it, computed by the runtime from one rule set (E-2).
stagerequiredThemeStage
allowedoptionalThemeDocumentOperation[]
default: []
undoRevisionoptionalinteger | null
liveIsUndooptionalboolean
default: false
ThemeTemplateEntry4
One entry of a theme's JSON template as the runtime parsed it: id, section type and display name.
entryIdrequiredstring
sectionTyperequiredstring
nameoptionalstring | null
disabledoptionalboolean
default: false
ThemeTemplateOutline4
One template of the copy or the target with its merchant entries in order (this run's own excluded).
templaterequiredThemeTemplateRef
entriesoptionalThemeTemplateEntry[]
default: []
orderoptionalstring[]
default: []
unresolvedSectionKeysoptionalstring[]
default: []
ThemeTemplateRef2
Typed identity of one JSON template: a template type plus an optional alternate suffix.
templateTyperequiredThemeTemplateType
suffixoptionalstring | null
ThemeTemplateTypevalues · 6
The JSON template types a Keble section may be placed on in v1 (templates/<type>[.<suffix>].json).
values: INDEXPRODUCTCOLLECTIONPAGEBLOGARTICLE
TimeAxisvalues · 3
WHICH INSTANT a time window is measured on (K-24, G-09).
values: PUBLISHEDOBSERVEDLAUNCHED
TodoCreate3
Immutable original intent for an ordinary todo.
kindoptionalstring
values: TODO
default: "TODO"
contentrequiredItemContent
keyoptionalstring | null
TodoItem11
Ordinary todo with immutable creation and mutable current content.
idrequiredstring
ownerrequiredOwnerRef
currentrequiredItemContent
created_atrequiredstring
revisionrequiredinteger
created_byoptionalActorRef | null
kindoptionalstring
values: TODO
default: "TODO"
objectoptionalstring
values: todo_item
default: "todo_item"
creationrequiredTodoCreate
statusrequiredTodoStatus
resolved_byoptionalActorRef | null
TodoStatusvalues · 3
An ordinary item remains stored and readable after completion.
values: OPENDONEWITHDRAWN
Tonevalues · 2
The tint of a cell's conclusion.
values: OPPORTUNITYCAUTION
ToneSpec2
One tone the plan uses, defined once and referenced by key (round-3 m2).
toneKeyrequiredstring
descriptionrequiredstring
TopByMetricSuggestion5
An executable alternative over a declared numeric cell field.
kindoptionalstring
Ranked-search suggestion discriminator.
values: TOP_BY_METRIC
default: "TOP_BY_METRIC"
nodeKindrequiredNodeKind
Node family to rank.
channelrequiredChannel
Channel of the ranked nodes.
metricrequiredstring
Declared numeric field code of the selected cell.
values: review_countfollower_countview_count
windowDaysoptionalinteger | 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.
actionKeyrequiredstring
actionTypeKeyrequiredstring
targetrequiredEntityRef
changerequiredJsonValue
baseVersionoptionalstring | null
UngroupLayer3
Dissolve a group, keeping its children in place.
actionoptionalstring
values: UNGROUP_LAYER
default: "UNGROUP_LAYER"
designIdrequiredstring
groupIdrequiredstring
Unitvalues · 3
The physical unit of a measure or metric, so money, counts and ratios stay apart.
values: COUNTMONEYRATIO
UnlinkedMention6
ONE claim of a source item that no held record matched (D-03).
stanceoptionalClaimStance | 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).
mainSubjectoptionalboolean | null
Whether the cited claim names what the source item mainly promotes or is about; null when stance is null.
emotionoptionalClaimEmotion | null
How the source item feels about the named entity in the cited claim, STRONGLY_NEGATIVE to STRONGLY_POSITIVE; null when stance is null.
phraseoptionalstring | 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.
relationrequiredAnalyzedRelationKind
Relation the claim would draw if a record matched it; FEATURES_BRAND today.
labelrequiredstring
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).
layerIdrequiredstring | null
fieldrequiredLayerField
kitIdrequiredstring
entryIdrequiredstring
UpdateItems3
Change items' names, facts or relevance (the SOURCE review's answer, or any later edit).
typeoptionalstring
values: UPDATE_ITEMS
default: "UPDATE_ITEMS"
actionKeyrequiredstring
updatesrequiredItemUpdate[]
ValueStatusvalues · 3
Whether a value exists; missing is never zero (existing ruling).
values: AVAILABLEUNAVAILABLEMIXED_CURRENCY
VariantRecipe5
How a variant differs from its parent; the parts compose (A4: "Heat at 4:5" = color_map + preset).
presetoptionalstring | null
sizeoptionalPixelSize | null
fitoptionalResizeMode
default: "REFLOW"
colorMapoptionalColorRemap[]
default: []
planRowoptionalPlanRowRef | null
VariantSpec5
One variant to create; its recipe composes, and an optional prompt queues one paid scene on it.
objectIdrequiredstring
namerequiredstring
positionoptionalBoardPoint | null
recipeoptionalVariantRecipe
scenePromptoptionalstring | null
ViewDefinition5
One saved display of a positioning: axes, circle size and number, optional criterion.
viewIdrequiredstring
dimensionKeysrequiredstring[]
sizeMeasurerequiredstring
numberMeasurerequiredstring
criterionoptionalstring | null
ViewHandledByvalues · 2
Whose viewport a view row is: a person's, or the agent working for them (existing values).
values: USERAGENT
ViewerRef2
Who is looking: every viewer keeps their own views; the agent never overwrites the person's.
viewerrequiredstring
handledByoptionalViewHandledBy
default: "USER"
Viewport3
One viewer's ordered saved views of one positioning, guarded by a revision.
viewerrequiredViewerRef
definitionsrequiredViewDefinition[]
revisionoptionalinteger
default: 0
VisibleField2
Override value: a layer's visibility.
fieldoptionalstring
values: VISIBLE
default: "VISIBLE"
visiblerequiredboolean
WhiteBackgroundRule1
Every pixel outside the product is pure white RGB 255,255,255 (Amazon main image).
kindoptionalstring
values: WHITE_BACKGROUND
default: "WHITE_BACKGROUND"
WindowCapture3
A dataset re-requested over its recent reporting days on every run.
kindoptionalstring
Capture style: recent reporting-day window.
values: window
default: "window"
lookbackDaysrequiredinteger
Recent reporting days re-read on each sync.
maxWindowDaysrequiredinteger
Maximum reporting days in one capture request.
WritePolicy1
The store's enabled action-family keys; an empty set keeps every write disabled.
enabledoptionalstring[]
Write families enabled for this store.
default: []
WriteRefusal3
One catalog-declared refusal reason: its key, bilingual title and standard meaning (4.0.0).
keyrequiredstring
Refusal key carried by action rows.
titlerequiredStoreLocalizedText
Display name of the reason, in both languages.
meansoptionalstring | null
For a plugin code, the standard target reason it is a case of.
MinorUnitMoney2
Exact monetary value stored as ISO minor units plus its currency.
amountrequiredStdMoneyAmount
currencyrequiredCurrency
DecimalMoney2
An amount with its currency; core never adds two currencies.
amountrequirednumber | string
currencyrequiredstring
ProviderWriteActionType19
One provider write, with optional neutral intent, typed change and undo/drift policy.
keyrequiredstring
Approved-write action identifier.
kindrequiredActionKind
Whether the action sets, adds or removes a target.
levelrequiredstring
Granularity of the write target: a catalog level key.
intentoptionalActionIntent | null
ELTA-owned neutral write meaning; null when the action declares none.
familyKeyrequiredstring
Owner-facing write family controlled by the store policy.
changeSchemarequiredJsonValue
JSON Schema of the requested change.
titlerequiredStoreLocalizedText
Owner-facing name of this write.
fieldTitlesoptionalChangeFieldTitle[]
Human titles of this change's top-level fields.
default: []
requiresoptionalPermission[]
Permissions needed to apply this action.
default: []
createsoptionalstring | null
Entity level created by an addressable ADD action.
createdFromoptionalstring | null
Top-level change field containing an ADD's caller-assigned id.
revertActionKeyoptionalstring | null
Action used to cancel or restore this action.
revertNoteoptionalStoreLocalizedText | null
Provider-specific undo limitation shown before approval (3.5.0: bilingual).
refreshDatasetKeysoptionalstring[]
Datasets ELTA captures after this action applies.
default: []
fidelityrequiredRevertFidelity
Declared completeness of the action's undo.
driftrequiredDriftPolicy
Whether a changed target is refused before apply.
removeScopeoptionalRemoveScope
Targets this REMOVE may delete.
default: "ELTA_CREATED"
revertOnlyoptionalboolean
Whether this action is valid only while reverting another action.
default: false
quotedoptionalboolean
Whether provider estimates are retained on action outcomes.
default: false
PluginDeclarationCatalog4
Every installed plugin's declaration plus the shared vocabulary: GET /v2/catalog.
objectoptionalstring
Document type: catalog.
values: catalog
default: "catalog"
declarationsrequiredPluginDeclaration[]
Declarations of every installed plugin.
levelsoptionalEntityLevel[]
Every level a value may carry, with its title and parent.
default: []
refusalsoptionalWriteRefusal[]
Every refusal an action row may carry, with its title and meaning.
default: []
TemporalFactKindvalues · 3
How one fact family is placed in time.
values: DAILY_TOTALEVENTSNAPSHOT
StoreLocalizedText2
One display text in both product languages, declared once by the owning plugin (2.8.0).
enrequiredstring
English display text.
zhrequiredstring
Simplified Chinese display text.
LocalizedText2
One human label in both product languages.
enrequiredstring
zhrequiredstring
StoreActorKindvalues · 3
Who caused a change (mirror of keble.backend's verified actor kinds).
values: HUMANAGENTSYSTEM
StoreActorRef2
One verified actor: its kind and its stable identity within that kind.
kindrequiredStoreActorKind
Kind of actor that caused the change.
idrequiredstring
Verified actor identity.
ActorKindvalues · 4
Who made an item request or transition.
values: HUMANAGENTSYSTEMAPI_KEY
ActorRef2
The verified person, agent, trusted system, or API-key actor.
kindrequiredActorKind
idrequiredstring
CapabilityCatalog4
The public catalog object.
objectrequiredstring
Public object discriminator.
values: catalog
cellsrequiredCatalogCellView[]
Public capability cells.
edgesrequiredCatalogEdgeView[]
Enabled topology edges a caller may traverse.
motifSectionsrequiredMotifSection[]
Named motif sections available through the Trending route.
ChangeActionTypevalues · 21
Every change a person or agent makes after create, in three families.
values: SET_SETUPADD_ITEMSUPDATE_ITEMSREMOVE_ITEMSSAVE_DIMENSIONDELETE_DIMENSIONSET_PLACEMENTSSAVE_CRITERIONDELETE_CRITERIONSET_RESULTSSAVE_VIEWDELETE_VIEWREORDER_VIEWSCONTINUESET_REVIEWCANCELPROPOSECLASSIFYASSESSSCOREDECIDE
FactValueKindvalues · 8
What kind of value one item fact holds, which fixes what core may compute from it.
values: TEXTCATEGORYNUMBERCOUNTMONEYDATEIMAGEURL
ItemPage4
One ranked pending page and the owner's full matching open count (R7).
objectoptionalstring
values: item_page
default: "item_page"
itemsrequiredTodoItem[] | AlertItem[] | ApprovalItem[] | NotificationItem[]
next_cursoroptionalstring | null
totalrequiredinteger
PositioningItemPage2
One page of items, groups kept together, for the side panel and agents.
itemsrequiredItemRead[]
nextCursoroptionalstring | null
TodoApprovalStatusvalues · 5
A decision remains separate from ordinary todo completion.
values: PENDINGAPPLYINGAPPROVEDREJECTEDWITHDRAWN
ArtifectHostApprovalStatusvalues · 4
Inbox status mapped exhaustively by the backend adapter from its todo enum.
values: PENDINGAPPROVEDREJECTEDEXPIRED
ExportedImage8
One immutable exported image, in board order, with its name, format, findings and AI fact.
positionrequiredinteger
designIdrequiredstring
namerequiredstring
presetrequiredstring
values: 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
formatrequiredRenderFormat
assetrequiredAssetRef
findingsrequiredSlotFinding[]
aiGeneratedoptionalboolean
default: false
PostExportedImage2
One design of one immutable W3.1 export; its HTTPS URL is minted only at Propose.
exportrequiredImageExportRef
altTextoptionalstring
default: ""
ProductOption2
Retain one named dimension/value pair for a Product variant.
namerequiredstring
valuerequiredstring
ShopifyProductOption2
One product option name and its values, e.g. Size: S, M, L.
namerequiredstring
valuesrequiredstring[]
ProductImagesActorKindvalues · 2
Who submitted an edit: the chat agent or the person in the editor (revision provenance).
values: AGENTUSER
ShopifyThemeRestoreRevision2
Make an earlier revision's document the new head (Keep/Undo on a change card; G-12).
actionoptionalstring
values: RESTORE_REVISION
default: "RESTORE_REVISION"
revisionrequiredinteger
RestoreRevision3
Restore an earlier revision: the whole board (version history) or only object_ids (my-own undo, A5).
actionoptionalstring
values: RESTORE_REVISION
default: "RESTORE_REVISION"
revisionrequiredinteger
objectIdsoptionalstring[] | null
PauseReasonvalues · 4
Why sync stopped; D-06.0 and R54 explicitly retain top-up required.
values: OWNER_PAUSEDPLAN_REQUIREDSLOT_LIMITTOP_UP_REQUIRED
MonitorPauseReasonvalues · 3
Why a monitor is paused; every value except OWNER is an auto-pause with a notice.
values: OWNERFAILURESACCESS
MonitorOwnerScope2
The owner one monitor belongs to: a user or an organization (keble-helpers OwnerType).
ownerTyperequiredOwnerType
ownerIdrequiredstring
OwnerScope1
The single owner every positioning read and write is scoped to.
ownerrequiredstring
MonitorAgentBinding2
Which agent narrates: Keble's agent in the chat the monitor was created in, or the owner's own agent.
kindrequiredMonitorAgentKind
conversationIdoptionalstring | null
MonitorAgentKindvalues · 2
Which agent narrates reported cycles, decided by where the monitor was created (W-13).
values: KEBLE_AGENTOWNER_AGENT
MonitorCadenceUnitvalues · 5
Units a cadence counts in; MINUTE stays in the contract while v1's floor is 60 minutes.
values: MINUTEHOURDAYWEEKMONTH
MonitorCapabilityOffer10
One watchable capability as offered to the agent: backend-authored and safe to show.
capabilityKeyrequiredstring
titlerequiredstring
channelLabelrequiredstring
subjectHintrequiredstring
policiesrequiredMonitorFindingPolicy[]
freshnessLabelrequiredstring
fetchesrequiredboolean
minIntervalrequiredstring
readsPerCheckrequiredinteger
marketsoptionalstring[]
default: []
MonitorChangeKindvalues · 3
The discriminator of what a finding reports.
values: NEW_ITEMVALUE_CHANGERANK_MOVE
MonitorChannelDelivery2
Where one channel's delivery of one cycle stands, read from its outbox row (CG-91).
channelrequiredMonitorDeliveryChannel
statusrequiredMonitorDeliveryStatus
MonitorCoverageReasonvalues · 10
The one reason a watch's coverage is PARTIAL or NOT_CHECKED (the digest's "couldn't check X").
values: MORE_MAY_EXISTREFS_PENDINGFETCH_DELAYEDSOURCE_STALEACCESSCREDITDAILY_CAPSUBJECT_UNAVAILABLEREAD_FAILEDMONITOR_INACTIVE
MonitorCycleStatevalues · 7
Where one scheduled check is; QUEUED, FETCHING and PROCESSING are open, the rest terminal.
values: QUEUEDFETCHINGPROCESSINGREPORTEDNO_CHANGEFAILEDSKIPPED
MonitorDeliveryChannelvalues · 3
Where one reported cycle (or an auto-pause notice) is delivered; one delivery row per channel.
values: INBOXCHATEMAIL
MonitorDeliveryStatusvalues · 5
Where one delivery row (one channel of one cycle) is; shown on the cycle row (CG-91).
values: PENDINGDISPATCHINGDELIVEREDUNCERTAINGAVE_UP
MonitorFetchHandle1
Opaque handle of one shared fetch, stored on the watch's cycle while it runs.
fetchKeyrequiredstring
MonitorFindingItem9
One item as a finding shows it: display-safe labels, its public link, and its times (P9).
refrequiredMonitorRecordRef
titlerequiredstring
channelLabelrequiredstring
linkoptionalstring | null
imageoptionalstring | null
publishedAtoptionalstring | null
observedAtrequiredstring
metricsoptionalMonitorItemMetric[]
default: []
rankoptionalinteger | null
MonitorFindingKey5
One finding's identity inside its monitor: cycle, watch, item and what changed.
cycleSeqrequiredinteger
watchKeyrequiredstring
refrequiredMonitorRecordRef
changerequiredMonitorChangeKind
metricKeyoptionalstring | null
MonitorFindingPolicyvalues · 3
How a watch decides what is new; owned by the monitor, not by the data platform.
values: NEW_ITEMSVALUE_CHANGESRANKING
MonitorItemMetric4
One tracked value of an item, with the smallest change worth reporting (backend-authored).
metricKeyrequiredstring
labelrequiredstring
valuerequirednumber | string
minChangerequirednumber | string
MonitorNewItem1
The item was never reported before by this watch.
kindoptionalstring
values: NEW_ITEM
default: "NEW_ITEM"
MonitorRankMove3
An entry entered (was None) or rose in a ranked list.
kindoptionalstring
values: RANK_MOVE
default: "RANK_MOVE"
wasoptionalinteger | null
nowrequiredinteger
MonitorRecordRef2
One record of the shared data, opaque to the core: a subject the agent found, or an item a fetch found.
recordKindrequiredstring
recordKeyrequiredstring
MonitorSetCadence2
Change the schedule; the next due is recomputed, an open cycle keeps its frozen spec.
commandoptionalstring
values: SET_CADENCE
default: "SET_CADENCE"
cadencerequiredMonitorCadence
MonitorSetDelivery2
Change the channel toggles.
commandoptionalstring
values: SET_DELIVERY
default: "SET_DELIVERY"
deliveryrequiredMonitorDelivery
MonitorSetWatches2
Replace the watch list at once: compiles under the spec-revision fence, never re-enters setup (W-18).
commandoptionalstring
values: SET_WATCHES
default: "SET_WATCHES"
watchesrequiredMonitorWatchRequest[]
MonitorValueChange5
A tracked value moved by at least its minimum change since it was last reported (was -> now).
kindoptionalstring
values: VALUE_CHANGE
default: "VALUE_CHANGE"
metricKeyrequiredstring
labelrequiredstring
wasrequirednumber | string
nowrequirednumber | string
MonitorWatchCoveragevalues · 4
What one watch could check this cycle, so "nothing new" is never "could not check".
values: COMPLETEPARTIALNOT_CHECKEDNO_DATA
MonitorWatchCycle12
One watch's progress and result inside one cycle.
watchrequiredMonitorWatch
fetchoptionalMonitorFetchHandle | null
fetchDeadlineAtoptionalstring | null
fetchDelayedoptionalboolean
default: false
fetchReadyoptionalboolean
default: false
foundoptionalMonitorRecordRef[]
default: []
coverageoptionalMonitorWatchCoverage | null
reasonoptionalMonitorCoverageReason | null
findingsoptionalinteger
default: 0
readCallsoptionalinteger
default: 0
windowEndoptionalstring | null
dataAsOfoptionalstring | null
MonitorWatchRequest4
What the agent sends for one watch: a capability, a finding policy and its subjects.
capabilityKeyrequiredstring
policyrequiredMonitorFindingPolicy
subjectsrequiredMonitorRecordRef[] | string[]
marketoptionalstring | null
Error codes
A refused call returns one error body with a code and a message in your language.
CodeMeaningWhat to do
INVALID_API_KEYThe key is unknown or was revoked.Create a new key and replace the old one.
SIGNED_IN_ONLYThis is a web only action; an API key cannot do it.Sign in on the Keble website and do it there.
ACCOUNT_DISABLEDThe account is closed.Contact hi@keble.ai to restore it.
LAST_ORG_OWNERAn organization needs at least one owner.Make another member an owner first.
ORG_DELETE_BLOCKEDThe organization still holds a balance, an active Pro plan or stores, so it can't be deleted yet.Clear each item the error lists (use up the balance, wait for Pro to end, remove the stores), then delete it again.
IDENTITY_VERIFICATION_REQUIREDThe account must verify its identity first.Verify on the Keble website, then retry.
INVALID_REQUESTSome arguments are wrong; the error lists the fields.Fix the listed fields and retry.
NOT_FOUNDThe item does not exist, or your account cannot see it.Check the id, or list the items again to get a current one.
RATE_LIMITEDThe plan's request allowance for this window is used up.Wait for the time in Retry-After, or upgrade.
INSUFFICIENT_BALANCEYour balance does not cover this call.Top up your balance and retry.
FEATURE_UNAVAILABLEThis feature isn't available here yet.Use another capability, or contact support.
STORE_PLAN_REQUIREDThe Free plan cannot sync stores.Upgrade to Pro, or top up your balance.
STORE_SLOT_LIMITYour plan syncs one store at a time, and another store holds the slot.Pause another store, or top up your balance.
STORE_TOP_UP_REQUIREDYour paid balance ran out, so the store is paused.Top up your balance to resume it.
STORE_CHANGE_IN_PROGRESSYour stores are being updated.Try again in a few seconds.
APPROVAL_EXPIREDThe proposed change expired before it was approved.Propose the change again.
UPGRADE_REQUIREDThis needs Pro, Enterprise or a balance.Upgrade or top up on the Keble website.
LEGACY_PLANYour old plan is not supported in this version.Convert your plan on the Keble website.
TRYOUT_LIMIT_REACHEDThe free tryout is used up.Sign in to continue.
FREE_ALLOWANCE_UNAVAILABLEAnother linked account already uses the free request allowance.Upgrade to Pro, or top up your balance.
UPSTREAM_UNAVAILABLEA service Keble needs is temporarily down.Retry in a moment.
UPSTREAM_FAILEDA required service failed temporarily.Try again later.
TIMED_OUTThe call took too long.Retry; ask a narrower question if it repeats.