Provision an engine

Fill an engine's glossary, rules, and brand voice from website pages or supplied text.

Provisioning turns source material into translation guidance. Choose the kinds of guidance to generate, supply website links or text, then inspect the resulting glossary, ruleset, and brand voice before using the engine.

You can create an engine and fill it, or fill an existing engine. A provisioning job starts as part of submission; it does not use the localization job's upload/start lifecycle.

Prepare the input #

Use pages or text that explain the product's terminology, writing conventions, and voice. Select glossary, ruleset, brandVoice, or a combination. Each selected kind can have a name for the new set.

The API accepts one to ten sources. The caller needs permission to create or edit the engine and create the selected guidance. Use authentication appropriate to those operations.

Follow the job #

A successful submission returns the job, including id, engineId, status, and kinds. Save both IDs. Poll GET /v2/provisioning/jobs/:id to follow progress and read the final result. Read provisioning results explains when each resource is ready to use.

Inspect each requested kind independently. One kind can succeed while another fails. Successful sets stay attached to the engine, so retry only failed empty kinds after correcting the cause.

Review the guidance #

Use each completed kind's setId to find its records, or open the engine in Studio. Check proposed terms, rules, and voice against the supplied material. Remove incorrect assumptions and resolve conflicting guidance before translating.

Provisioning results explains the returned states. Fill from Your Website describes the same task in the dashboard.