Read provisioning results
Inspect the job, generated sets, skipped work, and partial failures.
Read a provisioning job with the ID returned by creation:
GET /v2/provisioning/jobs/:id
X-API-Key: YOUR_API_KEYJob fields #
| Field | Meaning |
|---|---|
id, organizationId, engineId | Job identity and owning organization and engine. |
status | Tagged Running, Completed, or Failed state. Failed includes message. |
kinds | Outcomes for requested glossary, ruleset, and brandVoice work. Unrequested kinds can be absent. |
sources | Optional source-reading progress or report. |
website | First supplied website URL; absent for text-only input. |
createdAt | ISO creation timestamp. |
finishedAt | ISO completion timestamp, present after settlement. |
Per-kind states #
Inspect every requested kind, including when the top-level job is Completed:
kinds.<kind>._tag | Fields and meaning |
|---|---|
Pending | Still working. Optional step is reading, generating, or saving; startedAt identifies when that step began. |
Done | setId identifies the attached set; itemCount is the number of generated items. |
Skipped | reason explains why the kind was left unchanged. |
Failed | message explains why the kind could not be filled. |
For example, this result excerpt contains a generated glossary and a failed ruleset:
{
"glossary": { "_tag": "Done", "setId": "YOUR_GLOSSARY_ID", "itemCount": 12 },
"ruleset": { "_tag": "Failed", "message": "Could not generate rules from the supplied material." }
}Each kind is saved independently. Successful guidance remains available when another kind fails. An engine can also gain an attachment while generation is running, causing an empty-only fill or brand-voice fill to be skipped.
Inspect the generated records #
Open the engine in Studio and follow the attached glossary, ruleset, or brand voice. For API reads, use:
GET /v2/glossaries/:id/termsfor glossary entries.GET /v2/rulesets/:id/rulesfor rules.GET /v2/brand-voices/:id/variationsfor voice variations.
Use the corresponding setId, and follow each list's pagination. Check terminology, applicability by language, non-translatable names, and any assumptions the model added. An item count measures records created, not their correctness.
For a failed kind, use retry and recovery. Preserve completed sets instead of creating a replacement engine to repeat all work.