Skip to main content
POST
Translate every missing value of a field with AI

Authorizations

Authorization
string
header
required

Bearer token authentication. Accepts company-admin tokens with storefront.view for read operations and storefront.update for writes and scan triggers (legacy per-resource grants like categories.update / products.view / etc. are still accepted during the migration), required on every company operation. Storefront public operations under /api/v202604/{resource} and /api/v202604/{resource}/{slug} are unauthenticated (security: []).

Body

application/json

The field and language to fill.

namespace
string
required
Example:

"custom"

key
string
required
Example:

"how_to_use"

lang
string
required

The language ISO to translate into (e.g. es, zh-TW). It must be a language the store sells in and not the store's default language.

Example:

"es"

Response

The run was queued, or one is already queued or running.

metafield_translation_ai_run
object
required
status
integer
required
meta
object
required

Response metadata of the metafield translation operations. request_uuid and timestamp are always present.