Read one content brief
get_content_briefRetrieve a content brief by ID to view its title, H2/H3 outline, notes, FAQs, and phrase coverage; call after create_content_brief until status is ready or error.
Instructions
One content brief in full: the article's title, its H2/H3 outline with the notes and FAQ questions for each section, the fan-out phrases it covers, and the phrases that deserve an article of their own. Call this after create_content_brief until status is ready or error; everything but the prompt is empty while it is processing.
PromptEye generates content as well as measuring visibility, and the two make one loop: track the prompts and how often the assistants name the brand on them, generate an article that targets a prompt where the brand is weak, publish it, then measure whether that prompt's visibility and citations move. Generation starts from a content brief: PromptEye fans the target prompt out into the phrases people ask around it, keeps the ones that belong in this article, sets aside the ones that deserve an article of their own, and writes a title and an H2/H3 outline from them. create_content_brief orders one and get_content_brief reads it. The article itself is written from the brief in the PromptEye app, under Content (https://app.prompteye.com/content), from the brand description, the knowledge documents picked for it and the chosen writing style; saving the live URL, requesting indexing and following citations happen there too, and publishing the page is done on the user's own site. A generated article is a draft to review, and neither it nor its indexing guarantees that an assistant will cite it. Guides: https://app.prompteye.com/help/content/ and https://app.prompteye.com/help/content/article-workflow/.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| briefId | Yes | Id of the brief, as create_content_brief reports it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| error | Yes | Why generation failed. null unless status is error. | |
| title | Yes | Generated article title. null until status is ready. | |
| prompt | Yes | ||
| status | Yes | processing until generated, then ready (title and outline filled in) or error. | |
| outline | Yes | The H2/H3 structure of the article. null until ready. | |
| readyAt | Yes | When it finished, ISO 8601 in UTC. null = not finished yet. | |
| projectId | Yes | ||
| trackerId | Yes | The tracked prompt the brief is linked to. null = requested standalone. | |
| fanoutError | Yes | Set when the fan-out failed but the brief completed with the phrases it had. null otherwise. | |
| requestedAt | Yes | When the brief was requested, ISO 8601 in UTC. | |
| fanoutSource | Yes | Which fan-out engine produced the phrases. null until ready. | |
| originalTitle | Yes | Title of the existing article being optimized. null = no existing article, or not ready yet. | |
| fanoutVariants | Yes | Every phrase the fan-out found. null until ready. | |
| separateArticles | Yes | Phrases that deserve an article of their own. null until ready. | |
| phrasesForArticle | Yes | Phrases that belong in this article and built the outline. null until ready. | |
| titleChangeAnnotation | Yes | Why the title changed. null = kept, no existing article, or not ready yet. | |
| sourceTextMatchPercentage | Yes | How much of the phrase coverage the existing article already had, in whole percent 0-100. null = no existing article, or not ready yet. |