Imports API

A brief import hands a client's brief to Heimdall and gets back suggestions: the epics, stories, requirements, business rules, use cases, glossary terms, personas, stakeholders, risks, assumptions and decisions a good analyst would draft from it, each with how sure Heimdall was, why, and the passage of the brief it drew on, plus improvements, the gaps and questions a project of this kind leaves open. Nothing is written to the project by the reading. A person decides each suggestion: accept writes the record through its own create action, as proposed or with edits, so its number, validation, first version (reason import, written by Heimdall and accepted by the person) and created event are the ones every other write gets; merge points the suggestion at a record the project already holds; reject drops it. A batch whose every suggestion is decided is marked accepted; a batch a person drops is discarded.

The reading runs on the queue as the person who started it and takes a minute or more: post the brief, poll the batch until its status is ready or failed, then read and decide its suggestions. Tokens read and write imports as staff with the import:* abilities; a client guest's token is refused everywhere here. Starting an import needs the project's AI assists on and room in the team's monthly AI budget, which the reading spends.

EndpointsCopy Anchor Link

Related

Epics API[work items](/api/v1/reference/work-items), [requirements](/api/v1/reference/requirements), [business rules](/api/v1/reference/business-rules), [use cases](/api/v1/reference/use-cases), [glossary](/api/v1/reference/glossary), [personas](/api/v1/reference/personas), [stakeholders](/api/v1/reference/stakeholders), [the RAID log](/api/v1/reference/raid-log) and [decisions](/api/v1/reference/decisions): the records an accepted suggestion becomes.import.* eventsThe life of a brief import: a brief handed to Heimdall, read into suggestions or failed, discarded, and each suggestion accepted, rejected or merged by a person.